#include <MFnLayeredShader.h>

Class Description

Manage Layered shaders.

MFnLayeredShader facilitates creation and manipulation of dependency graph nodes representing layered shaders.

Inheritance diagram for MFnLayeredShader:

Public Member Functions
virtual MFn::Type	type () const
	Function set type. More...

virtual	~MFnLayeredShader ()
	Destructor.

	MFnLayeredShader ()
	Default constructor.

	MFnLayeredShader (MObject &object, MStatus *ReturnStatus=NULL)
	Constructor. More...

MObject	create (bool UIvisible=true, MStatus *ReturnStatus=NULL)
	Creates a new layered shader dependency graph node and adds it to the dependency graph. More...

short	compositingFlag (MStatus *ReturnStatus=NULL) const
	Retrieves the value of the "compositingFlag" attribute of a shader node. More...

MStatus	setCompositingFlag (const short &cflag)
	Sets the value of the "compositingFlag" attribute of a shader node. More...

MColor	color (unsigned int lIndex=0, MStatus *ReturnStatus=NULL) const
	Retrieves the value of the "color" attribute of a shader node. More...

MStatus	setColor (const MColor &col, unsigned int lIndex=0)
	Sets the value of the "color" attribute of a shader node. More...

MColor	transparency (unsigned int lIndex=0, MStatus *ReturnStatus=NULL) const
	Retrieves the value of the "transparency" attribute of a shader node. More...

MStatus	setTransparency (const MColor &transp, unsigned int lIndex=0)
	Sets the value of the "transparency" attribute of a shader node. More...

MColor	glowColor (unsigned int lIndex=0, MStatus *ReturnStatus=NULL) const
	Retrieves the value of the "glowColor" attribute of a shader node. More...

MStatus	setGlowColor (const MColor &glow_color, unsigned int lIndex=0)
	Sets the value of the "glowColor" attribute of a shader node. More...

MColor	hardwareColor (MStatus *ReturnStatus=NULL) const
	Retrieves the value of the "hardwareColor" attribute of a shader node. More...

MStatus	setHardwareColor (const MColor &hardware_color)
	Sets the value of the "hardwareColor" attribute of a shader node. More...

MColor	hardwareShader (MStatus *ReturnStatus=NULL) const
	Retrieves the value of the "hardwareShader" attribute of a layered shader node. More...

