Public Member Functions | Protected Member Functions

MFnBlinnShader Class Reference

Search for all occurrences

Detailed Description

Manage Blinn shaders.

MFnBlinnShader facilitates creation and manipulation of dependency graph nodes representing Blinn shaders.

#include <MFnBlinnShader.h>

Inheritance diagram for MFnBlinnShader:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnBlinnShader ()
 Destructor.
 MFnBlinnShader ()
 Default constructor.
 MFnBlinnShader (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
MObject create (bool UIvisible=true, MStatus *ReturnStatus=NULL)
 Creates a new blinn shader dependency graph node and adds it to the dependency graph.
float eccentricity (MStatus *ReturnStatus=NULL) const
 Retrieves the value of the "eccentricity" attribute of a blinn shader node.
MStatus setEccentricity (const float &eccentricity)
 Sets the value of the "eccentricity" attribute of a shader node.
float specularRollOff (MStatus *ReturnStatus=NULL) const
 Retrieves the value of the "specularRollOff" attribute of a blinn shader node.
MStatus setSpecularRollOff (const float &specular_rolloff)
 Sets the value of the "specularRollOff" attribute of a shader node.
 MFnBlinnShader (const MObject &object, MStatus *ReturnStatus=NULL)
 NO SCRIPT SUPPORT.

Protected Member Functions

virtual const char * className () const
 Class name.

Constructor & Destructor Documentation

MFnBlinnShader ( 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:
MFnBlinnShader ( const MObject object,
MStatus ReturnStatus = NULL 
)

NO SCRIPT SUPPORT.

Class constructor that initializes the function set to the given MObject.

Constructor

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::kBlinn.

Reimplemented from MFnReflectShader.

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

Class name.

Return the class name : "MFnBlinnShader".

Reimplemented from MFnReflectShader.

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

Creates a new blinn 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.

Reimplemented from MFnLambertShader.

float eccentricity ( MStatus ReturnStatus = NULL) const

Retrieves the value of the "eccentricity" attribute of a blinn shader node.

This attribute determines the size of the highlight produced by the shader.

Parameters:
[out]ReturnStatusreturn status
Returns:
The value of the "eccentricity" attribute of the shader node.
Status Codes:
MStatus setEccentricity ( const float &  eccentr)

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

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

Retrieves the value of the "specularRollOff" attribute of a blinn shader node.

This attribute controls the increased oblique angle reflectivity of the shader.

Parameters:
[out]ReturnStatusreturn status
Returns:
The value of the "specularRollOff" attribute of the shader node.
Status Codes:
MStatus setSpecularRollOff ( const float &  specular_rolloff)

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

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

MFnBlinnShader MFnBlinnShader MFnBlinnShader MFnBlinnShader MFnBlinnShader MFnBlinnShader MFnBlinnShader MFnBlinnShader MFnBlinnShader MFnBlinnShader
MFnBlinnShader MFnBlinnShader MFnBlinnShader MFnBlinnShader MFnBlinnShader MFnBlinnShader MFnBlinnShader MFnBlinnShader MFnBlinnShader MFnBlinnShader