class MFnNonExtendedLight

Jump to documentation

: public MFnNonAmbientLight Manage Non-extended Light dependency Nodes. (OpenMaya) (OpenMaya.py)

Inheritance:

MFnNonExtendedLight < MFnNonAmbientLight < MFnLight < MFnDagNode < MFnDependencyNode < MFnBase

public members:

MFnNonExtendedLight ( const MObject & object, MStatus * ReturnStatus = NULL )
float shadowRadius ( MStatus * ReturnStatus = NULL ) const
MStatus setShadowRadius ( const float& shadow_radius )
bool castSoftShadows ( MStatus * ReturnStatus = NULL ) const
MStatus setCastSoftShadows ( const bool& cast_soft_shadows )
bool useDepthMapShadows ( MStatus * ReturnStatus = NULL ) const
MStatus setUseDepthMapShadows ( const bool& use_depth_map )
short depthMapFilterSize ( MStatus * ReturnStatus ) const
MStatus setDepthMapFilterSize ( const short& depth_map_filter_size )
short depthMapResolution ( MStatus * ReturnStatus ) const
MStatus setDepthMapResolution ( const short& depth_map_resolution )
float depthMapBias ( MStatus * ReturnStatus ) const
MStatus setDepthMapBias ( const float& depth_map_bias )

Inherited from MFnNonAmbientLight:

public members:

short decayRate ( MStatus * ReturnStatus = NULL ) const
MStatus setDecayRate ( const short& decay_rate )

Inherited from MFnLight:

public members:

MColor color ( MStatus * ReturnStatus = NULL ) const
MStatus setColor ( const MColor &col )
float intensity ( MStatus * ReturnStatus = NULL ) const
MStatus setIntensity ( const float& intens )
bool useRayTraceShadows ( MStatus * ReturnStatus = NULL ) const
MStatus setUseRayTraceShadows ( const bool& useRayTraceShadows )
MColor shadowColor ( MStatus * ReturnStatus = NULL ) const
MStatus setShadowColor ( const MColor & shadow_color )
double centerOfIllumination ( MStatus * ReturnStatus = NULL ) const
MStatus setCenterOfIllumination ( const double& dist )
short numShadowSamples ( MStatus * ReturnStatus = NULL ) const
MStatus setNumShadowSamples ( const short& num_shadow_samples )
short rayDepthLimit ( MStatus * ReturnStatus = NULL ) const
MStatus setRayDepthLimit ( const short& rayDepthLimit )
MColor opticalFXvisibility ( MStatus * ReturnStatus = NULL ) const
MStatus setOpticalFXvisibility ( const MColor & visibility )
MColor lightIntensity ( MStatus * ReturnStatus = NULL ) const
MFloatVector lightDirection ( int instance, MSpace::Space space = MSpace::kWorld , MStatus * ReturnStatus = NULL ) const
MFloatVector lightDirection ( MStatus * ReturnStatus = NULL ) const
bool lightAmbient ( MStatus * ReturnStatus = NULL ) const
bool lightDiffuse ( MStatus * ReturnStatus = NULL ) const
bool lightSpecular ( MStatus * ReturnStatus = NULL ) const

Inherited from MFnDagNode:

public members:

