- Main Page
- Related Pages
- Modules
- Namespaces
- Classes
- Examples

- Class List
- Class Hierarchy
- Class Members

Public Member Functions | Protected Member Functions

# MFnFloatArrayData Class Reference
OpenMaya - API module for common classes | FunctionSet classes

This reference page is linked to from the following overview topics: Extension for Autodesk Maya 2013.

Search for all occurrences

## 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.

`#include <MFnFloatArrayData.h>`

Inheritance diagram for MFnFloatArrayData:
[legend]

List of all members.

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

## Constructor & Destructor Documentation

MFnFloatArrayData | ( | MObject & | object,
|  | MStatus * | ReturnStatus = `NULL`
| ) |  |

Constructor.

Class constructor that initializes the function set to the given MObject.

Parameters:

  [in] | object | The MObject to attach the function set to
  [out] | ReturnStatus | the 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] | object | The MObject to attach the function set to
  [out] | ReturnStatus | the 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]`

Search for all occurrences

Function set type.

Return the class type : MFn::kFloatArrayData.

Reimplemented from MFnData.

const char * className | ( |  | ) | const`[protected, virtual]`

Search for all occurrences

Class name.

Return the class name : "MFnFloatArrayData".

Reimplemented from MFnData.

unsigned int length | ( | MStatus * | ReturnStatus = `NULL` | ) | const

Search for all occurrences

Return the number of floats in the instance.

Parameters:

  [out] | ReturnStatus | kFailure if the instance is not attached to an MObject, and kSuccess otherwise.

Returns:
  The number of floats in the instance

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] | index | the index of the float to extract

Returns:
  The indicated float

MStatus set | ( | float | element,
|  | unsigned int | index
| ) |  |

Search for all occurrences

Set the float array element at the specified index.

The index must be valid for the array.

Parameters:

  [in] | element | the element to set at the specified index
  [in] | index | the index of the float to set

Returns:
  - kSuccess operation successful
  - kFailure instance is not attached to an MObject

MStatus copyTo | ( | MFloatArray & | dest | ) | const

Search for all occurrences

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

Parameters:

  [out] | dest | the MFloatArray to populate

Returns:
  - kSuccess operation successful
  - kFailure instance is not attached to an MObject

MStatus set | ( | const MFloatArray & | array | ) |

Search for all occurrences

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

Parameters:

  [in] | array | the 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` | ) |

Search for all occurrences

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] | ReturnStatus | kFailure 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` | ) |

Search for all occurrences

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

Parameters:

  [out] | ReturnStatus | kSuccess

Returns:
  MObject referring to the newly created float array data object

MObject create | ( | const MFloatArray & | arr,
|  | MStatus * | ReturnStatus = `NULL`
| ) |  |

Search for all occurrences

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] | arr | the data to use when initializing this instance
  [out] | ReturnStatus | kSuccess

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] | index | the index of the float to extract

Returns:
  The indicated float

MFnFloatArrayData MFnFloatArrayData MFnFloatArrayData MFnFloatArrayData MFnFloatArrayData MFnFloatArrayData MFnFloatArrayData MFnFloatArrayData MFnFloatArrayData MFnFloatArrayData
MFnFloatArrayData MFnFloatArrayData MFnFloatArrayData MFnFloatArrayData MFnFloatArrayData MFnFloatArrayData MFnFloatArrayData MFnFloatArrayData MFnFloatArrayData MFnFloatArrayData