class MFnUInt64ArrayData

Jump to documentation

Inheritance:

MFnUInt64ArrayData < MFnData < MFnBase

public members:

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

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

MFnUInt64ArrayData allows the creation and manipulation of MUint64Array data objects for use in the dependency graph.

If a user written dependency node either accepts or produces MUint64Arrays, 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 kUInt64Array 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 MFnUInt64ArrayData.

Functions

MFnUInt64ArrayData:: MFnUInt64ArrayData ()

Description

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

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

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

MFnUInt64ArrayData:: ~MFnUInt64ArrayData ()

Description

The class destructor.

MFn::Type MFnUInt64ArrayData:: type () const

Description

Return the type of this function set.

Return Value

• the constant MFn::kUInt64ArrayData

MUint64 MFnUInt64ArrayData:: operator[] ( unsigned int index ) const

Description

Extract the indicated MUint64 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 MUint64 containing zero.

Arguments

• index the index of the MUint64 to extract

Return Value

• the indicated MUint64

MUint64& MFnUInt64ArrayData:: operator[] ( unsigned int index )

Description

Extract the indicated MUint64 from the instance. by the function set. The MUint64 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 MUint64 containing zero.

Arguments

• index the index of the MUint64 to extract

Return Value

• the indicated MUint64

MStatus MFnUInt64ArrayData:: set ( MUint64 element, unsigned int index )

Description

Set the element at the specified index of the array.

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.

Arguments

• element the element
• index the index of the MUint64 to set

Return Value

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

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

Description

Return the number of MUint64s in the instance.

Arguments

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

Return Value

• the number of MUint64s in the instance

MStatus MFnUInt64ArrayData:: copyTo ( MUint64Array & dest ) const

Description

Copy all the MUint64s in the instance into the given MUint64Array.

Arguments

• dest the MUint64Array to populate

Return Value

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

MStatus MFnUInt64ArrayData:: set ( const MUint64Array & array )

Description

Set the instance to contain the MUint64s defined in the given MUint64Array.

Arguments

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

Return Value

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

MUint64Array MFnUInt64ArrayData:: array ( MStatus * ReturnStatus )

Description

Return an MUint64Array containing the MUint64 array currently operated upon by the function set. The MUint64Array 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 MUint64Array held in this instance

MObject MFnUInt64ArrayData:: create ( const MUint64Array & arr, MStatus * ReturnStatus )

Description

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

Arguments

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

Return Value

• the newly created MObject

MObject MFnUInt64ArrayData:: create ( MStatus * ReturnStatus )

Description

Create a new MObject, attach it to this instance, and initialize it to be empty.

Arguments

• ReturnStatus kSuccess

Return Value

• the newly created MObject

This class has no child classes.