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

#include <MFnLambertShader.h>

Inheritance diagram for MFnLambertShader:

Inheritance graph
[legend]
Collaboration diagram for MFnLambertShader:

Collaboration graph
[legend]

List of all members.


Detailed Description

Manage Lambert shaders.

MFnLambertShader facilitates creation and manipulation of dependency graph nodes representing lambertian shaders.

Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnLambertShader ()
 Destructor.
 MFnLambertShader ()
 Default constructor.
 MFnLambertShader (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
MObject create (bool UIvisible=true, MStatus *ReturnStatus=NULL)
short refractedRayDepthLimit (MStatus *ReturnStatus=NULL) const
MStatus setRefractedRayDepthLimit (const short &new_limit)
float refractiveIndex (MStatus *ReturnStatus=NULL) const
MStatus setRefractiveIndex (const float &refractive_index)
bool rtRefractedColor (MStatus *ReturnStatus=NULL) const
MStatus setRtRefractedColor (const bool &rt_refracted_color)
float diffuseCoeff (MStatus *ReturnStatus=NULL) const
MStatus setDiffuseCoeff (const float &diffuse_coeff)
MColor color (MStatus *ReturnStatus=NULL) const
MStatus setColor (const MColor &col)
MColor transparency (MStatus *ReturnStatus=NULL) const
MStatus setTransparency (const MColor &transp)
MColor ambientColor (MStatus *ReturnStatus=NULL) const
MStatus setAmbientColor (const MColor &ambient_color)
MColor incandescence (MStatus *ReturnStatus=NULL) const
MStatus setIncandescence (const MColor &incand)
float translucenceCoeff (MStatus *ReturnStatus=NULL) const
MStatus setTranslucenceCoeff (const float &translucence_coeff)
float glowIntensity (MStatus *ReturnStatus=NULL) const
MStatus setGlowIntensity (const float &glow_intensity)
bool hideSource (MStatus *ReturnStatus=NULL) const
MStatus setHideSource (const bool &hide_source)
 MFnLambertShader (const MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.


Constructor & Destructor Documentation

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

MFnLambertShader::MFnLambertShader ( 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 MFnLambertShader::type (  )  const [virtual]

Function set type.

Return the class type : MFn::kLambert

Reimplemented from MFnDependencyNode.

Reimplemented in MFnBlinnShader, MFnPhongShader, and MFnReflectShader.

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

Class name.

Return the class name : "MFnLambertShader"

Reimplemented from MFnDependencyNode.

Reimplemented in MFnBlinnShader, MFnPhongShader, and MFnReflectShader.

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

Creates a new lambert 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 in MFnBlinnShader, and MFnPhongShader.

short MFnLambertShader::refractedRayDepthLimit ( MStatus ReturnStatus = NULL  )  const

Retrieves the value of the "refractedRayDepthLimit" attribute of a lambert shader node. This attribute represents the maximum refracted ray depth used in the shading calculation.

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

MStatus MFnLambertShader::setRefractedRayDepthLimit ( const short &  refracted_ray_depth_limit  ) 

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

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

float MFnLambertShader::refractiveIndex ( MStatus ReturnStatus = NULL  )  const

Retrieves the value of the "refractiveIndex" attribute of a lambert shader node. This attribute represents the refractive index of the shader.

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

MStatus MFnLambertShader::setRefractiveIndex ( const float &  refractive_index  ) 

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

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

bool MFnLambertShader::rtRefractedColor ( MStatus ReturnStatus = NULL  )  const

Retrieves the value of the "rtRefractedColor" attribute of a shader node. This attribute determines whether the shader uses the value of the "refractedColor" attribute for the refracted color or calculated the refracted color itself.

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

MStatus MFnLambertShader::setRtRefractedColor ( const bool &  rt_refracted_color  ) 

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

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

float MFnLambertShader::diffuseCoeff ( MStatus ReturnStatus = NULL  )  const

Retrieves the value of the "diffuseCoeff" attribute of a lambert shader node. This attribute represents the diffuse reflectivity of the shader.

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

MStatus MFnLambertShader::setDiffuseCoeff ( const float &  diffuse_coeff  ) 

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

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

MColor MFnLambertShader::color ( MStatus ReturnStatus = NULL  )  const

Retrieves the value of the "color" attribute of a shader node. This attribute represents the surface color of the shader.

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

MStatus MFnLambertShader::setColor ( const MColor col  ) 

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

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

MColor MFnLambertShader::transparency ( MStatus ReturnStatus = NULL  )  const

Retrieves the value of the "transparency" attribute of a shader node. This attribute represents the surface transparency of the shader.

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

MStatus MFnLambertShader::setTransparency ( const MColor transp  ) 

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

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

MColor MFnLambertShader::ambientColor ( MStatus ReturnStatus = NULL  )  const

Retrieves the value of the "ambientColor" attribute of a shader node. This attribute represents the ambient color of the shader.

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

MStatus MFnLambertShader::setAmbientColor ( const MColor ambient_color  ) 

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

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

MColor MFnLambertShader::incandescence ( MStatus ReturnStatus = NULL  )  const

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

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

MStatus MFnLambertShader::setIncandescence ( const MColor incand  ) 

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

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

float MFnLambertShader::translucenceCoeff ( MStatus ReturnStatus = NULL  )  const

Retrieves the value of the "translucenceCoeff" attribute of a lambert shader node. This attribute represents a constant multiplier applied to the transparency attribute of the shader.

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

MStatus MFnLambertShader::setTranslucenceCoeff ( const float &  translucence_coeff  ) 

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

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

float MFnLambertShader::glowIntensity ( MStatus ReturnStatus = NULL  )  const

Retrieves the value of the "glowIntensity" attribute of a shader node. This attribute represents the constant multplier applied to the glow color of the shader.

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

MStatus MFnLambertShader::setGlowIntensity ( const float &  glow_intensity  ) 

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

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

bool MFnLambertShader::hideSource ( MStatus ReturnStatus = NULL  )  const

Retrieves the value of the "hideSource" attribute of a shader node. This attribute determines whether or not the computed surface color is used in the shading computation. If hideSource is true, then only the computed shader glow color will be used. Otherwise, both the glow and surface colors will be used.

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

MStatus MFnLambertShader::setHideSource ( const bool &  hide_source  ) 

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

Parameters:
[in] hide_source 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