class MFnMatrixData

Jump to documentation

: public MFnData Matrix function set for dependency node data. (OpenMaya) (OpenMaya.py)

Inheritance:

MFnMatrixData < MFnData < MFnBase

public members:

MFnMatrixData ()
MFnMatrixData ( MObject & object, MStatus * ReturnStatus = NULL )
virtual ~MFnMatrixData ()
virtual MFn::Type type () const
bool isTransformation ( MStatus * ReturnStatus = NULL ) const
MTransformationMatrix transformation ( MStatus * ReturnStatus = NULL ) const
const MMatrix & matrix ( 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 )

Inherited from MFnData:

public members:

enum Type
kInvalid
kNumeric
Numeric, use MFnNumericData extract the node data.
kPlugin
Plugin Blind Data, use MFnPluginData to extract the node data.
kPluginGeometry
Plugin Geometry, use MFnGeometryData to extract the node data.
kString
String, use MFnStringData to extract the node data.
kMatrix
Matrix, use MFnMatrixData to extract the node data.
kStringArray
String Array, use MFnStringArrayData to extract the node data.
kDoubleArray
Double Array, use MFnDoubleArrayData to extract the node data.
kIntArray
Int Array, use MFnIntArrayData to extract the node data.
kPointArray
Point Array, use MFnPointArrayData to extract the node data.
kVectorArray
Vector Array, use MFnVectorArrayData to extract the node data.
kComponentList
Component List, use MFnComponentListData to extract the node data.
kMesh
Mesh, use MFnMeshData to extract the node data.
kLattice
Lattice, use MFnLatticeData to extract the node data.
kNurbsCurve
Nurbs Curve, use MFnNurbsCurveData to extract the node data.
kNurbsSurface
Nurbs Surface, use MFnNurbsSurfaceData to extract the node data.
kSphere
Sphere, use MFnSphereData to extract the node data.
kDynArrayAttrs
ArrayAttrs, use MFnArrayAttrsData to extract the node data.
kDynSweptGeometry
SweptGeometry, use MFnDynSweptGeometryData to extract the node data.
kSubdSurface
Subdivision Surface, use MFnSubdData to extract the node data.
kNObject
nObject data, use MFnNObjectData to extract node data
kLast

Inherited from MFnBase:

public members:

virtual MFn::Type type () const
bool hasObj ( MFn::Type ) const
bool hasObj ( const MObject & ) const
MObject object ( MStatus * ReturnStatus = NULL ) const
virtual MStatus setObject ( MObject & object )
virtual MStatus setObject ( const MObject & object )

Documentation

Create and manipulate MMatrix dependency node data
Description

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.

Functions

MFnMatrixData:: MFnMatrixData ()

Description

Default class constructor. The function set is not attached to an MObject.

MFnMatrixData:: MFnMatrixData ( MObject & object, MStatus * ReturnStatus )

Description

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

Arguments

  • object the MObject to attach the function set to
  • ReturnStatus the return status
    • 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:: MFnMatrixData ( const MObject & object, MStatus * ReturnStatus )

Description

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

Arguments

  • object the const MObject to attach the function set to
  • ReturnStatus the return status
    • 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:: ~MFnMatrixData ()

Description

The class destructor.

MFn::Type MFnMatrixData:: type () const

Description

Return the type of this function set.

Return Value

  • the constant MFn::kMatrixData

bool MFnMatrixData:: isTransformation ( MStatus * ReturnStatus ) const

Description

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

Arguments

  • ReturnStatus kFailure if the instance is not attached to an MObject, and kSuccess otherwise.

Return Value

  • true if the instance holds a transform matrix, false otherwise

const MMatrix & MFnMatrixData:: matrix ( MStatus * ReturnStatus ) const

Description

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

Arguments

  • ReturnStatus kFailure if the instance is not attached to an MObject, and kSuccess otherwise.

Return Value

  • a const reference to the MMatrix

MTransformationMatrix MFnMatrixData:: transformation ( MStatus * ReturnStatus ) const

Description

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

Arguments

  • ReturnStatus kFailure if the instance is not attached to an MObject, and kSuccess otherwise.

Return Value

  • a copy of the MTransformationMatrix held in this instance

MStatus MFnMatrixData:: set ( const MTransformationMatrix & transformation )

Description

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

Arguments

  • transformation the MTransformationMatrix matrix to copy the data from

Return Value

  • kSuccess operation successfull.
  • kFailure instance is not attached to an MObject

MStatus MFnMatrixData:: set ( const MMatrix & mat )

Description

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

Arguments

  • mat the MMatrix matrix to copy the data from

Return Value

  • kSuccess operation successfull.
  • kFailure instance is not attached to an MObject

MObject MFnMatrixData:: create ( MStatus * ReturnStatus )

Description

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

Arguments

  • ReturnStatus kSuccess

Return Value

  • the new MObject

MObject MFnMatrixData:: create ( const MMatrix & mat, MStatus * ReturnStatus )

Description

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

Arguments

  • mat the MMatrix to copy the data from
  • ReturnStatus kSuccess

Return Value

  • the new MObject

MObject MFnMatrixData:: create ( const MTransformationMatrix & transformation , MStatus * ReturnStatus )

Description

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

Arguments

  • transformation the MTransformationMatrix to copy the data from
  • ReturnStatus kSuccess

Return Value

  • the new MObject

This class has no child classes.


Autodesk® Maya® 2008 © 1997-2007 Autodesk, Inc. All rights reserved. doc++ Copyright