MFnMatrixData Class Reference

#include <MFnMatrixData.h>

Class 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:

Inheritance diagram for MFnMatrixData:

Public Member Functions
virtual MFn::Type	type () const
	Function set type. More...
virtual	~MFnMatrixData ()
	Destructor.
	MFnMatrixData ()
	Default constructor.
	MFnMatrixData (MObject &object, MStatus *ReturnStatus=NULL)
	Constructor. More...
bool	isTransformation (MStatus *ReturnStatus=NULL) const
	Determine if the matrix held in this instance is a transform matrix. More...
MTransformationMatrix	transformation (MStatus *ReturnStatus=NULL) const
	Return a copy of the transform matrix held in this instance. More...
const MMatrix &	matrix (MStatus *ReturnStatus=NULL) const
	Return a constant reference to the matrix held in this instance. More...
MStatus	set (const MTransformationMatrix &transformation)
	Set this instance to hold a copy of the given transform matrix. More...
MStatus	set (const MMatrix &matrix)
	Set this instance to hold a copy of the given matrix. More...
MObject	create (MStatus *ReturnStatus=NULL)
	Create a new MObject, attach it to this instance and initialize it to the identity matrix. More...
MObject	create (const MMatrix &, MStatus *ReturnStatus=NULL)
	Create a new MObject, attach it to this instance and initialize it to the given matrix. More...
MObject	create (const MTransformationMatrix &, MStatus *ReturnStatus=NULL)
	Create a new MObject, attach it to this instance and initialize it to the given transform matrix. More...
	MFnMatrixData (const MObject &object, MStatus *ReturnStatus=NULL)
	Constructor. More...
Public Member Functions inherited from MFnData
virtual	~MFnData ()
	Destructor.
	MFnData (MObject &object, MStatus *ReturnStatus=NULL)
	Constructor. More...
	MFnData ()
	Default class constructor.
	MFnData (const MObject &object, MStatus *ReturnStatus=NULL)
	Constructor. More...
Public Member Functions inherited from MFnBase
virtual	~MFnBase ()
	Class Destructor. More...
bool	hasObj (MFn::Type) const
	Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system. More...
bool	hasObj (const MObject &) const
	Determines whether or not the Function Set is compatible with the specified Maya Object within the API RTTI system. More...
MObject	object (MStatus *ReturnStatus=NULL) const
	Returns the MObject that is attached to the Function Set. More...
virtual MStatus	setObject (MObject &object)
	Attaches the Function Set to the specified Maya Object. More...
virtual MStatus	setObject (const MObject &object)
	NO SCRIPT SUPPORT. More...

Protected Member Functions
virtual const char *	className () const
	Class name. More...

Additional Inherited Members
Public Types inherited from MFnData
enum	Type {   kInvalid, kNumeric, kPlugin, kPluginGeometry,   kString, kMatrix, kStringArray, kDoubleArray,   kFloatArray, kIntArray, kPointArray, kVectorArray,   kMatrixArray, kComponentList, kMesh, kLattice,   kNurbsCurve, kNurbsSurface, kSphere, kDynArrayAttrs,   kDynSweptGeometry, kSubdSurface, kNObject, kNId,   kAny, kLast }
	Types of dependency graph data. More...
Static Public Member Functions inherited from MFnBase
static const char *	className ()
	Returns the name of this class. More...

Constructor & Destructor Documentation

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:

• 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

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:

• 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

Function set type.

Return the class type : MFn::kMatrixData.

Reimplemented from MFnData.

const char * className ( ) const

protectedvirtual

Class name.

Return the class name : "MFnMatrixData".

Reimplemented from MFnData.

bool 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 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 & 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 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 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 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 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 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

---

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

• MFnMatrixData.h
• MFnMatrixData.cpp