#include
<MFnPhongShader.h>
List of all
members.
Detailed Description
Manage Phong Shaders.
MFnPhongShader facilitates the creation
and manipulation of dependency graph nodes representing Phong
shaders.
Constructor & Destructor Documentation
MFnPhongShader::MFnPhongShader |
( |
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:
-
MFnPhongShader::MFnPhongShader |
( |
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
MFnPhongShader::type |
( |
|
) |
const [virtual] |
const char * MFnPhongShader::className |
( |
|
) |
const [protected, virtual] |
Class name.
Return the class name : "MFnPhongShader"
Reimplemented from MFnReflectShader.
MObject MFnPhongShader::create |
( |
bool |
UIvisible = true , |
|
|
MStatus * |
ReturnStatus =
NULL |
|
|
) |
|
|
|
Creates a new phong 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] |
UIvisible |
determines whether or not the new node will be connected to the
shader classification node. |
[out] |
ReturnStatus |
return 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 MFnPhongShader::cosPower |
( |
MStatus * |
ReturnStatus =
NULL |
) |
const |
Retrieves the value of the "cosPower" attribute of a phong
shader node. This attribute determines the size of specular
highlights produced by the shader.
- Parameters:
-
[out] |
ReturnStatus |
return status |
- Returns:
- The value of the "cosPower" attribute of the shader node.
- Status Codes:
-
MStatus MFnPhongShader::setCosPower |
( |
const float & |
cos_power |
) |
|
Sets the value of the "cosPower" attribute of a shader node.
- Parameters:
-
[in] |
cos_power |
value to which the attribute will be set. |
- Returns:
- Return status
- Status Codes:
-