Public Member Functions | Protected Member Functions

MFnLatticeData Class Reference

Search for all occurrences

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

latticeNoiseNode.cpp.

#include <MFnLatticeData.h>

Inheritance diagram for MFnLatticeData:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual MFn::Type type () const
 Function set type.
virtual ~MFnLatticeData ()
 Destructor.
 MFnLatticeData ()
 Default constructor.
 MFnLatticeData (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.
MObject create (MStatus *ReturnStatus=NULL)
 This method create a new lattice data object for use with the dependency graph.
MObject lattice (MStatus *ReturnStatus=NULL)
 Returns the lattice geometry so that it may be modified using the MFnLattice function set.
 MFnLatticeData (const MObject &object, MStatus *ReturnStatus=NULL)
 Constructor.

Protected Member Functions

virtual const char * className () const
 Class name.

Constructor & Destructor Documentation

MFnLatticeData ( MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

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

Parameters:
[in]objectThe MObject to attach the function set to
[out]ReturnStatusthe return status
Status Codes:
MFnLatticeData ( const MObject object,
MStatus ReturnStatus = NULL 
)

Constructor.

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

Parameters:
[in]objectThe MObject to attach the function set to
[out]ReturnStatusthe return status
Status Codes:

Member Function Documentation

MFn::Type type ( ) const [virtual]

Function set type.

Return the class type : MFn::kLatticeData.

Reimplemented from MFnGeometryData.

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

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]ReturnStatusreturn status
Returns:
A handle to the new lattice data object
Status Codes:
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]ReturnStatusreturn status
Returns:
A handle to the new lattice data object
Status Codes:

MFnLatticeData MFnLatticeData MFnLatticeData MFnLatticeData MFnLatticeData MFnLatticeData MFnLatticeData MFnLatticeData MFnLatticeData MFnLatticeData
MFnLatticeData MFnLatticeData MFnLatticeData MFnLatticeData MFnLatticeData MFnLatticeData MFnLatticeData MFnLatticeData MFnLatticeData MFnLatticeData