kNextPos
MObject create ( const MTypeId &typeId, MObject & parent = MObject::kNullObj , MStatus * ReturnStatus = NULL )
MObject create ( const MTypeId &typeId, const MString &name, MObject & parent = MObject::kNullObj , MStatus * ReturnStatus = NULL )
MObject create ( const MString &type, MObject & parent = MObject::kNullObj , MStatus * ReturnStatus = NULL )
MObject create ( const MString &type, const MString &name, MObject & parent = MObject::kNullObj , MStatus * ReturnStatus = NULL )
unsigned int parentCount ( MStatus * ReturnStatus = NULL ) const
MObject parent ( unsigned int i, MStatus * ReturnStatus = NULL ) const
MStatus addChild ( MObject & child , unsigned int index = kNextPos , bool keepExistingParents = false )
MStatus removeChild ( MObject & child )
MStatus removeChildAt ( unsigned int index )
unsigned int childCount ( MStatus * ReturnStatus = NULL ) const
MObject child ( unsigned int i, MStatus * ReturnStatus = NULL ) const
MObject dagRoot ( MStatus * ReturnStatus = NULL )
bool hasParent ( const MObject & node, MStatus * ReturnStatus = NULL ) const
bool hasChild (const MObject & node, MStatus * ReturnStatus = NULL ) const
bool isChildOf (const MObject & node, MStatus * ReturnStatus = NULL ) const
bool isParentOf (const MObject & node, MStatus * ReturnStatus = NULL ) const
bool inUnderWorld ( MStatus * ReturnStatus = NULL ) const
bool inModel ( MStatus * ReturnStatus = NULL ) const
bool isInstanceable ( MStatus * ReturnStatus=NULL ) const
MStatus setInstanceable ( const bool how )
bool isInstanced ( bool indirect = true, MStatus * ReturnStatus = NULL ) const
bool isInstancedAttribute ( const MObject & attr, MStatus * ReturnStatus = NULL ) const
unsigned int instanceCount ( bool total, MStatus * ReturnStatus = NULL ) const
MObject duplicate ( bool instance = false, bool instanceLeaf = false, MStatus * ReturnStatus = NULL ) const
MStatus getPath ( MDagPath & path )
MStatus getAllPaths ( MDagPathArray & paths )
MString fullPathName ( MStatus *ReturnStatus = NULL)
MString partialPathName ( MStatus *ReturnStatus = NULL)
MMatrix transformationMatrix ( MStatus * ReturnStatus = NULL ) const
bool isIntermediateObject ( MStatus * ReturnStatus = NULL ) const
MStatus setIntermediateObject ( bool isIntermediate )
int objectColor ( MStatus * ReturnStatus = NULL ) const
MStatus setObjectColor ( int color )
bool usingObjectColor ( MStatus * ReturnStatus = NULL ) const
MStatus setUseObjectColor ( bool useObjectColor )
MBoundingBox boundingBox ( MStatus * ReturnStatus = NULL ) const
MDagPath dagPath ( MStatus * ReturnStatus = NULL ) const
virtual MStatus setObject ( const MDagPath & path )
virtual MStatus setObject ( MObject & object )
MObject model ( MStatus * ReturnStatus = NULL ) const
virtual MStatus setObject ( const MObject & object )

Inherited from MFnDependencyNode:

public members:

virtual MFn::Type type () const
enum MAttrClass
kGlobalDynamicAttr
kLocalDynamicAttr
MObject create ( const MTypeId & typeId , MStatus * ReturnStatus = NULL )
MObject create ( const MTypeId & typeId , const MString & name , MStatus * ReturnStatus = NULL )
MObject create ( const MString & type , MStatus * ReturnStatus = NULL )
MObject create ( const MString & type , const MString & name , MStatus * ReturnStatus = NULL )
MTypeId typeId ( MStatus * ReturnStatus = NULL ) const
MString typeName ( MStatus * ReturnStatus = NULL ) const
MString name ( MStatus * ReturnStatus = NULL ) const
MString setName ( const MString & name , MStatus * ReturnStatus = NULL )
MStatus getConnections ( MPlugArray & array ) const
unsigned int attributeCount ( MStatus * ReturnStatus=NULL) const
MObject attribute ( unsigned int index, MStatus * ReturnStatus=NULL) const
MObject reorderedAttribute ( unsigned int index, MStatus * ReturnStatus=NULL) const
MObject attribute ( const MString & attrName, MStatus * ReturnStatus=NULL) const
MAttrClass attributeClass ( const MObject & attr, MStatus * ReturnStatus=NULL) const
MStatus getAffectedAttributes ( const MObject & attr, MObjectArray & affectedAttributes ) const
MStatus getAffectedByAttributes ( const MObject & attr, MObjectArray & affectedByAttributes ) const
MPlug findPlug ( const MObject & attr, bool wantNetworkedPlug, MStatus * ReturnStatus=NULL) const
MPlug findPlug ( const MString & attrName, bool wantNetworkedPlug, MStatus * ReturnStatus=NULL) const
MPlug findPlug ( const MObject & attr, MStatus * ReturnStatus=NULL) const
MPlug findPlug ( const MString & attrName, MStatus * ReturnStatus=NULL) const
MStatus addAttribute ( const MObject & attr, MAttrClass type = kLocalDynamicAttr )
MStatus removeAttribute ( const MObject & attr, MAttrClass type = kLocalDynamicAttr )
MPxNode * userNode ( MStatus * ReturnStatus=NULL ) const
bool isFromReferencedFile ( MStatus * ReturnStatus=NULL) const
bool isShared ( MStatus * ReturnStatus=NULL) const
bool hasUniqueName ( MStatus * ReturnStatus=NULL) const
MString parentNamespace ( MStatus * ReturnStatus=NULL) const
bool isLocked ( MStatus * ReturnStatus=NULL) const
MStatus setLocked ( bool locked )
static MString classification ( const MString & nodeTypeName )
bool isNewAttribute ( const MObject & attr, MStatus * ReturnStatus=NULL) const
static unsigned int allocateFlag ( const MString pluginName, MStatus * ReturnStatus=NULL )
static MStatus deallocateFlag (const MString pluginName, unsigned int flag)
static MStatus deallocateAllFlags (const MString pluginName)
MStatus setFlag (unsigned int flag, bool state)
bool isFlagSet (unsigned int flag, MStatus * ReturnStatus=NULL) const
bool isDefaultNode ( MStatus * ReturnStatus=NULL) const
MStatus setDoNotWrite ( bool flag )
bool canBeWritten ( MStatus * ReturnStatus=NULL) const
bool hasAttribute (const MString & name , MStatus * ReturnStatus=NULL) const
MObject getAliasAttr (bool force, MStatus * ReturnStatus=NULL)
bool setAlias (const MString & alias,const MString & name , const MPlug & plug, bool add=true, MStatus * ReturnStatus=NULL)
bool findAlias (const MString & alias, MObject & attrObj, MStatus * ReturnStatus=NULL) const
bool getAliasList ( MStringArray & strArray, MStatus * ReturnStatus=NULL)
MString plugsAlias (const MPlug & plug, MStatus * ReturnStatus=NULL)
public
bool getPlugsAlias (const MPlug & plug, MString & aliasName, MStatus * ReturnStatus=NULL)

