MFnReflectShader Class Reference
[OpenMaya - API module for common classesFunctionSet classes]

#include <MFnReflectShader.h>

Inheritance diagram for MFnReflectShader:

Inheritance graph
[legend]
Collaboration diagram for MFnReflectShader:

Collaboration graph
[legend]

List of all members.


Detailed Description

Manage Reflective Surface Shaders.

MFnReflectShader allows manipulation of dependency graph nodes representing reflective surface shaders. This includes Phong and Blinn shaders.

Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnReflectShader ()
 Destructor.
 MFnReflectShader ()
 Default constructor.
 MFnReflectShader (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
short reflectedRayDepthLimit (MStatus *ReturnStatus=NULL) const
MStatus setReflectedRayDepthLimit (const short &new_limit)
MColor specularColor (MStatus *ReturnStatus=NULL) const
MStatus setSpecularColor (const MColor &specular_color)
float reflectivity (MStatus *ReturnStatus=NULL) const
MStatus setReflectivity (const float &reflectivity)
MColor reflectedColor (MStatus *ReturnStatus=NULL) const
MStatus setReflectedColor (const MColor &reflected_color)
 MFnReflectShader (const MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.


Constructor & Destructor Documentation

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

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


Member Function Documentation

MFn::Type MFnReflectShader::type (  )  const [virtual]

Function set type.

Return the class type : MFn::kReflect

Reimplemented from MFnLambertShader.

Reimplemented in MFnBlinnShader, and MFnPhongShader.

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

Class name.

Return the class name : "MFnReflectShader"

Reimplemented from MFnLambertShader.

Reimplemented in MFnBlinnShader, and MFnPhongShader.

short MFnReflectShader::reflectedRayDepthLimit ( MStatus ReturnStatus = NULL  )  const

Retrieves the value of the "reflectedRayDepthLimit" attribute of a reflective shader node. This attribute represents the maximum reflected ray depth used in the shading calculation.

Parameters:
[out] ReturnStatus return status
Returns:
The value of the "reflectedRayDepthLimit" attribute of the node.
Status Codes:

MStatus MFnReflectShader::setReflectedRayDepthLimit ( const short &  reflected_ray_depth_limit  ) 

Sets the value of the "reflectedRayDepthLimit" attribute of a lambert shader node.

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

MColor MFnReflectShader::specularColor ( MStatus ReturnStatus = NULL  )  const

Retrieves the value of the "specularColor" attribute of a reflective shader node. This attribute represents the color of specular highlights produced by the shader.

Parameters:
[out] ReturnStatus return status
Returns:
The value of the "specularColor" attribute of the shader node.
Status Codes:

MStatus MFnReflectShader::setSpecularColor ( const MColor specular_color  ) 

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

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

float MFnReflectShader::reflectivity ( MStatus ReturnStatus = NULL  )  const

Retrieves the value of the "reflectivity" attribute of a reflective shader node. This attribute represents the reflectivity of the shader.

Parameters:
[out] ReturnStatus return status
Returns:
The value of the "reflectivity" attribute of the shader node.
Status Codes:

MStatus MFnReflectShader::setReflectivity ( const float &  reflect  ) 

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

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

MColor MFnReflectShader::reflectedColor ( MStatus ReturnStatus = NULL  )  const

Retrieves the value of the "reflectedColor" attribute of a reflective shader node. This attribute represents the color of reflection produced by the shader.

Parameters:
[out] ReturnStatus return status
Returns:
The value of the "reflectedColor" attribute of the shader node.
Status Codes:

MStatus MFnReflectShader::setReflectedColor ( const MColor reflected_color  ) 

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

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


Autodesk® Maya® 2009 © 1997-2008 Autodesk, Inc. All rights reserved. Generated with doxygen 1.5.6