Public Member Functions | Protected Member Functions

MFnAnisotropyShader Class Reference

Search for all occurrences

Detailed Description

Manage anisotropic shaders.

MFnAnisotropyShader facilitates creation and manipulation of dependency graph nodes representing anisotropy shaders.

#include <MFnAnisotropyShader.h>

Inheritance diagram for MFnAnisotropyShader:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnAnisotropyShader ()
 Destructor.
 MFnAnisotropyShader ()
 Default constructor.
 MFnAnisotropyShader (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
MObject create (bool UIvisible=true, MStatus *ReturnStatus=NULL)
 Creates a new layered shader dependency graph node and adds it to the dependency graph.
MColor tangentUCamera (MStatus *ReturnStatus=NULL) const
 Retrieves the value of the "color" attribute of a shader node.
MStatus setTangentUCamera (const MColor &tangu_camera)
 Sets the value of the "color" attribute of a shader node.
MColor tangentVCamera (MStatus *ReturnStatus=NULL) const
 Retrieves the value of the "transparency" attribute of a shader node.
MStatus setTangentVCamera (const MColor &tangv_camera)
 Sets the value of the "transparency" attribute of a shader node.
float correlationX (MStatus *ReturnStatus=NULL) const
 Retrieves the value of the "spreadX" attribute of a shader node.
MStatus setCorrelationX (const float &correl_x)
 Sets the value of the "spreadX" attribute of a shader node.
float correlationY (MStatus *ReturnStatus=NULL) const
 Retrieves the value of the "spreadY" attribute of a shader node.
MStatus setCorrelationY (const float &correl_y)
 Sets the value of the "spreadY" attribute of a shader node.
float roughness (MStatus *ReturnStatus=NULL) const
 Retrieves the value of the "roughness" attribute of a shader node.
MStatus setRoughness (const float &roughness)
 Sets the value of the "roughness" attribute of a shader node.
float rotateAngle (MStatus *ReturnStatus=NULL) const
 Retrieves the value of the "angle" attribute of a layered shader node.
MStatus setRotateAngle (const float &rotate_angle)
 Sets the value of the "angle" attribute of a shader node.
float refractiveIndex (MStatus *ReturnStatus=NULL) const
 Retrieves the value of the "fresnelRefractiveIndex" attribute of a layered shader node.
MStatus setRefractiveIndex (const float &refractive_index)
 Sets the value of the "fresnelRefractiveIndex" attribute of a shader node.
bool anisotropicReflectivity (MStatus *ReturnStatus=NULL) const
 Retrieves the value of the "anisotropicReflectivity" attribute of a layered shader node.
MStatus setAnisotropicReflectivity (const bool &anisotropic_reflectivity)
 Sets the value of the "anisotropicReflectivity" attribute of a shader node.
 MFnAnisotropyShader (const MObject &object, MStatus *ReturnStatus=NULL)
 NO SCRIPT SUPPORT.

Protected Member Functions

virtual const char * className () const
 Class name.

Constructor & Destructor Documentation

MFnAnisotropyShader ( 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:
MFnAnisotropyShader ( 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::kAnisotropy.

Reimplemented from MFnDependencyNode.

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

Class name.

Return the class name : "MFnAnisotropyShader".

Reimplemented from MFnDependencyNode.

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

Creates a new layered 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.
MColor tangentUCamera ( 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]ReturnStatusreturn status
Returns:
The value of the "color" attribute of the shader node.
Status Codes:
MStatus setTangentUCamera ( const MColor tangu_camera)

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

Parameters:
[in]tangu_cameravalue to which the attribute will be set.
Returns:
Return status
Status Codes:
MColor tangentVCamera ( 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]ReturnStatusreturn status
Returns:
The value of the "transparency" attribute of the shader node.
Status Codes:
MStatus setTangentVCamera ( const MColor tangv_camera)

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

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

Retrieves the value of the "spreadX" attribute of a shader node.

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

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

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

Retrieves the value of the "spreadY" attribute of a shader node.

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

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

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

Retrieves the value of the "roughness" attribute of a shader node.

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

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

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

Retrieves the value of the "angle" attribute of a layered shader node.

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

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

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

Retrieves the value of the "fresnelRefractiveIndex" attribute of a layered shader node.

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

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

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

Retrieves the value of the "anisotropicReflectivity" attribute of a layered shader node.

Parameters:
[out]ReturnStatusreturn status
Returns:
The value of the "anisotropicReflectivity" attribute of the shader node.
Status Codes:
MStatus setAnisotropicReflectivity ( const bool &  anisotropic_reflectivity)

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

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

MFnAnisotropyShader MFnAnisotropyShader MFnAnisotropyShader MFnAnisotropyShader MFnAnisotropyShader MFnAnisotropyShader MFnAnisotropyShader MFnAnisotropyShader MFnAnisotropyShader MFnAnisotropyShader
MFnAnisotropyShader MFnAnisotropyShader MFnAnisotropyShader MFnAnisotropyShader MFnAnisotropyShader MFnAnisotropyShader MFnAnisotropyShader MFnAnisotropyShader MFnAnisotropyShader MFnAnisotropyShader