Public Member Functions | Protected Member Functions

MFnReflectShader Class Reference

Search for all occurrences

Detailed Description

Manage Reflective Surface Shaders.

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

#include <MFnReflectShader.h>

Inheritance diagram for MFnReflectShader:
Inheritance graph
[legend]

List of all members.

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
 Retrieves the value of the "reflectedRayDepthLimit" attribute of a reflective shader node.
MStatus setReflectedRayDepthLimit (const short &new_limit)
 Sets the value of the "reflectedRayDepthLimit" attribute of a lambert shader node.
MColor specularColor (MStatus *ReturnStatus=NULL) const
 Retrieves the value of the "specularColor" attribute of a reflective shader node.
MStatus setSpecularColor (const MColor &specular_color)
 Sets the value of the "specularColor" attribute of a shader node.
float reflectivity (MStatus *ReturnStatus=NULL) const
 Retrieves the value of the "reflectivity" attribute of a reflective shader node.
MStatus setReflectivity (const float &reflectivity)
 Sets the value of the "reflectivity" attribute of a shader node.
MColor reflectedColor (MStatus *ReturnStatus=NULL) const
 Retrieves the value of the "reflectedColor" attribute of a reflective shader node.
MStatus setReflectedColor (const MColor &reflected_color)
 Sets the value of the "reflectedColor" attribute of a shader node.
 MFnReflectShader (const MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.

Constructor & Destructor Documentation

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

Reimplemented from MFnLambertShader.

Reimplemented in MFnBlinnShader, and MFnPhongShader.

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

Class name.

Return the class name : "MFnReflectShader".

Reimplemented from MFnLambertShader.

Reimplemented in MFnBlinnShader, and MFnPhongShader.

short 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]ReturnStatusreturn status
Returns:
The value of the "reflectedRayDepthLimit" attribute of the node.
Status Codes:
MStatus setReflectedRayDepthLimit ( const short &  reflected_ray_depth_limit)

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

Parameters:
[in]reflected_ray_depth_limitvalue to which the attribute will be set.
Returns:
Return status
Status Codes:
MColor 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]ReturnStatusreturn status
Returns:
The value of the "specularColor" attribute of the shader node.
Status Codes:
MStatus setSpecularColor ( const MColor specular_color)

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

Parameters:
[in]specular_colorvalue to which the attribute will be set.
Returns:
Return status
Status Codes:
float 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]ReturnStatusreturn status
Returns:
The value of the "reflectivity" attribute of the shader node.
Status Codes:
MStatus setReflectivity ( const float &  reflect)

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

Parameters:
[in]reflectvalue to which the attribute will be set.
Returns:
Return status
Status Codes:
MColor 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]ReturnStatusreturn status
Returns:
The value of the "reflectedColor" attribute of the shader node.
Status Codes:
MStatus setReflectedColor ( const MColor reflected_color)

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

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

MFnReflectShader MFnReflectShader MFnReflectShader MFnReflectShader MFnReflectShader MFnReflectShader MFnReflectShader MFnReflectShader MFnReflectShader MFnReflectShader
MFnReflectShader MFnReflectShader MFnReflectShader MFnReflectShader MFnReflectShader MFnReflectShader MFnReflectShader MFnReflectShader MFnReflectShader MFnReflectShader