#include <MFnLatticeData.h>

Class Description

Lattice Data dependency graph type.

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.

Examples:: latticeNoise/latticeNoiseNode.cpp.

Inheritance diagram for MFnLatticeData:

Public Member Functions
virtual MFn::Type	type () const
	Function set type. More...

virtual	~MFnLatticeData ()
	Destructor.

	MFnLatticeData ()
	Default constructor.

	MFnLatticeData (MObject &object, MStatus *ReturnStatus=NULL)
	Constructor. More...

MObject	create (MStatus *ReturnStatus=NULL)
	This method create a new lattice data object for use with the dependency graph. More...

MObject	lattice (MStatus *ReturnStatus=NULL)
	Returns the lattice geometry so that it may be modified using the MFnLattice function set. More...

	MFnLatticeData (const MObject &object, MStatus *ReturnStatus=NULL)
	Constructor. More...

Public Member Functions inherited from MFnGeometryData
virtual	~MFnGeometryData ()
	Destructor.

	MFnGeometryData ()
	Default constructor.

	MFnGeometryData (MObject &object, MStatus *ReturnStatus=NULL)
	Constructor. More...

MStatus	setMatrix (const MMatrix &)
	Reset the matrix the the specified matrix and set the identity flag if the new matrix is the identity. More...

MStatus	getMatrix (MMatrix &) const
	Get the matrix associated with the geometry data. More...

bool	matrixIsIdentity (MStatus *ReturnStatus=NULL) const
	Return true if the matrix is the identity. More...

bool	matrixIsNotIdentity (MStatus *ReturnStatus=NULL) const
	Return true if the matrix is different from identity. More...

bool	hasObjectGroup (unsigned int id, MStatus *ReturnStatus=NULL) const
	This method returns true if an object group with the given id is contained in the data. More...

MStatus	addObjectGroup (unsigned int)
	This method adds an object group with the given id to the object. More...

MStatus	removeObjectGroup (unsigned int)
	This method removes an object group with the given id from the object. More...

MStatus	changeObjectGroupId (unsigned int, unsigned int)
	This method changes the id of the object group with the given id to the new id. More...

unsigned int	objectGroupCount (MStatus *ReturnStatus=NULL) const
	This method returns the number of object groups contained by the object. More...

unsigned int	objectGroup (unsigned int index, MStatus *ReturnStatus=NULL) const
	This method returns the id of the i'th object group contained by the object. More...

MFn::Type	objectGroupType (unsigned int, MStatus *ReturnStatus=NULL) const
	This method returns the type of the component that the object group with the given id contains. More...

MObject	objectGroupComponent (unsigned int, MStatus *ReturnStatus=NULL) const
	This method returns a component which contains the members of the object group with the given id. More...

MStatus	setObjectGroupComponent (unsigned int, MObject &)
	This method sets the members of the object group with the given id to be only those in the given component. More...

MStatus	addObjectGroupComponent (unsigned int, MObject &)
	This method adds the members of the given component to the object group with the given id. More...

MStatus	removeObjectGroupComponent (unsigned int, MObject &)
	This method removes the members of the given component from the object group with the given id. More...

MStatus	copyObjectGroups (MObject &inGeom)
	Copies the object groups from the given geometry data object. More...

	MFnGeometryData (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

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

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

Reimplemented from MFnGeometryData.

const char * className ( ) const

protectedvirtual

Class name.

Return the class name : "MFnLatticeData".

Reimplemented from MFnGeometryData.

MObject create ( MStatus * ReturnStatus = NULL )

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.

Parameters

[out] ReturnStatus return status

Returns: A handle to the new lattice data object

Status Codes:

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

MObject lattice ( MStatus * ReturnStatus = NULL )

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.

Parameters

[out] ReturnStatus return status

Returns: A handle to the new lattice data object

Status Codes:

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

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

MFnLatticeData.h
MFnLatticeData.cpp

MFnLatticeData Class Reference

Class Description

Public Member Functions

Protected Member Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation