MFnRenderLayer Class Reference

#include <MFnRenderLayer.h>

Class Description

Function set for render layer.

Provide functionalities for working with render layers such as getting the objects present in the render layer or checking whether the given object is in the current layer.

+ Inheritance diagram for MFnRenderLayer:

Public Member Functions

virtual MFn::Type type () const
 Function set type. More...
 
virtual ~MFnRenderLayer ()
 Destructor.
 
 MFnRenderLayer ()
 Default constructor.
 
 MFnRenderLayer (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor. More...
 
bool inLayer (const MObject &transform, MStatus *ReturnStatus=NULL)
 Returns true if the given shape is in this layer. More...
 
MStatus layerChildren (MObjectArray &children, bool recurse=false)
 Returns the container layers for this layer. More...
 
bool inCurrentRenderLayer (const MDagPath &objectPath, MStatus *ReturnStatus=NULL)
 The function checks if the given object is present in the current render layer or not. More...
 
MStatus listMembers (MObjectArray &objectsInLayer) const
 Returns the objects present in the render layer. More...
 
bool isPlugAdjusted (const MPlug &scenePlug, MStatus *ReturnStatus=NULL) const
 The function checks if the specified plug is adjusted or not; returns true if the plug is adjusted, else returns false. More...
 
MPlug adjustmentPlug (const MPlug &scenePlug, MStatus *ReturnStatus=NULL) const
 Returns the render layer adjustment value plug for the specified plug. More...
 
MStatus externalRenderPasses (MObjectArray &renderPassArray) const
 The function builds an array of unique render pass nodes (MObject) that are connected to the renderPass attribute. More...
 
bool passHasObject (const MObject &renderPass, const MDagPath &objectPath, MStatus *ReturnStatus=NULL) const
 Returns true if the specified object instance contributes to the given render pass, based on the pass contribution maps attached to the layer. More...
 
bool passHasLight (const MObject &renderPass, const MObject &light, MStatus *ReturnStatus=NULL) const
 Returns true if the specified light contributes to the given render pass, based on the pass contribution maps attached to this layer. More...
 
 MFnRenderLayer (const MObject &object, MStatus *ReturnStatus=NULL)
 Constructor. More...
 
- Public Member Functions inherited from MFnDependencyNode
virtual ~MFnDependencyNode ()
 Destructor.
 
 MFnDependencyNode ()
 Default constructor.
 
 MFnDependencyNode (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor. More...
 
MObject create (const MTypeId &typeId, MStatus *ReturnStatus=NULL)
 Creates a new dependency node with the given type tag. More...
 
MObject create (const MTypeId &typeId, const MString &name, MStatus *ReturnStatus=NULL)
 Creates a new dependency node with the given type tag. More...
 
MObject create (const MString &type, MStatus *ReturnStatus=NULL)
 Creates a new dependency node with the given type. More...
 
MObject create (const MString &type, const MString &name, MStatus *ReturnStatus=NULL)
 Creates a new dependency node with the given type. More...
 
MTypeId typeId (MStatus *ReturnStatus=NULL) const
 Returns the type id of this node. More...
 
MString typeName (MStatus *ReturnStatus=NULL) const
 Returns the type name of this node. More...
 
MString name (MStatus *ReturnStatus=NULL) const
 Returns the name of this node. More...
 
MString absoluteName (MStatus *ReturnStatus=NULL) const
 Returns the absolute name of this node. More...
 
MString pluginName (MStatus *ReturnStatus=NULL) const
 Returns the name of the plug-in this MFnDependendencyNode was defined in. More...
 
MString setName (const MString &name, bool createNamespace=false, MStatus *ReturnStatus=NULL)
 Sets the name of this node. More...
 
MUuid uuid (MStatus *ReturnStatus=NULL) const
 Returns the node's UUID. More...
 
void setUuid (const MUuid &uuid, MStatus *ReturnStatus=NULL)
 Sets the node's UUID. More...
 
MStatus getConnections (MPlugArray &array) const
 Get all of the current connections to this node as an array of plugs. More...
 
unsigned int attributeCount (MStatus *ReturnStatus=NULL) const
 Returns the number of attributes that this node has. More...
 
MObject attribute (unsigned int index, MStatus *ReturnStatus=NULL) const
 Finds the attribute of this node at the given index. More...
 
MObject reorderedAttribute (unsigned int index, MStatus *ReturnStatus=NULL) const
 Some nodes, such as the various animCurve nodes, require that their attributes be set in a specific order for proper operation. More...
 
MObject attribute (const MString &attrName, MStatus *ReturnStatus=NULL) const
 Finds the attribute of this node that has the given name. More...
 
MAttrClass attributeClass (const MObject &attr, MStatus *ReturnStatus=NULL) const
 Returns the class (normal, dynamic, extension) of the specified attribute. More...
 
MStatus getAffectedAttributes (const MObject &attr, MObjectArray &affectedAttributes) const
 Returns an array of attributes that are affected by the attribute passed in. More...
 
MStatus getAffectedByAttributes (const MObject &attr, MObjectArray &affectedByAttributes) const
 Returns an array of attributes that affect the attribute passed in, attr. More...
 
MPlug findPlug (const MObject &attr, bool wantNetworkedPlug, MStatus *ReturnStatus=NULL) const
 Attempt to find a plug for the given attribute. More...
 
MPlug findPlug (const MString &attrName, bool wantNetworkedPlug, MStatus *ReturnStatus=NULL) const
 Attempt to find a plug for the given attribute. More...
 
MPlug findPlug (const MObject &attr, MStatus *ReturnStatus=NULL) const
 This method is obsolete. More...
 
MPlug findPlug (const MString &attrName, MStatus *ReturnStatus=NULL) const
 This method is obsolete. More...
 
MStatus addAttribute (const MObject &attr)
 Add a new dynamic attibute to this node. More...
 
MStatus removeAttribute (const MObject &attr)
 Remove a dynamic attribute from a node. More...
 
MPxNodeuserNode (MStatus *ReturnStatus=NULL) const
 If the function set's node is a plug-in node, then this method will extract the MPxNode pointer from it. More...
 
bool isFromReferencedFile (MStatus *ReturnStatus=NULL) const
 Indicates whether or not this node came from a referenced file. More...
 
bool isShared (MStatus *ReturnStatus=NULL) const
 Indicates whether or not this node is shared. More...
 
bool isTrackingEdits (MStatus *ReturnStatus=NULL) const
 Returns whether or not edits on the given node are being tracked by the generalized edit system. More...
 
bool hasUniqueName (MStatus *ReturnStatus=NULL) const
 Indicates whether or not this node's name is unique within the scene. More...
 
MString parentNamespace (MStatus *ReturnStatus=NULL) const
 Returns the name of the namespace in which this node resides. More...
 
bool isLocked (MStatus *ReturnStatus=NULL) const
 Indicates whether or not this node is locked. More...
 
MStatus setLocked (bool locked)
 Locks or unlocks this node. More...
 
bool isNewAttribute (const MObject &attr, MStatus *ReturnStatus=NULL) const
 Indicates whether or not the specified attribute was added to this node within the current scene. More...
 
MStatus setFlag (unsigned int flag, bool state)
 Sets the state of the specified flag for the node. More...
 
bool isFlagSet (unsigned int flag, MStatus *ReturnStatus=NULL) const
 Retrieves the current state of the specified flag for a node. More...
 
bool isDefaultNode (MStatus *ReturnStatus=NULL) const
 Returns true if the node is a default node. More...
 
MStatus setDoNotWrite (bool flag)
 Use this method to mark the "do not write" state of this node. More...
 
bool canBeWritten (MStatus *ReturnStatus=NULL) const
 Returns the do not write state of the node. More...
 
bool hasAttribute (const MString &name, MStatus *ReturnStatus=NULL) const
 Returns true if the node already has an attribute with the given name. More...
 
MObject getAliasAttr (bool force, MStatus *ReturnStatus=NULL)
 Returns the node's alias attribute, which is a special attribute used to store information about the node's attribute aliases. More...
 
bool setAlias (const MString &alias, const MString &name, const MPlug &plug, bool add=true, MStatus *ReturnStatus=NULL)
 Sets or removes an alias (i.e. More...
 
bool findAlias (const MString &alias, MObject &attrObj, MStatus *ReturnStatus=NULL) const
 Retrieves the attribute with the given alias. More...
 
bool getAliasList (MStringArray &strArray, MStatus *ReturnStatus=NULL)
 Returns a list of all attribute aliases for this node. More...
 
MString plugsAlias (const MPlug &plug, MStatus *ReturnStatus=NULL)
 Returns the alias for the plug's attribute or the empty string if that attribute has no alias. More...
 
MStatus setIcon (const MString &filename)
 Associates a custom icon with the node for display in the Maya UI. More...
 
MString icon (MStatus *ReturnStatus=NULL) const
 Returns the custom icon filename associated with the node. More...
 
MStatus getExternalContent (MExternalContentInfoTable &table) const
 Returns the external content (files) that this node depends on. More...
 
MStatus addExternalContentForFileAttr (MExternalContentInfoTable &table, const MObject &attr) const
 Adds content info to the specified table from a file path attribute. More...
 
MStatus setExternalContentForFileAttr (const MObject &attr, const MExternalContentLocationTable &table)
 Sets content info in the specified attribute from the table. More...
 
MStatus setExternalContent (const MExternalContentLocationTable &table)
 Changes the location of external content. More...
 
MString setName (const MString &name, MStatus *ReturnStatus)
 OBSOLETE FUNCTION, NO SCRIPT SUPPORT. More...
 
 MFnDependencyNode (const MObject &object, MStatus *ReturnStatus=NULL)
 NO SCRIPT SUPPORT. More...
 
bool getPlugsAlias (const MPlug &plug, MString &aliasName, MStatus *ReturnStatus=NULL)
 NO SCRIPT SUPPORT. More...
 
virtual const adsk::Data::Associationsmetadata (MStatus *ReturnStatus=NULL) const
 This method is not available in Python. More...
 
virtual MStatus setMetadata (const adsk::Data::Associations &)
 This method is not available in Python. More...
 
virtual MStatus deleteMetadata ()
 This method is not available in Python. More...
 
virtual MStatus validateMetadata (MString &errors) const
 This method is not available in Python. More...
 
MStatus dgTimerOn ()
 Indicates that this node should collect DG timing data whenever DG timing is enabled. More...
 
MStatus dgTimerOff ()
 Indicates that this node should no longer collect DG timing data when DG timing is enabled. More...
 
MdgTimerState dgTimerQueryState (MStatus *ReturnStatus=NULL)
 The function returns the current on/off state of the node's timer. More...
 
MStatus dgTimerReset ()
 The function resets the dependency graph timers and counters for this node to zero. More...
 
double dgTimer (const MdgTimerMetric timerMetric, const MdgTimerType timerType, MStatus *ReturnStatus=NULL) const
 The function returns the specified timer value for the current node. More...
 
MStatus dgCallbacks (const MdgTimerType type, MStringArray &callbackName, MDoubleArray &value)
 Node callbacks that occur when timing is enabled get logged with the node and can be queried via this method. More...
 
MStatus dgCallbackIds (const MdgTimerType type, const MString &callbackName, MCallbackIdArray &callbackId, MDoubleArray &value)
 This method provides a further breakdown of the per-callback time returned via dgCallbacks() by returning the data on a per-callbackId basis. More...
 
MStatus addAttribute (const MObject &attr, MAttrClass type)
 This method is obsolete. More...
 
MStatus removeAttribute (const MObject &attr, MAttrClass type)
 This method is obsolete. More...
 
- Public Member Functions inherited from MFnBase
virtual ~MFnBase ()
 Class Destructor. More...
 
bool hasObj (MFn::Type) const
 Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system. More...
 
bool hasObj (const MObject &) const
 Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system. More...
 
MObject object (MStatus *ReturnStatus=NULL) const
 Returns the MObject that is attached to the Function Set. More...
 
virtual MStatus setObject (MObject &object)
 Attaches the Function Set to the specified Maya Object. More...
 
virtual MStatus setObject (const MObject &object)
 NO SCRIPT SUPPORT. More...
 

Static Public Member Functions

static MObject findLayerByName (const MString &renderLayer, MStatus *ReturnStatus=NULL)
 This function returns an MObject to a render layer that matches the specified name. More...
 
static MObject defaultRenderLayer (MStatus *ReturnStatus=NULL)
 Returns the MObject for the defaultRenderLayer. More...
 
static MStatus listAllRenderLayers (MObjectArray &rl)
 Returns the list of render layers currently in the system. More...
 
static MObject currentLayer (MStatus *ReturnStatus=NULL)
 Returns the MObject for the current render layer. More...
 
- Static Public Member Functions inherited from MFnDependencyNode
static MString classification (const MString &nodeTypeName)
 Retrieves the classification string for a node type. More...
 
static unsigned int allocateFlag (const MString pluginName, MStatus *ReturnStatus=NULL)
 Allocates a node flag for sole use by the caller. More...
 
static MStatus deallocateFlag (const MString pluginName, unsigned int flag)
 Deallocates a node flag which was previously allocated by a call to allocateFlag. More...
 
static MStatus deallocateAllFlags (const MString pluginName)
 Deallocates all of the node flags which are currently allocated to the specified plugin. More...
 
static void enableDGTiming (bool enable)
 Globally enables or disables the DG node timing mechanism. More...
 
- Static Public Member Functions inherited from MFnBase
static const char * className ()
 Returns the name of this class. More...
 

Protected Member Functions

virtual const char * className () const
 Class name. More...
 

Additional Inherited Members

- Public Types inherited from MFnDependencyNode
enum  MAttrClass { kLocalDynamicAttr = 1, kNormalAttr, kExtensionAttr, kInvalidAttr }
 Specifies the scope of the attribute. More...
 
enum  MdgTimerState { kTimerOff, kTimerOn, kTimerUninitialized, kTimerInvalidState }
 Possible states for the node's timer. More...
 
enum  MdgTimerMetric {
  kTimerMetric_callback, kTimerMetric_compute, kTimerMetric_dirty, kTimerMetric_draw,
  kTimerMetric_fetch, kTimerMetric_callbackViaAPI, kTimerMetric_callbackNotViaAPI, kTimerMetric_computeDuringCallback,
  kTimerMetric_computeNotDuringCallback, kTimerMetrics
}
 The different timer metrics which can be queried. More...
 
enum  MdgTimerType { kTimerType_self, kTimerType_inclusive, kTimerType_count, kTimerTypes }
 The types of timers which can be queried. More...
 

Constructor & Destructor Documentation

MFnRenderLayer ( 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:
  • 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
MFnRenderLayer ( 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:
  • 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

Member Function Documentation

MFn::Type type ( ) const
virtual

Function set type.

Return the class type : MFn::kRenderLayer.

Reimplemented from MFnDependencyNode.

OPENMAYA_MAJOR_NAMESPACE_OPEN const char * className ( ) const
protectedvirtual

Class name.

Return the class name : "MFnRenderLayer".

Reimplemented from MFnDependencyNode.

bool inLayer ( const MObject transform,
MStatus ReturnStatus = NULL 
)

Returns true if the given shape is in this layer.

This method will check all container layers for transform containment. The MObject specified must be a shape node.

Parameters
[in]transformMObject of the shape we are testing against.
[out]ReturnStatusReturn code.
Returns
True if the given node is in the layer, false otherwise.
Status Codes:
  • MS::kSuccess The method was successful.
  • MS::kFailure An object error has occurred.
MStatus layerChildren ( MObjectArray array,
bool  recurse = false 
)

Returns the container layers for this layer.

Container layers provide the ability for a given render layer to "contain" other render layers.

Parameters
[in]arrayList of contained render layers.
[in]recurseIf true then the list operation will be applied recursively to any contained render layers which themselves contain other render layers.
Returns
Status code
Status Codes:
  • MS::kSuccess The method was successful.
  • MS::kFailure An object error has occurred.
bool inCurrentRenderLayer ( const MDagPath objectPath,
MStatus ReturnStatus = NULL 
)

The function checks if the given object is present in the current render layer or not.

Parameters
[in]objectPathPath of the render layer object.
[out]ReturnStatusStatus code.
Returns
True if the given object is in the current render layer, false otherwise.
Status Codes:
  • MS::kSuccess The method was successful.
  • MS::kFailure An object error has occurred.
MStatus listMembers ( MObjectArray objectsInLayer) const

Returns the objects present in the render layer.

Parameters
[in]objectsInLayerThe array of MObjects, present in the layer.
Returns
Status code
Status Codes:
  • MS::kSuccess The method was successful.
  • MS::kFailure An object error has occurred.
bool isPlugAdjusted ( const MPlug scenePlug,
MStatus retStatus = NULL 
) const

The function checks if the specified plug is adjusted or not; returns true if the plug is adjusted, else returns false.

Parameters
[in]scenePlugThe plug which needs to be checked for adjustment.
[out]retStatusMStatus object returning the status.
Returns
True if the plug is adjusted, false otherwise.
Status Codes:
  • MS::kSuccess The method was successful.
  • MS::kFailure An object error has occurred.
MPlug adjustmentPlug ( const MPlug scenePlug,
MStatus retStatus = NULL 
) const

Returns the render layer adjustment value plug for the specified plug.

If there is no layer override on the plug, a copy of scenePlug is returned.

Parameters
[in]scenePlugThe plug for which the adjustment is sought.
[out]retStatusMStatus object returning the status.
Returns
The render layer adjustment plug.
Status Codes:
  • MS::kSuccess The method was successful.
  • MS::kFailure An object error has occurred.
MStatus externalRenderPasses ( MObjectArray renderPassArray) const

The function builds an array of unique render pass nodes (MObject) that are connected to the renderPass attribute.

This function descends recursively into render pass sets to collect all connected render passes.

Parameters
[out]renderPassArrayArray to which the result of the search is written.
Returns
Status code
Status Codes:
  • MS::kSuccess The method was successful.
  • MS::kFailure An object error has occurred.
bool passHasObject ( const MObject renderPass,
const MDagPath objectInstance,
MStatus ReturnStatus = NULL 
) const

Returns true if the specified object instance contributes to the given render pass, based on the pass contribution maps attached to the layer.

This method does not verify whether the object instance or the renderPass are actually rendered by the layer.

Parameters
[in]renderPassa render pass node
[in]objectInstanceDAG path of a shape instance
[out]ReturnStatusstatus of the method call.
Returns
True if the object contributes to the pass, false otherwise.
Status Codes:
  • MS::kSuccess The method was successful.
  • MS::kFailure An object error has occurred.
bool passHasLight ( const MObject renderPass,
const MObject light,
MStatus ReturnStatus = NULL 
) const

Returns true if the specified light contributes to the given render pass, based on the pass contribution maps attached to this layer.

This method does not verify whether the light or the renderPass are actually rendered by the layer.

Parameters
[in]renderPassa render pass node
[in]lighta light shape node
[out]ReturnStatusstatus of the method call.
Returns
True if the light contributes to the pass, false otherwise.
Status Codes:
  • MS::kSuccess The method was successful.
  • MS::kFailure An object error has occurred.
MObject findLayerByName ( const MString renderLayer,
MStatus ReturnStatus = NULL 
)
static

This function returns an MObject to a render layer that matches the specified name.

If no render layer is found with the given name, MObject::kNullObj is returned.

Parameters
[in]renderLayerThe name of the render layer.
[out]ReturnStatusstatus of the method call.
Returns
The matching render layer or MObject::kNullObj if no matching render layer was found.
Status Codes:
  • MS::kSuccess The method was successful.
  • MS::kFailure An object error has occurred.
MObject defaultRenderLayer ( MStatus ReturnStatus = NULL)
static

Returns the MObject for the defaultRenderLayer.

This MObject can be used in MFnRenderLayer.

Parameters
[out]ReturnStatusstatus of the method call.
Returns
The default render layer.
Status Codes:
  • MS::kSuccess The method was successful.
  • MS::kFailure An object error has occurred.
MStatus listAllRenderLayers ( MObjectArray array)
static

Returns the list of render layers currently in the system.

Parameters
[in]arrayMObjectArray of render layers.
Returns
Status code
Status Codes:
  • MS::kSuccess The method was successful.
  • MS::kFailure An object error has occurred.
MObject currentLayer ( MStatus ReturnStatus = NULL)
static

Returns the MObject for the current render layer.

This MObject can be used in MFnRenderLayer.

Parameters
[out]ReturnStatusstatus of the method call.
Returns
The current render layer.
Status Codes:
  • MS::kSuccess The method was successful.
  • MS::kFailure An object error has occurred.

The documentation for this class was generated from the following files:
  • MFnRenderLayer.h
  • MFnRenderLayer.cpp