MStatus	setHardwareShader (const MColor &hardware_shader)
	Sets the value of the "hardwareShader" attribute of a shader node. More...

	MFnLayeredShader (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...

MPxNode *	userNode (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::Associations *	metadata (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...

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

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

Constructor & Destructor Documentation

MFnLayeredShader	(	MObject &	object,
		MStatus *	ReturnStatus = `NULL`
	)

Constructor.

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

Parameters

[in]	object	The MObject to attach the function set to
[out]	ReturnStatus	the 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

MFnLayeredShader	(	const MObject &	object,
		MStatus *	ReturnStatus = `NULL`
	)

Constructor.

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

Parameters

[in]	object	The MObject to attach the function set to
[out]	ReturnStatus	the 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::kLayeredShader.

Reimplemented from MFnDependencyNode.

OPENMAYA_MAJOR_NAMESPACE_OPEN const char * className ( ) const

protectedvirtual

Class name.

Return the class name : "MFnLayeredShader".

Reimplemented from MFnDependencyNode.

MObject create	(	bool	UIvisible = `true`,
		MStatus *	ReturnStatus = `NULL`
	)

Creates a new layered shader dependency graph node and adds it to the dependency graph.

If the UIvisible parameter is true, the new node will be connected to the shader classification node (which allows the UI to recognize the node as a shader). If UIvisible is false, the node will be created in isolation.

Parameters

[in]	UIvisible	determines whether or not the new node will be connected to the shader classification node.
[out]	ReturnStatus	return status

Returns: MObject representing the new dependency node.

Status Codes:

MS::kSuccess operation successful
MS::kInsufficientMemory ran out of memory
MS::kNoModelActive no model is currently active
MS::kLicenseFailure application not licensed for attempted operation
MS::kFailure the new node could not be created, or the new node could not be added to the dependency graph, or the new node could not be connected to the classification node.

short compositingFlag ( MStatus * ReturnStatus = NULL ) const

Retrieves the value of the "compositingFlag" attribute of a shader node.

Parameters

[out] ReturnStatus return status

Returns: The value of the "compositingFlag" attribute of the shader node.

Status Codes:

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

MStatus setCompositingFlag ( const short & cflag )

Sets the value of the "compositingFlag" attribute of a shader node.

Parameters

[in] cflag value to which the attribute will be set.

Returns: Return status

Status Codes:

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

MColor color	(	unsigned int	lIndex = `0`,
		MStatus *	ReturnStatus = `NULL`
	)		const

Retrieves the value of the "color" attribute of a shader node.

This attribute represents the surface color of the shader.

Parameters

[in]	lIndex	Index of the shader's entry in the inputs attribute array element.
[out]	ReturnStatus	Status code.

Returns: The value of the "color" attribute of the shader node.

Status Codes:

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

MStatus setColor	(	const MColor &	col,
		unsigned int	lIndex = `0`
	)

Sets the value of the "color" attribute of a shader node.

Parameters

[in]	col	Color.
[in]	lIndex	Index of the shader's entry in the inputs attribute array element.

Returns: Status code.

Status Codes:

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

MColor transparency	(	unsigned int	lIndex = `0`,
		MStatus *	ReturnStatus = `NULL`
	)		const

Retrieves the value of the "transparency" attribute of a shader node.

This attribute represents the surface transparency of the shader.

Parameters

[in]	lIndex	Index of the shader's entry in the inputs attribute array element.
[out]	ReturnStatus	Status code.

Returns: The value of the "transparency" attribute of the shader node.

Status Codes:

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

MStatus setTransparency	(	const MColor &	transp,
		unsigned int	lIndex = `0`
	)

Sets the value of the "transparency" attribute of a shader node.

Parameters

[in]	transp	Value to which the attribute will be set.
[in]	lIndex	Index of the shader's entry in the inputs attribute array element.

Returns: Status code.

Status Codes:

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

MColor glowColor	(	unsigned int	lIndex = `0`,
		MStatus *	ReturnStatus = `NULL`
	)		const

Retrieves the value of the "glowColor" attribute of a shader node.

This attribute represents the ambient color of the shader.

Parameters

[in]	lIndex	Index of the shader's entry in the inputs attribute array element.
[out]	ReturnStatus	Status code.

Returns: The value of the "glowColor" attribute of the shader node.

Status Codes:

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

MStatus setGlowColor	(	const MColor &	glow_color,
		unsigned int	lIndex = `0`
	)

Sets the value of the "glowColor" attribute of a shader node.

Parameters

[in]	glow_color	Color to which the attribute will be set.
[in]	lIndex	Index of the shader's entry in the inputs attribute array element.

Returns: Status code.

Status Codes:

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

MColor hardwareColor ( MStatus * ReturnStatus = NULL ) const

Retrieves the value of the "hardwareColor" attribute of a shader node.

This attribute represents the color of the material that appears in shaded mode.

Parameters

[out] ReturnStatus return status

Returns: The value of the "hardwareColor" attribute of the shader node.

Status Codes:

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

MStatus setHardwareColor ( const MColor & hardware_color )

Sets the value of the "hardwareColor" attribute of a shader node.

Parameters

[in] hardware_color value to which the attribute will be set.

Returns: Return status

Status Codes:

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

MColor hardwareShader ( MStatus * ReturnStatus = NULL ) const

Retrieves the value of the "hardwareShader" attribute of a layered shader node.

Parameters

[out] ReturnStatus return status

Returns: The value of the "hardwareShader" attribute of the shader node.

Status Codes:

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

MStatus setHardwareShader ( const MColor & hardware_shader )

Sets the value of the "hardwareShader" attribute of a shader node.

Parameters

[in] hardware_shader value to which the attribute will be set.

Returns: Return status

Status Codes:

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

The documentation for this class was generated from the following files:

MFnLayeredShader.h
MFnLayeredShader.cpp

MFnLayeredShader Class Reference

Class Description

Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation