class MFnPointArrayData

Jump to documentation

Inheritance:

MFnPointArrayData < MFnData < MFnBase

public members:

	MFnPointArrayData ()
	MFnPointArrayData ( MObject & object, MStatus * ReturnStatus = NULL )
virtual	~MFnPointArrayData ()
virtual MFn::Type	type () const
unsigned int	length ( MStatus * ReturnStatus = NULL ) const
MStatus	set ( MPoint & element, unsigned int index )
MStatus	copyTo ( MPointArray & ) const
MStatus	set ( const MPointArray & newArray )
MPointArray	array ( MStatus *ReturnStatus=NULL )
MObject	create ( MStatus *ReturnStatus=NULL )
MObject	create ( const MPointArray & in, MStatus *ReturnStatus=NULL )
	MFnPointArrayData ( const MObject & object, MStatus * ReturnStatus = NULL )
MPoint &	operator[] ( unsigned int index ) NO SCRIPT SUPPORT
const MPoint &	operator[] ( unsigned int index ) const NO SCRIPT SUPPORT

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

Description

MFnPointArrayData allows the creation and manipulation of MPointArray data objects for use in the dependency graph.

If a user written dependency node either accepts or produces MPointArrays, 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 kPointArray 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 MFnPointArrayData.

Functions

MFnPointArrayData:: MFnPointArrayData ()

Description

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

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

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

MFnPointArrayData:: ~MFnPointArrayData ()

Description

The class destructor.

MFn::Type MFnPointArrayData:: type () const

Description

Return the type of this function set.

Return Value

• the constant MFn::kPointArrayData

const MPoint & MFnPointArrayData:: operator[] ( unsigned int index ) const

Description

Extract the indicated MPoint 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 an MPoint containing (0.0, 0.0, 0.0, 1.0).

Arguments

• index the index of the MPoint to extract

Return Value

• the indicated MPoint

MStatus MFnPointArrayData:: set ( MPoint & element, unsigned int index )

Description

Set the point element at the specified index.

Arguments

• element the element to be set
• index the index of the MPoint to set

Return Value

• kSuccess operation successful
• kFailure instance is not attached to an MObject

MPoint & MFnPointArrayData:: operator[] ( unsigned int index )

Description

Extract the indicated MPoint from the instance. The MPoint returned by this method is editable, so any changes to the return instance also affects the MObject operated upon by this function set.

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 an MPoint containing (0.0, 0.0, 0.0, 1.0).

Arguments

• index the index of the MPoint to extract

Return Value

• the indicated MPoint

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

Description

Return the number of points in the instance.

Arguments

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

Return Value

• the number of points in the instance

MStatus MFnPointArrayData:: copyTo ( MPointArray & dest ) const

Description

Copy all the points in the instance into the given MPointArray. No checking is done by this class on sizes, so it is up to the user to ensure that the given MPointArray is large enough to hold the number of MPoints in the instance.

Arguments

• dest the MPointArray to populate

Return Value

• kSuccess operation successful
• kFailure instance is not attached to an MObject

MStatus MFnPointArrayData:: set ( const MPointArray & array )

Description

Set the instance to contain the points defined in the given MPointArray.

Arguments

• array the MPointArray containing the data to set into this instance

Return Value

• kSuccess operation successful
• kFailure instance is not attached to an MObject

MPointArray MFnPointArrayData:: array ( MStatus * ReturnStatus )

Description

Get an MPointArray containing the points stored in this instance. The MPointArray returned by this method is editable, so any changes to the return instance also affects the MObject operated upon by this function set.

Arguments

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

Return Value

• a copy of the MPointArray held in this instance

MObject MFnPointArrayData:: create ( const MPointArray & arr, MStatus * ReturnStatus )

Description

Create a new MObject, attach it to this instance, and initialize it to contain the data from the given MPointArray.

Arguments

• arr the data to use when initializing this instance
• ReturnStatus kSuccess

Return Value

• the newly created MObject

MObject MFnPointArrayData:: create ( MStatus * ReturnStatus )

Description

Create a new MObject, attach it to this instance, and initialize it to contain no points.

Arguments

• ReturnStatus kSuccess

Return Value

• the newly created MObject

This class has no child classes.