Public Member Functions | Protected Member Functions

MFnNonAmbientLight Class Reference

Search for all occurrences

Detailed Description

Manage Non-ambient Light dependency Nodes.

MFnNonAmbientLight facilitates modification of dependency graph nodes representing non-ambient lights. This includes area lights, linear lights, and non-extended lights.

Examples:

hwAnisotropicShader_NV20.cpp, and hwToonShader_NV20.cpp.

#include <MFnNonAmbientLight.h>

Inheritance diagram for MFnNonAmbientLight:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnNonAmbientLight ()
 Destructor.
 MFnNonAmbientLight ()
 Default constructor.
 MFnNonAmbientLight (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
 MFnNonAmbientLight (const MDagPath &object, MStatus *ret=NULL)
 Constructor.
short decayRate (MStatus *ReturnStatus=NULL) const
 Retrieves the value of the "decayRate" attribute of a non-ambient light node.
MStatus setDecayRate (const short &decay_rate)
 Sets the value of the "decayRate" attribute of a non-ambient light node.
 MFnNonAmbientLight (const MObject &object, MStatus *ret=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.

Constructor & Destructor Documentation

~MFnNonAmbientLight ( ) [virtual]

Destructor.

The class destructor.

MFnNonAmbientLight ( MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

Class constructor that initializes the function set to the given MObject.

Parameters:
[in]objectThe MObject to attach the function set to
[out]ReturnStatusthe return status
Status Codes:
MFnNonAmbientLight ( const MDagPath object,
MStatus ReturnStatus = NULL 
)

Constructor.

Class constructor that initializes the function set to the given constant MDagPath object.

Parameters:
[in]objectThe const MDagPath to attach the function set to
[out]ReturnStatusThe return status
Status Codes:
MFnNonAmbientLight ( const MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

Class constructor that initializes the function set to the given MObject.

Parameters:
[in]objectThe MObject to attach the function set to
[out]ReturnStatusthe return status
Status Codes:

Member Function Documentation

MFn::Type type ( ) const [virtual]

Function set type.

Return the class type : MFn::kNonAmbientLight.

Reimplemented from MFnLight.

Reimplemented in MFnAreaLight, MFnDirectionalLight, MFnNonExtendedLight, MFnPointLight, MFnSpotLight, and MFnVolumeLight.

const char * className ( ) const [protected, virtual]

Class name.

Return the class name : "MFnNonAmbientLight".

Reimplemented from MFnLight.

Reimplemented in MFnAreaLight, MFnDirectionalLight, MFnNonExtendedLight, MFnPointLight, MFnSpotLight, and MFnVolumeLight.

short decayRate ( MStatus ReturnStatus = NULL) const

Retrieves the value of the "decayRate" attribute of a non-ambient light node.

This attribute determines the type of decay for the light.

The decay rate is with respect to the distance between the light and the surface point being shaded. The decay values range from 0 - 3. The light intensity decays according to (I / d ** v), where I is the light intensity, d is the distance between the light and the surface point being shaded, and v is the decay rate value. A decay rate of 0 means there is no decay in intensity, a value of 1 indicates linear decay. A decay rate of 2 is the most physically accurate behaviour.

Parameters:
[out]ReturnStatusreturn status
Returns:
The value of the "decayRate" attribute of the non-ambient light node.
Status Codes:
MStatus setDecayRate ( const short &  decay_rate)

Sets the value of the "decayRate" attribute of a non-ambient light node.

Parameters:
[in]decay_ratevalue to which the attribute will be set.
Returns:
Return status
Status Codes:

MFnNonAmbientLight MFnNonAmbientLight MFnNonAmbientLight MFnNonAmbientLight MFnNonAmbientLight MFnNonAmbientLight MFnNonAmbientLight MFnNonAmbientLight MFnNonAmbientLight MFnNonAmbientLight
MFnNonAmbientLight MFnNonAmbientLight MFnNonAmbientLight MFnNonAmbientLight MFnNonAmbientLight MFnNonAmbientLight MFnNonAmbientLight MFnNonAmbientLight MFnNonAmbientLight MFnNonAmbientLight