class MFnComponentListData

Jump to documentation

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

Inheritance:

MFnComponentListData < MFnData < MFnBase

public members:

MFnComponentListData ()
MFnComponentListData ( MObject & object, MStatus * ReturnStatus = NULL )
virtual ~MFnComponentListData ()
virtual MFn::Type type () const
unsigned int length ( MStatus * ReturnStatus = NULL ) const
bool has ( const MObject & obj, MStatus * ReturnStatus = NULL ) const
MObject operator[] ( unsigned int index) const
MStatus add ( MObject & )
MStatus remove ( const MObject & )
MStatus remove ( unsigned int index )
MStatus clear ()
MObject create ( MStatus * ReturnStatus = NULL )
public
NO SCRIPT SUPPORT
MFnComponentListData ( 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 Component Lists dependency node data.
Description

MFnComponentListData allows the creation and manipulation of component list (represented as MObjects) data objects for use in the dependency graph.

If a user written dependency node either accepts or produces MObjects containing component lists, then this class is used to extract or create the data that comes from or goes to other dependency graph nodes. 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 MFnComponentListData.

Functions

MFnComponentListData:: MFnComponentListData ()

Description

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

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

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

MFnComponentListData:: ~MFnComponentListData ()

Description

The class destructor.

MFn::Type MFnComponentListData:: type () const

Description

Return the type of this function set.

Return Value

  • the constant MFn::kComponentListData

MObject MFnComponentListData:: create ( MStatus * ReturnStatus )

Description

Create a new MObject, attach it to this instance, and initialize it to contain an empty component list.

Arguments

  • ReturnStatus kSuccess

Return Value

  • the newly created MObject

unsigned int MFnComponentListData:: length ( MStatus * ReturnStatus ) const

Description

Return the number of components in the instance.

Arguments

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

Return Value

  • the number of components in the instance

MObject MFnComponentListData:: operator[] ( unsigned int index ) const

Description

Extract the indicated component from the const instance. No checking is done by this class to ensure that the index is valid - use the length method to determine the size of the array. If the instance is not attached to an MObject, this method will return MObject::kNullObj.

Arguments

  • index the index of the component to extract

Return Value

  • the indicated component

bool MFnComponentListData:: has ( const MObject & obj, MStatus * ReturnStatus ) const

Description

Determine if the instance of the component list contains the component represented by the given MObject.

Arguments

  • obj the MObject containing the component to look for

Return Value

  • true if the component list contains the component, false otherwise

MStatus MFnComponentListData:: add ( MObject & obj )

Description

Add the given component to the component list.

Arguments

  • obj an MObject containing the component to add

Return Value

  • kSuccess if successful, kFailure if either the instance is not attached to a component list, or the given MObject does not contain a component.

MStatus MFnComponentListData:: remove ( const MObject & obj )

Description

Remove the given component from the component list.

Arguments

  • obj an MObject containing the component to remove

Return Value

  • kSuccess if successful, kFailure if either the instance is not attached to a component list, or the given MObject does not contain a component.

MStatus MFnComponentListData:: remove ( unsigned int index )

Description

Remove the indicated component from the component list.

Arguments

  • index the index of the component to remove

Return Value

  • kSuccess if successful, kFailure if either the instance is not attached to a component list.

MStatus MFnComponentListData:: clear ()

Description

Remove all components from the component list

Return Value

  • kSuccess if successful, kFailure if either the instance is not attached to a component list.

This class has no child classes.


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