Public Member Functions | Protected Member Functions

MFnLayeredShader Class Reference

Search for all occurrences

Detailed Description

Manage Layered shaders.

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

#include <MFnLayeredShader.h>

Inheritance diagram for MFnLayeredShader:
Inheritance graph
[legend]

List of all members.

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]objectThe MObject to attach the function set to
[out]ReturnStatusthe return status
Status Codes:
MFnLayeredShader ( 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:

Member Function Documentation

MFn::Type type ( ) const [virtual]

Function set type.

Return the class type : MFn::kLayeredShader.

Reimplemented from MFnDependencyNode.

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

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]UIvisibledetermines whether or not the new node will be connected to the shader classification node.
[out]ReturnStatusreturn 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]ReturnStatusreturn status
Returns:
The value of the "compositingFlag" attribute of the shader node.
Status Codes:
MStatus setCompositingFlag ( const short &  cflag)

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

Parameters:
[in]cflagvalue to which the attribute will be set.
Returns:
Return status
Status Codes:
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]lIndexIndex of the shader's entry in the inputs attribute array element.
[out]ReturnStatusStatus code.
Returns:
The value of the "color" attribute of the shader node.
Status Codes:
MStatus setColor ( const MColor col,
unsigned int  lIndex = 0 
)

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

Parameters:
[in]colColor.
[in]lIndexIndex of the shader's entry in the inputs attribute array element.
Returns:
Status code.
Status Codes:
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]lIndexIndex of the shader's entry in the inputs attribute array element.
[out]ReturnStatusStatus code.
Returns:
The value of the "transparency" attribute of the shader node.
Status Codes:
MStatus setTransparency ( const MColor transp,
unsigned int  lIndex = 0 
)

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

Parameters:
[in]transpValue to which the attribute will be set.
[in]lIndexIndex of the shader's entry in the inputs attribute array element.
Returns:
Status code.
Status Codes:
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]lIndexIndex of the shader's entry in the inputs attribute array element.
[out]ReturnStatusStatus code.
Returns:
The value of the "glowColor" attribute of the shader node.
Status Codes:
MStatus setGlowColor ( const MColor glow_color,
unsigned int  lIndex = 0 
)

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

Parameters:
[in]glow_colorColor to which the attribute will be set.
[in]lIndexIndex of the shader's entry in the inputs attribute array element.
Returns:
Status code.
Status Codes:
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]ReturnStatusreturn status
Returns:
The value of the "hardwareColor" attribute of the shader node.
Status Codes:
MStatus setHardwareColor ( const MColor hardware_color)

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

Parameters:
[in]hardware_colorvalue to which the attribute will be set.
Returns:
Return status
Status Codes:
MColor hardwareShader ( MStatus ReturnStatus = NULL) const

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

Parameters:
[out]ReturnStatusreturn status
Returns:
The value of the "hardwareShader" attribute of the shader node.
Status Codes:
MStatus setHardwareShader ( const MColor hardware_shader)

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

Parameters:
[in]hardware_shadervalue to which the attribute will be set.
Returns:
Return status
Status Codes:

MFnLayeredShader MFnLayeredShader MFnLayeredShader MFnLayeredShader MFnLayeredShader MFnLayeredShader MFnLayeredShader MFnLayeredShader MFnLayeredShader MFnLayeredShader
MFnLayeredShader MFnLayeredShader MFnLayeredShader MFnLayeredShader MFnLayeredShader MFnLayeredShader MFnLayeredShader MFnLayeredShader MFnLayeredShader MFnLayeredShader