MFnMatrixAttribute Class Reference
 
 
 

This reference page is linked to from the following overview topics: Deformer Node Example.


#include <MFnMatrixAttribute.h>


Class 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/anisotropicShader.cpp, AshliShader/GLSLShaderNode.cpp, buildRotationNode/buildRotationNode.cpp, cellShader/cellShader.cpp, cgfxAttrDef.cpp, cgfxVector.cpp, flameShader/flameShader.cpp, lavaShader/lavaShader.cpp, noiseShader/noiseShader.cpp, offsetNode/offsetNode.cpp, slopeShader/slopeShaderNode.cpp, and solidCheckerShader/solidCheckerShader.cpp.

Inheritance diagram for MFnMatrixAttribute:
MFnAttribute MFnBase

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] object The MObject to attach the function set to
[out] ReturnStatus the 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] object The MObject to attach the function set to
[out] ReturnStatus the 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] fullName The full name of the attribute
[in] briefName The brief name of the attribute
[in] matrixType Whether to create a matrix of floats or doubles
[out] ReturnStatus Status code for the operation.
Returns:
The newly created Matrix attribute object.
Status Codes:
Examples:
anisotropicShader/anisotropicShader.cpp, AshliShader/GLSLShaderNode.cpp, buildRotationNode/buildRotationNode.cpp, cellShader/cellShader.cpp, cgfxAttrDef.cpp, cgfxVector.cpp, flameShader/flameShader.cpp, lavaShader/lavaShader.cpp, noiseShader/noiseShader.cpp, offsetNode/offsetNode.cpp, slopeShader/slopeShaderNode.cpp, and solidCheckerShader/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] def returns 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] def returns 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] def matrix 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] def matrix value
Returns:
Status flag
Status Codes:

The documentation for this class was generated from the following files: