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:

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]	object	The MObject to attach the function set to
[out]	ReturnStatus	the return status

Status Codes:

• 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

MFnAnisotropyShader	(	const MObject &	object,
		MStatus *	ReturnStatus = NULL
	)

NO SCRIPT SUPPORT.

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

Constructor

Parameters:

[in]	object	The MObject to attach the function set to
[out]	ReturnStatus	the return status

Status Codes:

• 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

---

Member Function Documentation

MFn::Type type

(

)

const [virtual]

Search for all occurrences

Function set type.

Return the class type : MFn::kAnisotropy.

Reimplemented from MFnDependencyNode.

const char * className

(

)

const [protected, virtual]

Search for all occurrences

Class name.

Return the class name : "MFnAnisotropyShader".

Reimplemented from MFnDependencyNode.

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

Search for all occurrences

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]	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.

MColor tangentUCamera

(

MStatus *

ReturnStatus = NULL

)

const

Search for all occurrences

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:

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

MStatus setTangentUCamera

(

const MColor &

tangu_camera

)

Search for all occurrences

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

Parameters:

[in]

tangu_camera

value to which the attribute will be set.

Returns:

Return status

Status Codes:

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

MColor tangentVCamera

(

MStatus *

ReturnStatus = NULL

)

const

Search for all occurrences

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:

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

MStatus setTangentVCamera

(

const MColor &

tangv_camera

)

Search for all occurrences

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

Parameters:

[in]

tangv_camera

value to which the attribute will be set.

Returns:

Return status

Status Codes:

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

float correlationX

(

MStatus *

ReturnStatus = NULL

)

const

Search for all occurrences

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

Parameters:

[out]

ReturnStatus

return status

Returns:

The value of the "spreadX" attribute of the shader node.

Status Codes:

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

MStatus setCorrelationX

(

const float &

correl_x

)

Search for all occurrences

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

Parameters:

[in]

correl_x

value to which the attribute will be set.

Returns:

Return status

Status Codes:

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

float correlationY

(

MStatus *

ReturnStatus = NULL

)

const

Search for all occurrences

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

Parameters:

[out]

ReturnStatus

return status

Returns:

The value of the "spreadY" attribute of the shader node.

Status Codes:

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

MStatus setCorrelationY

(

const float &

correl_y

)

Search for all occurrences

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

Parameters:

[in]

correl_y

value to which the attribute will be set.

Returns:

Return status

Status Codes:

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

float roughness

(

MStatus *

ReturnStatus = NULL

)

const

Search for all occurrences

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

Parameters:

[out]

ReturnStatus

return status

Returns:

The value of the "roughness" attribute of the shader node.

Status Codes:

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

MStatus setRoughness

(

const float &

roughness

)

Search for all occurrences

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

Parameters:

[in]

roughness

value to which the attribute will be set.

Returns:

Return status

Status Codes:

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

float rotateAngle

(

MStatus *

ReturnStatus = NULL

)

const

Search for all occurrences

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

Parameters:

[out]

ReturnStatus

return status

Returns:

The value of the "angle" attribute of the shader node.

Status Codes:

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

MStatus setRotateAngle

(

const float &

rotate_angle

)

Search for all occurrences

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

Parameters:

[in]

rotate_angle

value to which the attribute will be set.

Returns:

Return status

Status Codes:

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

float refractiveIndex

(

MStatus *

ReturnStatus = NULL

)

const

Search for all occurrences

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

Parameters:

[out]

ReturnStatus

return status

Returns:

The value of the "fresnelRefractiveIndex" attribute of the shader node.

Status Codes:

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

MStatus setRefractiveIndex

(

const float &

refractive_index

)

Search for all occurrences

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

Parameters:

[in]

refractive_index

value to which the attribute will be set.

Returns:

Return status

Status Codes:

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

bool anisotropicReflectivity

(

MStatus *

ReturnStatus = NULL

)

const

Search for all occurrences

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

Parameters:

[out]

ReturnStatus

return status

Returns:

The value of the "anisotropicReflectivity" attribute of the shader node.

Status Codes:

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

MStatus setAnisotropicReflectivity

(

const bool &

anisotropic_reflectivity

)

Search for all occurrences

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

Parameters:

[in]

anisotropic_reflectivity

value to which the attribute will be set.

Returns:

Return status

Status Codes:

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