class MFnReflectShader

Jump to documentation

: public MFnLambertShader Manage Reflective Surface Shaders. (OpenMaya) (OpenMaya.py)

Inheritance:

MFnReflectShader < MFnLambertShader < MFnDependencyNode < MFnBase

public members:

MFnReflectShader ()
MFnReflectShader ( MObject & object, MStatus * ReturnStatus = NULL )
virtual ~MFnReflectShader ()
virtual MFn::Type type () const
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 )

Inherited from MFnLambertShader:

public members:

virtual MFn::Type type () const
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 )

Inherited from MFnDependencyNode:

public members:

virtual MFn::Type type () const
enum MAttrClass
kGlobalDynamicAttr
kLocalDynamicAttr
MObject create ( const MTypeId & typeId , MStatus * ReturnStatus = NULL )
MObject create ( const MTypeId & typeId , const MString & name , MStatus * ReturnStatus = NULL )
MObject create ( const MString & type , MStatus * ReturnStatus = NULL )
MObject create ( const MString & type , const MString & name , MStatus * ReturnStatus = NULL )
MTypeId typeId ( MStatus * ReturnStatus = NULL ) const
MString typeName ( MStatus * ReturnStatus = NULL ) const
MString name ( MStatus * ReturnStatus = NULL ) const
MString setName ( const MString & name , MStatus * ReturnStatus = NULL )
MStatus getConnections ( MPlugArray & array ) const
unsigned int attributeCount ( MStatus * ReturnStatus=NULL) const
MObject attribute ( unsigned int index, MStatus * ReturnStatus=NULL) const
MObject reorderedAttribute ( unsigned int index, MStatus * ReturnStatus=NULL) const
MObject attribute ( const MString & attrName, MStatus * ReturnStatus=NULL) const
MAttrClass attributeClass ( const MObject & attr, MStatus * ReturnStatus=NULL) const
MStatus getAffectedAttributes ( const MObject & attr, MObjectArray & affectedAttributes ) const
MStatus getAffectedByAttributes ( const MObject & attr, MObjectArray & affectedByAttributes ) const
MPlug findPlug ( const MObject & attr, bool wantNetworkedPlug, MStatus * ReturnStatus=NULL) const
MPlug findPlug ( const MString & attrName, bool wantNetworkedPlug, MStatus * ReturnStatus=NULL) const
MPlug findPlug ( const MObject & attr, MStatus * ReturnStatus=NULL) const
MPlug findPlug ( const MString & attrName, MStatus * ReturnStatus=NULL) const
MStatus addAttribute ( const MObject & attr, MAttrClass type = kLocalDynamicAttr )
MStatus removeAttribute ( const MObject & attr, MAttrClass type = kLocalDynamicAttr )
MPxNode * userNode ( MStatus * ReturnStatus=NULL ) const
bool isFromReferencedFile ( MStatus * ReturnStatus=NULL) const
bool isShared ( MStatus * ReturnStatus=NULL) const
bool hasUniqueName ( MStatus * ReturnStatus=NULL) const
MString parentNamespace ( MStatus * ReturnStatus=NULL) const
bool isLocked ( MStatus * ReturnStatus=NULL) const
MStatus setLocked ( bool locked )
static MString classification ( const MString & nodeTypeName )
bool isNewAttribute ( const MObject & attr, MStatus * ReturnStatus=NULL) const
static unsigned int allocateFlag ( const MString pluginName, MStatus * ReturnStatus=NULL )
static MStatus deallocateFlag (const MString pluginName, unsigned int flag)
static MStatus deallocateAllFlags (const MString pluginName)
MStatus setFlag (unsigned int flag, bool state)
bool isFlagSet (unsigned int flag, MStatus * ReturnStatus=NULL) const
bool isDefaultNode ( MStatus * ReturnStatus=NULL) const
MStatus setDoNotWrite ( bool flag )
bool canBeWritten ( MStatus * ReturnStatus=NULL) const
bool hasAttribute (const MString & name , MStatus * ReturnStatus=NULL) const
MObject getAliasAttr (bool force, MStatus * ReturnStatus=NULL)
bool setAlias (const MString & alias,const MString & name , const MPlug & plug, bool add=true, MStatus * ReturnStatus=NULL)
bool findAlias (const MString & alias, MObject & attrObj, MStatus * ReturnStatus=NULL) const
bool getAliasList ( MStringArray & strArray, MStatus * ReturnStatus=NULL)
MString plugsAlias (const MPlug & plug, MStatus * ReturnStatus=NULL)
public
bool getPlugsAlias (const MPlug & plug, MString & aliasName, MStatus * ReturnStatus=NULL)

Inherited from MFnBase:

public members:

virtual MFn::Type type () const
bool hasObj ( MFn::Type ) const
bool hasObj ( const MObject & ) const
MObject object ( MStatus * ReturnStatus = NULL ) const
virtual MStatus setObject ( MObject & object )
virtual MStatus setObject ( const MObject & object )

Documentation

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

Functions

MFnReflectShader:: MFnReflectShader ()

Description

Default class constructor. The function set is not attached to an MObject.

MFnReflectShader:: MFnReflectShader ( MObject & object, MStatus * ReturnStatus )

Description

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

Arguments

  • object the MObject to attach the function set to
  • ReturnStatus the return status
    • 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 )

Description

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

Arguments

  • object the const MObject to attach the function set to
  • ReturnStatus the return status
    • 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 ()

Description

The class destructor.

MFn::Type MFnReflectShader:: type () const

Description

Return the type of this function set.

Return Value

  • the constant MFn::kReflect

short MFnReflectShader:: reflectedRayDepthLimit ( MStatus * ReturnStatus ) const

Description

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.

Arguments

  • ReturnStatus return status

Return Value

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

Description

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

Arguments

  • reflected_ray_depth_limit value to which the attribute will be set.

Return Value

  • return status

Status Codes

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

MColor MFnReflectShader:: specularColor ( MStatus * ReturnStatus ) const

Description

Retrieves the value of the "specularColor" attribute of a reflective shader node. This attribute represents the color of specular highlights produced by the shader.

Arguments

  • ReturnStatus return status

Return Value

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

Description

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

Arguments

  • specular_color value to which the attribute will be set.

Return Value

  • return status

Status Codes

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

float MFnReflectShader:: reflectivity ( MStatus * ReturnStatus ) const

Description

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

Arguments

  • ReturnStatus return status

Return Value

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

Description

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

Arguments

  • reflect value to which the attribute will be set.

Return Value

  • return status

Status Codes

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

MColor MFnReflectShader:: reflectedColor ( MStatus * ReturnStatus ) const

Description

Retrieves the value of the "reflectedColor" attribute of a reflective shader node. This attribute represents the color of reflection produced by the shader.

Arguments

  • ReturnStatus return status

Return Value

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

Description

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

Arguments

  • reflected_color value to which the attribute will be set.

Return Value

  • return status

Status Codes

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

Direct child classes:

- MFnPhongShader
- MFnBlinnShader
Autodesk® Maya® 2008 © 1997-2007 Autodesk, Inc. All rights reserved. doc++ Copyright