C++ API Reference
|
float array function set for dependency node data. More...
#include <MFnFloatArrayData.h>
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... | |
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.
MFnFloatArrayData | ( | MObject & | object, |
MStatus * | ReturnStatus = NULL |
||
) |
MFnFloatArrayData | ( | const MObject & | object, |
MStatus * | ReturnStatus = NULL |
||
) |
|
virtual |
Function set type.
Return the class type : MFn::kFloatArrayData.
Reimplemented from MFnData.
|
static |
Returns the name of this class.
Return the class name : "MFnFloatArrayData".
unsigned int length | ( | MStatus * | ReturnStatus = NULL | ) | const |
Return the number of floats in the instance.
[out] | ReturnStatus | kFailure if the instance is not attached to an MObject, and kSuccess otherwise. |
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.
[in] | index | the index of the float to extract |
MStatus set | ( | float | element, |
unsigned int | index | ||
) |
Set the float array element at the specified index.
The index must be valid for the array.
[in] | element | the element to set at the specified index |
[in] | index | the index of the float to set |
MStatus copyTo | ( | MFloatArray & | dest | ) | const |
Copy all the floats in the instance into the given MFloatArray.
[out] | dest | the MFloatArray to populate |
MStatus set | ( | const MFloatArray & | array | ) |
Set the instance to contain the floats defined in the given MFloatArray.
[in] | array | the MFloatArray containing the data to set into this instance |
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.
[out] | ReturnStatus | kFailure if the instance is not attached to an MObject, and kSuccess otherwise. |
Create a new float array data object, initialize it to be empty, and attach it to this instance.
[out] | ReturnStatus | kSuccess |
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.
[in] | arr | the data to use when initializing this instance |
[out] | ReturnStatus | kSuccess |
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.
[in] | index | the index of the float to extract |