Detailed Description

Manage Layered shaders.

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

#include <MFnLayeredShader.h>

Inheritance diagram for MFnLayeredShader:

Public Member Functions
virtual MFn::Type	type () const
	Function set type.
virtual	~MFnLayeredShader ()
	Destructor.
	MFnLayeredShader ()
	Default constructor.
	MFnLayeredShader (MObject &object, MStatus *ReturnStatus=NULL)
	Constructor.
MObject	create (bool UIvisible=true, MStatus *ReturnStatus=NULL)
	Creates a new layered shader dependency graph node and adds it to the dependency graph.
short	compositingFlag (MStatus *ReturnStatus=NULL) const
	Retrieves the value of the "compositingFlag" attribute of a shader node.
MStatus	setCompositingFlag (const short &cflag)
	Sets the value of the "compositingFlag" attribute of a shader node.
MColor	color (unsigned int lIndex=0, MStatus *ReturnStatus=NULL) const
	Retrieves the value of the "color" attribute of a shader node.
MStatus	setColor (const MColor &col, unsigned int lIndex=0)
	Sets the value of the "color" attribute of a shader node.
MColor	transparency (unsigned int lIndex=0, MStatus *ReturnStatus=NULL) const
	Retrieves the value of the "transparency" attribute of a shader node.
MStatus	setTransparency (const MColor &transp, unsigned int lIndex=0)
	Sets the value of the "transparency" attribute of a shader node.
MColor	glowColor (unsigned int lIndex=0, MStatus *ReturnStatus=NULL) const
	Retrieves the value of the "glowColor" attribute of a shader node.
MStatus	setGlowColor (const MColor &glow_color, unsigned int lIndex=0)
	Sets the value of the "glowColor" attribute of a shader node.
MColor	hardwareColor (MStatus *ReturnStatus=NULL) const
	Retrieves the value of the "hardwareColor" attribute of a shader node.
MStatus	setHardwareColor (const MColor &hardware_color)
	Sets the value of the "hardwareColor" attribute of a shader node.
MColor	hardwareShader (MStatus *ReturnStatus=NULL) const
	Retrieves the value of the "hardwareShader" attribute of a layered shader node.
MStatus	setHardwareShader (const MColor &hardware_shader)
	Sets the value of the "hardwareShader" attribute of a shader node.
	MFnLayeredShader (const MObject &object, MStatus *ReturnStatus=NULL)
	Constructor.
Protected Member Functions
virtual const char *	className () const
	Class name.

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]

Search for all occurrences

Function set type.

Return the class type : MFn::kLayeredShader.

Reimplemented from MFnDependencyNode.

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

Search for all occurrences

Class name.

Return the class name : "MFnLayeredShader".

Reimplemented from MFnDependencyNode.

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

Search for all occurrences

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

Search for all occurrences

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 )

Search for all occurrences

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

Search for all occurrences

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`
	)

Search for all occurrences

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

Search for all occurrences

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`
	)

Search for all occurrences

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

Search for all occurrences

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`
	)

Search for all occurrences

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

Search for all occurrences

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 )

Search for all occurrences

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

Search for all occurrences

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 )

Search for all occurrences

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,

MFnLayeredShader Class Reference

OpenMaya - API module for common classes | FunctionSet classes

Detailed Description

Public Member Functions

Protected Member Functions

Constructor & Destructor Documentation

Member Function Documentation