Inherited from MFnBase:

public members:

virtual MFn::Type type () const
bool hasObj ( MFn::Type ) const
bool hasObj ( const MObject & ) const
MObject object ( MStatus * ReturnStatus = NULL ) const
virtual MStatus setObject ( MObject & object )
virtual MStatus setObject ( const MObject & object )

Documentation

Facilitate the creation and manipulation of non-extended light nodes.
Description
MFnNonExtendedLight facilitates manipulation of dependency graph nodes representing non-extended lights. This includes point lights, directional lights, and spotlights.

Functions

MFnNonExtendedLight:: MFnNonExtendedLight ()

Description

Default class constructor. The function set is not attached to an MObject.

MFnNonExtendedLight:: MFnNonExtendedLight ( MObject & object, MStatus * ReturnStatus )

Description

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

Arguments

  • object the MObject to attach the function set to
  • ReturnStatus the return status
    • MS::kSuccess if the function set is successfully attached
    • MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject

MFnNonExtendedLight:: MFnNonExtendedLight ( const MObject & object, MStatus * ReturnStatus )

Description

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

Arguments

  • object the const MObject to attach the function set to
  • ReturnStatus the return status
    • MS::kSuccess if the function set is successfully attached
    • MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject

MFnNonExtendedLight:: MFnNonExtendedLight ( const MDagPath & object, MStatus * ReturnStatus )

Description

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

Arguments

  • object the const MDagPath to attach the function set to
  • ReturnStatus the return status
    • MS::kSuccess if the function set is successfully attached
    • MS::kInvalidParameter if the MObject does not represent a valid Maya object or if the function set is not allowed to attach to this MObject

MFn::Type MFnNonExtendedLight:: type () const

Description

Return the type of this function set.

Return Value

  • the constant MFn::kNonExtendedLight

MFnNonExtendedLight:: ~MFnNonExtendedLight ()

Description

The class destructor.

float MFnNonExtendedLight:: shadowRadius ( MStatus * ReturnStatus ) const

Description

Retrieves the value of the "shadowRadius" attribute of a non-extended light node. This attribute represents the radius of the light used when computing soft shadows. Higher radius values result in more extended soft shadows.

Arguments

  • ReturnStatus return status

Return Value

  • The value of the "shadowRadius" attribute of the non-extended light node.

Status Codes

  • MS::kSuccess operation successful
  • MS::kFailure function set does not have a valid object.

MStatus MFnNonExtendedLight:: setShadowRadius ( const float& shadow_radius )

Description

Sets the value of the "shadowRadius" attribute of a non-extended light node.

Arguments

  • shadow_radius value to which the attribute will be set.

Return Value

  • return status

Status Codes

  • MS::kSuccess operation successful
  • MS::kFailure function set does not have a valid object,

bool MFnNonExtendedLight:: castSoftShadows ( MStatus * ReturnStatus ) const

