C++ API Reference

float array function set for dependency node data. More...

#include <MFnFloatArrayData.h>

+ Inheritance diagram for MFnFloatArrayData:

Public Member Functions

virtual MFn::Type type () const
 Function set type. More...
 
virtual ~MFnFloatArrayData ()
 Destructor.
 
 MFnFloatArrayData ()
 Default constructor.
 
 MFnFloatArrayData (MObject &object, MStatus *ReturnStatus=NULL)
 Constructor. More...
 
unsigned int length (MStatus *ReturnStatus=NULL) const
 Return the number of floats in the instance. More...
 
float operator[] (unsigned int index) const
 Extract the indicated float from the const instance. More...
 
MStatus set (float element, unsigned int index)
 Set the float array element at the specified index. More...
 
MStatus copyTo (MFloatArray &) const
 Copy all the floats in the instance into the given MFloatArray. More...
 
MStatus set (const MFloatArray &newArray)
 Set the instance to contain the floats defined in the given MFloatArray. More...
 
MFloatArray array (MStatus *ReturnStatus=NULL)
 Return an MFloatArray containing the float array currently operated upon by the function set. More...
 
MObject create (MStatus *ReturnStatus=NULL)
 Create a new float array data object, initialize it to be empty, and attach it to this instance. More...
 
MObject create (const MFloatArray &in, MStatus *ReturnStatus=NULL)
 Create a new float array data object, initialize it to contain the data from the given MDoubleArray, and attach it to this instance. More...
 
 MFnFloatArrayData (const MObject &object, MStatus *ReturnStatus=NULL)
 Constructor. More...
 
float & operator[] (unsigned int index)
 NO SCRIPT SUPPORT. 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=nullptr) 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...
 

Static Public Member Functions

static const char * className ()
 Returns the name of this class. More...
 
- Static Public Member Functions inherited from MFnData
static const char * className ()
 Returns the name of this class. More...
 
- Static Public Member Functions inherited from MFnBase
static const char * className ()
 Returns the name of this class. More...
 
static const char * typeString (MFn::Type)
 Returns the type string for a given type. More...
 
static bool isValid (MFn::Type)
 Returns true if type is in the range of valid types. 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, kFalloffFunction
}
 Types of dependency graph data. More...
 

Detailed Description

float array function set for dependency node data.

MFnFloatArrayData allows the creation and manipulation of MFloatArray data objects for use in the dependency graph.

If a user written dependency node either accepts or produces MFloatArrays, 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 kFloatArray 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 MFnFloatArrayData.

Examples:
AbcExport/AttributesWriter.cpp, AbcImport/NodeIteratorVisitorHelper.cpp, and offsetNode/offsetNode.cpp.

Constructor & Destructor Documentation

MFnFloatArrayData ( 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:
  • 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
MFnFloatArrayData ( 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:
  • 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::kFloatArrayData.

Returns
the class type.

Reimplemented from MFnData.

OPENMAYA_MAJOR_NAMESPACE_OPEN const char * className ( )
static

Returns the name of this class.

Return the class name : "MFnFloatArrayData".

Returns
Name of this class.
unsigned int length ( MStatus ReturnStatus = NULL) const

Return the number of floats in the instance.

Parameters
[out]ReturnStatuskFailure if the instance is not attached to an MObject, and kSuccess otherwise.
Returns
The number of floats in the instance
Examples:
AbcExport/AttributesWriter.cpp.
float operator[] ( unsigned int  index) const

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

Parameters
[in]indexthe index of the float to extract
Returns
The indicated float
MStatus set ( float  element,
unsigned int  index 
)

Set the float array element at the specified index.

The index must be valid for the array.

Parameters
[in]elementthe element to set at the specified index
[in]indexthe index of the float to set
Returns
  • kSuccess operation successful
  • kFailure instance is not attached to an MObject
MStatus copyTo ( MFloatArray dest) const

Copy all the floats in the instance into the given MFloatArray.

Parameters
[out]destthe MFloatArray to populate
Returns
  • kSuccess operation successful
  • kFailure instance is not attached to an MObject
MStatus set ( const MFloatArray array)

Set the instance to contain the floats defined in the given MFloatArray.

Parameters
[in]arraythe MFloatArray containing the data to set into this instance
Returns
  • kSuccess operation successful
  • kFailure instance is not attached to an MObject
MFloatArray array ( MStatus ReturnStatus = NULL)

Return an MFloatArray containing the float array currently operated upon by the function set.

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

Parameters
[out]ReturnStatuskFailure if the instance is not attached to an MObject, and kSuccess otherwise.
Returns
A copy of the MFloatArray held in this instance
MObject create ( MStatus ReturnStatus = NULL)

Create a new float array data object, initialize it to be empty, and attach it to this instance.

Parameters
[out]ReturnStatuskSuccess
Returns
MObject referring to the newly created float array data object
Examples:
AbcImport/NodeIteratorVisitorHelper.cpp, and offsetNode/offsetNode.cpp.
MObject create ( const MFloatArray arr,
MStatus ReturnStatus = NULL 
)

Create a new float array data object, initialize it to contain the data from the given MDoubleArray, and attach it to this instance.

Parameters
[in]arrthe data to use when initializing this instance
[out]ReturnStatuskSuccess
Returns
MObject referring to the newly created float array data object
float & operator[] ( unsigned int  index)

NO SCRIPT SUPPORT.

Extract the indicated float from the instance.

The float returned by this method is editable, so any changes to the return instance also affect 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 a reference to a dummy value.

Parameters
[in]indexthe index of the float to extract
Returns
The indicated float

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