class MFnRenderLayer

Jump to documentation

Inheritance:

MFnRenderLayer < MFnDependencyNode < MFnBase

public members:

	MFnRenderLayer ()
	MFnRenderLayer ( MObject & object, MStatus * ReturnStatus = NULL )
virtual	~MFnRenderLayer ()
virtual MFn::Type	type () const
bool	inLayer ( const MObject &transform, MStatus *ReturnStatus = NULL )
MStatus	layerChildren ( MObjectArray &children, bool recurse = false)
bool	inCurrentRenderLayer ( const MDagPath & objectPath, MStatus *ReturnStatus = NULL )
MStatus	listMembers ( MObjectArray & objectsInLayer ) const
bool	isPlugAdjusted ( const MPlug & scenePlug, MStatus *ReturnStatus = NULL) const
static MObject	findLayerByName ( const MString &renderLayer, MStatus *ReturnStatus = NULL )
static MObject	defaultRenderLayer ( MStatus *ReturnStatus = NULL )
static MStatus	listAllRenderLayers ( MObjectArray &rl )
static MObject	currentLayer ( MStatus *ReturnStatus = NULL )
	MFnRenderLayer ( const MObject & object, MStatus * ReturnStatus = NULL )

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

Provide functionalities for working with render layers.

Description

This class is the function set for Render Layer.

Functions

MFnRenderLayer:: MFnRenderLayer ()

Description

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

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

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

MFnRenderLayer:: ~MFnRenderLayer ()

Description

The class destructor.

MFn::Type MFnRenderLayer:: type () const

Description

Return the type of this function set.

Return Value

• the constant MFn::kRenderLayer

bool MFnRenderLayer:: inLayer ( const MObject &transform, MStatus *ReturnStatus )

Description

Returns ture 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.

Arguments

• transform - MObject of the shape we are testing against.
• status - Return code.

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

MStatus MFnRenderLayer:: layerChildren ( MObjectArray &array, bool recurse )

Description

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

Arguments

• object array List of contained render layers.
• status

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

bool MFnRenderLayer:: inCurrentRenderLayer (const MDagPath & objectPath, MStatus *ReturnStatus)

Description

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

Arguments

• objectPath Path of the render layer object.
• ReturnStatus Status code.

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

MStatus MFnRenderLayer:: listMembers ( MObjectArray & objectsInLayer) const

Description

Returns the objects present in the render layer.

Arguments

• objectsInLayer The array of MObjects, present in the layer.

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

bool MFnRenderLayer:: isPlugAdjusted (const MPlug & scenePlug, MStatus * retStatus) const

Description

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

Arguments

• scenePlug The plug which needs to be checked for adjustment.
• retStatus MStatus object returning the status.

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

MObject MFnRenderLayer:: findLayerByName ( const MString &renderLayer, MStatus *ReturnStatus )

Description

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.

Arguments

• renderLayer The name of the render layer.
• ReturnStatus status of the method call.

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

MObject MFnRenderLayer:: defaultRenderLayer ( MStatus *ReturnStatus )

Description

Returns the MObject for the defaultRenderLayer. This MObject can be used in MFnRenderLayer.

Arguments

• ReturnStatus status of the method call.

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

MStatus MFnRenderLayer:: listAllRenderLayers ( MObjectArray &array )

Description

Returns the list of render layers currently in the system.

Arguments

• array MObjectArray of render layers.

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

MObject MFnRenderLayer:: currentLayer ( MStatus *ReturnStatus )

Description

Returns the MObject for the current render layer. This MObject can be used in MFnRenderLayer.

Arguments

• ReturnStatus status of the method call.

Status Codes

• MS::kSuccess The method was successful.
• MS::kFailure An object error has occurred.

This class has no child classes.