class MFnLatticeData

Jump to documentation

: public MFnGeometryData Lattice Data dependency graph type. (OpenMaya) (OpenMaya.py)

Inheritance:

MFnLatticeData < MFnGeometryData < MFnData < MFnBase

public members:

MFnLatticeData ()
MFnLatticeData ( MObject & object, MStatus * ReturnStatus = NULL )
virtual ~MFnLatticeData ()
virtual MFn::Type type () const
MObject create ( MStatus * ReturnStatus = NULL )
MObject lattice ( MStatus * ReturnStatus = NULL )
MFnLatticeData ( const MObject & object, MStatus * ReturnStatus = NULL )

Inherited from MFnGeometryData:

public members:

virtual MFn::Type type () const
MStatus setMatrix ( const MMatrix & )
MStatus getMatrix ( MMatrix & ) const
bool matrixIsIdentity ( MStatus * ReturnStatus = NULL ) const
bool matrixIsNotIdentity ( MStatus * ReturnStatus = NULL ) const
bool hasObjectGroup ( unsigned int id, MStatus * ReturnStatus = NULL ) const
MStatus addObjectGroup ( unsigned int )
MStatus removeObjectGroup ( unsigned int )
MStatus changeObjectGroupId ( unsigned int , unsigned int )
unsigned int objectGroupCount ( MStatus * ReturnStatus = NULL ) const
unsigned int objectGroup ( unsigned int index, MStatus * ReturnStatus = NULL ) const
MFn::Type objectGroupType ( unsigned int, MStatus * ReturnStatus = NULL ) const
MObject objectGroupComponent ( unsigned int, MStatus * ReturnStatus = NULL ) const
MStatus setObjectGroupComponent ( unsigned int, MObject & )
MStatus addObjectGroupComponent ( unsigned int, MObject & )
MStatus removeObjectGroupComponent ( unsigned int, MObject & )
MStatus copyObjectGroups ( MObject & inGeom )

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

Manage lattice data that is passed between dependency graph nodes.
Description

This simple function set is used to create lattice data objects that can be transmitted through the dependency graph. It can also be used to extract the lattice geometry from the data object.

See MDataHandle and MDataBlock for more information about getting and setting data in the dependency graph.

Functions

MFnLatticeData:: MFnLatticeData ()

Description

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

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

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

MFnLatticeData:: ~MFnLatticeData ()

Description

The class destructor.

MFn::Type MFnLatticeData:: type () const

Description

Return the type of this function set.

Return Value

  • the constant MFn::kLatticeData

MObject MFnLatticeData:: create ( MStatus * ReturnStatus )

Description

This method create a new lattice data object for use with the dependency graph. A node's lattice attribute may be set with this object using MDataHandle.

Arguments

  • ReturnStatus return status

Return Value

  • a handle to the new lattice data object

Status Codes

  • MS::kSuccess operation successful
  • MS::kInsufficientMemory out of memory

MObject MFnLatticeData:: lattice ( MStatus * ReturnStatus )

Description

Returns the lattice geometry so that it may be modified using the MFnLattice function set.

It is possible that the data object will be NULL, indicating that the data handle (MDataHandle) or plug (MPlug) that owns this data has not initialized it. In this case, the create method of this function set can be used to create a new data object that can be used to set the data handle or plug.

Arguments

  • ReturnStatus return status

Return Value

  • a handle to the new lattice data object

Status Codes

  • MS::kSuccess operation successful
  • MS::kFailure function set does not have valid object

This class has no child classes.


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