Public Types | Public Member Functions | Protected Member Functions

MFnMatrixAttribute Class Reference

Search for all occurrences

Detailed Description

Matrix attribute function set.

Function object for matrix attributes. These attributes accept either a matrix of float values or double values depending on the type specified to the create method.

Examples:

anisotropicShader.cpp, buildRotationNode.cpp, cellShader.cpp, cgfxAttrDef.cpp, cgfxVector.cpp, flameShader.cpp, GLSLShaderNode.cpp, lavaShader.cpp, noiseShader.cpp, offsetNode.cpp, slopeShaderNode.cpp, and solidCheckerShader.cpp.

#include <MFnMatrixAttribute.h>

Inheritance diagram for MFnMatrixAttribute:
Inheritance graph
[legend]

List of all members.

Public Types

enum  Type { kFloat, kDouble }
 

Matrix data type.

More...

Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnMatrixAttribute ()
 Destructor.
 MFnMatrixAttribute ()
 Default constructor.
 MFnMatrixAttribute (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
MObject create (const MString &fullName, const MString &briefName, Type matrixType=kDouble, MStatus *ReturnStatus=NULL)
 Creates a matrix attribute object.
MStatus getDefault (MMatrix &def)
 Gets the default value for the attribute.
MStatus getDefault (MFloatMatrix &def)
 Gets the default value for the attribute.
MStatus setDefault (const MMatrix &def)
 Sets the default value for the attribute.
MStatus setDefault (const MFloatMatrix &def)
 Sets the default value for the attribute.
 MFnMatrixAttribute (const MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.

Member Enumeration Documentation

enum Type

Matrix data type.

Enumerator:
kFloat 

Matrix of float values.

kDouble 

Matrix of double values.


Constructor & Destructor Documentation

MFnMatrixAttribute ( 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:
MFnMatrixAttribute ( const 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:

Member Function Documentation

MFn::Type type ( ) const [virtual]

Function set type.

Return the class type : MFn::kMatrixAttribute.

Reimplemented from MFnAttribute.

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

Class name.

Return the class name : "MFnMatrixAttribute".

Reimplemented from MFnAttribute.

MObject create ( const MString fullName,
const MString briefName,
Type  matrixType = kDouble,
MStatus ReturnStatus = NULL 
)

Creates a matrix attribute object.

The create method needs to be called on a per node basis. That means if you want to create and add the same attribute to multiple nodes, you need to call the create method for each node to get a unique MObject back. If you call create just once and add the attribute to multiple nodes, Maya will encounter a fatal error.

Parameters:
[in]fullNameThe full name of the attribute
[in]briefNameThe brief name of the attribute
[in]matrixTypeWhether to create a matrix of floats or doubles
[out]ReturnStatusStatus code for the operation.
Returns:
The newly created Matrix attribute object.
Status Codes:
Examples:
anisotropicShader.cpp, buildRotationNode.cpp, cellShader.cpp, cgfxAttrDef.cpp, cgfxVector.cpp, flameShader.cpp, GLSLShaderNode.cpp, lavaShader.cpp, noiseShader.cpp, offsetNode.cpp, slopeShaderNode.cpp, and solidCheckerShader.cpp.
MStatus getDefault ( MMatrix def)

Gets the default value for the attribute.

Use this for getting the default value of a double matrix attribute.

Parameters:
[out]defreturns the default matrix value
Returns:
Status flag
Status Codes:
MStatus getDefault ( MFloatMatrix def)

Gets the default value for the attribute.

Use this for getting the default value of a float matrix attribute.

Parameters:
[out]defreturns the default matrix value
Returns:
Status flag
Status Codes:
MStatus setDefault ( const MMatrix def)

Sets the default value for the attribute.

Use this for setting the defaults of a double matrix attribute.

Parameters:
[in]defmatrix value
Returns:
Status flag
Status Codes:
MStatus setDefault ( const MFloatMatrix def)

Sets the default value for the attribute.

Use this for setting the defaults of a float matrix attribute.

Parameters:
[in]defmatrix value
Returns:
Status flag
Status Codes:

MFnMatrixAttribute MFnMatrixAttribute MFnMatrixAttribute MFnMatrixAttribute MFnMatrixAttribute MFnMatrixAttribute MFnMatrixAttribute MFnMatrixAttribute MFnMatrixAttribute MFnMatrixAttribute
MFnMatrixAttribute MFnMatrixAttribute MFnMatrixAttribute MFnMatrixAttribute MFnMatrixAttribute MFnMatrixAttribute MFnMatrixAttribute MFnMatrixAttribute MFnMatrixAttribute MFnMatrixAttribute