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

#include <MFnReflectShader.h>

Inheritance diagram for MFnReflectShader:

[legend]

Collaboration diagram for MFnReflectShader:

[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:

• 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

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:

• 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 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:

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

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:

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

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:

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

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:

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

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:

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

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:

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

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:

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

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:

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