Description

Retrieves the value of the "castSoftShadows" attribute of a non-extended light node. This attribute determines whether or not the light casts soft shadows.

Arguments

  • ReturnStatus return status

Return Value

  • The value of the "castSoftShadows" attribute of the non-extended light node.

Status Codes

  • MS::kSuccess operation successful
  • MS::kFailure function set does not have a valid object.

MStatus MFnNonExtendedLight:: setCastSoftShadows ( const bool& cast_soft_shadows )

Description

Sets the value of the "castSoftShadows" attribute of a non-extended light node.

Arguments

  • cast_soft_shadows value to which the attribute will be set.

Return Value

  • return status

Status Codes

  • MS::kSuccess operation successful
  • MS::kFailure function set does not have a valid object,

bool MFnNonExtendedLight:: useDepthMapShadows ( MStatus * ReturnStatus ) const

Description

Retrieves the value of the "useDepthMapShadows" attribute of a non-extended light node. This attribute determines whether or not a depth map will be used in shadow computations for this light.

Arguments

  • ReturnStatus return status

Return Value

  • The value of the "useDepthMapShadows" attribute of the non-extended light node.

Status Codes

  • MS::kSuccess operation successful
  • MS::kFailure function set does not have a valid object.

MStatus MFnNonExtendedLight:: setUseDepthMapShadows ( const bool& use_depth_map )

Description

Sets the value of the "useDepthMapShadows" attribute of a non-extended light node.

Arguments

  • use_depth_map value to which the attribute will be set.

Return Value

  • return status

Status Codes

  • MS::kSuccess operation successful
  • MS::kFailure function set does not have a valid object,

short MFnNonExtendedLight:: depthMapFilterSize ( MStatus * ReturnStatus ) const

Description

Retrieves the value of the "depthMapFilterSize" attribute of a light node. This attribute determines the size of the filter used in depth map shadow computations for the light.

Arguments

  • ReturnStatus return status

Return Value

  • The value of the "depthMapFilterSize" attribute of the light node.

Status Codes

  • MS::kSuccess operation successful
  • MS::kFailure function set doesn not have a valid object.

MStatus MFnNonExtendedLight:: setDepthMapFilterSize ( const short& depth_map_filter_size )

Description

Sets the value of the "depthMapFilterSize" attribute of a light node.

Arguments

  • depth_map_filter_size value to which the attribute will be set.

Return Value

  • return status

Status Codes

  • MS::kSuccess operation successful
  • MS::kFailure function set doesn not have a valid object,

short MFnNonExtendedLight:: depthMapResolution ( MStatus * ReturnStatus ) const

Description

Retrieves the value of the "depthMapResolution" attribute of a light node. This attribute determines the resolution of the depth map for this light.

Arguments

  • ReturnStatus return status

Return Value

  • The value of the "depthMapResolution" attribute of the light node.

Status Codes

  • MS::kSuccess operation successful
  • MS::kFailure function set doesn not have a valid object.

MStatus MFnNonExtendedLight:: setDepthMapResolution ( const short& depth_map_resolution)

Description

Sets the value of the "depthMapResolution" attribute of a light node.

Arguments

  • depth_map_resolution value to which the attribute will be set.

Return Value

  • return status

Status Codes

  • MS::kSuccess operation successful
  • MS::kFailure function set doesn not have a valid object,

float MFnNonExtendedLight:: depthMapBias ( MStatus * ReturnStatus ) const

Description

Retrieves the value of the "depthMapBias" attribute of a light node. This attribute represents the depth bias applied in depth map shadow computations to prevent self-shadowing artifacts.

Arguments

  • ReturnStatus return status

Return Value

  • The value of the "depthMapBias" attribute of the light node.

Status Codes

  • MS::kSuccess operation successful
  • MS::kFailure function set does not have a valid object.

MStatus MFnNonExtendedLight:: setDepthMapBias ( const float& depth_map_bias )

Description

Sets the value of the "depthMapBias" attribute of a light node.

Arguments

  • depth_map_bias value to which the attribute will be set.

Return Value

  • return status

Status Codes

  • MS::kSuccess operation successful
  • MS::kFailure function set does not have a valid object,

Direct child classes:

- MFnSpotLight
- MFnPointLight
- MFnDirectionalLight
- MFnAreaLight

Autodesk® Maya® 2008 © 1997-2007 Autodesk, Inc. All rights reserved. doc++ Copyright