MFnMatrixData Class Reference
[OpenMaya - API module for common classesFunctionSet classes]

#include <MFnMatrixData.h>

Inheritance diagram for MFnMatrixData:

Inheritance graph
[legend]
Collaboration diagram for MFnMatrixData:

Collaboration graph
[legend]

List of all members.


Detailed Description

Matrix function set for dependency node data.

MFnMatrixData allows the creation and manipulation of MMatrix data objects for use in the dependency graph.

If a user written dependency node either accepts or produces MMatrix, then this class is used to extract or create the data that comes from or goes to other dependency graph nodes. The MDataHandle::type method will return kMatrix when data of this type is present. To access it, the MDataHandle::data method is used to get an MObject for the data and this should then be used to initialize an instance of MFnMatrixData.

Examples:

cgfxAttrDef.cpp, cgfxVector.cpp, cvColorNode.cpp, dagPoseInfoCmd.cpp, GLSLShaderNode.cpp, ownerEmitter.cpp, simpleEmitter.cpp, sweptEmitter.cpp, and torusField.cpp.


Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnMatrixData ()
 Destructor.
 MFnMatrixData ()
 Default constructor.
 MFnMatrixData (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
bool isTransformation (MStatus *ReturnStatus=NULL) const
MTransformationMatrix transformation (MStatus *ReturnStatus=NULL) const
const MMatrixmatrix (MStatus *ReturnStatus=NULL) const
MStatus set (const MTransformationMatrix &transformation)
MStatus set (const MMatrix &matrix)
MObject create (MStatus *ReturnStatus=NULL)
MObject create (const MMatrix &, MStatus *ReturnStatus=NULL)
MObject create (const MTransformationMatrix &, MStatus *ReturnStatus=NULL)
 MFnMatrixData (const MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.

Constructor & Destructor Documentation

MFnMatrixData::MFnMatrixData ( 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:

MFnMatrixData::MFnMatrixData ( 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 MFnMatrixData::type (  )  const [virtual]

Function set type.

Return the class type : MFn::kMatrixData

Reimplemented from MFnData.

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

Class name.

Return the class name : "MFnMatrixData"

Reimplemented from MFnData.

bool MFnMatrixData::isTransformation ( MStatus ReturnStatus = NULL  )  const

Determine if the matrix held in this instance is a transform matrix.

Parameters:
[out] ReturnStatus kFailure if the instance is not attached to an MObject, and kSuccess otherwise.
Returns:
true if the instance holds a transform matrix, false otherwise

MTransformationMatrix MFnMatrixData::transformation ( MStatus ReturnStatus = NULL  )  const

Return a copy of the transform matrix held in this instance.

Parameters:
[out] ReturnStatus kFailure if the instance is not attached to an MObject, and kSuccess otherwise.
Returns:
A copy of the MTransformationMatrix held in this instance

const MMatrix & MFnMatrixData::matrix ( MStatus ReturnStatus = NULL  )  const

Return a constant reference to the matrix held in this instance.

Parameters:
[out] ReturnStatus kFailure if the instance is not attached to an MObject, and kSuccess otherwise.
Returns:
A const reference to the MMatrix

MStatus MFnMatrixData::set ( const MTransformationMatrix transformation  ) 

Set this instance to hold a copy of the given transform matrix.

Parameters:
[in] transformation the MTransformationMatrix matrix to copy the data from
Returns:
  • kSuccess operation successfull.
  • kFailure instance is not attached to an MObject

MStatus MFnMatrixData::set ( const MMatrix mat  ) 

Set this instance to hold a copy of the given matrix.

Parameters:
[in] mat the MMatrix matrix to copy the data from
Returns:
  • kSuccess operation successfull.
  • kFailure instance is not attached to an MObject

MObject MFnMatrixData::create ( MStatus ReturnStatus = NULL  ) 

Create a new MObject, attach it to this instance and initialize it to the identity matrix. The result is not a transform matrix

Parameters:
[out] ReturnStatus kSuccess
Returns:
The new MObject
Examples:

MObject MFnMatrixData::create ( const MMatrix mat,
MStatus ReturnStatus = NULL 
)

Create a new MObject, attach it to this instance and initialize it to the given matrix. The result is not a transform matrix.

Parameters:
[in] mat the MMatrix to copy the data from
[out] ReturnStatus kSuccess
Returns:
The new MObject

MObject MFnMatrixData::create ( const MTransformationMatrix transformation,
MStatus ReturnStatus = NULL 
)

Create a new MObject, attach it to this instance and initialize it to the given transform matrix.

Parameters:
[in] transformation the MTransformationMatrix to copy the data from
[out] ReturnStatus kSuccess
Returns:
The new MObject


Autodesk® Maya® 2009 © 1997-2008 Autodesk, Inc. All rights reserved. Generated with doxygen 1.5.6