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

- Class List
- Class Hierarchy
- Class Members

Public Member Functions | Static Public Member Functions | Friends

# MFloatArray Class Reference
OpenMaya - API module for common classes

This reference page is linked to from the following overview topics: ラッパ, Maya Python API を使用する.

Search for all occurrences

## Detailed Description

Array of floats data type.

This class implements an array of floats. Common convenience functions are available, and the implementation is compatible with the internal Maya implementation so that it can be passed efficiently between plugins and internal maya data structures.

Methods that query the array are threadsafe. Writing to different array elements at the same time with the set() method is threadsafe. Methods that modify the array length, namely append(), insert(), remove() and setLength() are not threadsafe.

Examples:

  apiMeshGeom.h, exportJointClusterDataCmd.cpp, flipUVCmd.cpp, flipUVCmd.h, getPointAndNormal.cpp, hwPhongShader.cpp, intersectCmd.cpp, meshOpFtyAction.cpp, meshRemapCmd.cpp, meshRemapCmd.h, meshReorderCmd.cpp, meshReorderCmd.h, objExport.cpp, peltOverlapCmd.cpp, polyRawWriter.h, polyX3DWriter.h, sampleCmd.cpp, sampleParticles.cpp, volumeLightCmd.cpp, and XmlGeometryCache.cpp.

`#include <MFloatArray.h>`

List of all members.

## Public Member Functions
| MFloatArray ()
| Default constructor.
| MFloatArray (const MFloatArray &other)
| Copy Constructor.
| MFloatArray (const float src[], unsigned int count)
| Create a new array of floats and initialize it with the given float elements.
| MFloatArray (const double src[], unsigned int count)
| Create a new array of floats and initialize it with the given double elements.
| MFloatArray (unsigned int initialSize, float initialValue=0)
| Create a new array of floats of a specified size and initialize all the elements with the given initial value.
| ~MFloatArray ()
| The class destructor.
MFloatArray & | operator= (const MFloatArray &other)
| Assignment operator copies all of the elements of the other array into this one.
MStatus | set (float element, unsigned int index)
| Sets the value of the indicated element to the indicated float value.
MStatus | set (double element, unsigned int index)
| Sets the value of the indicated element to the indicated double value.
MStatus | setLength (unsigned int length)
| Set the length of the array.
unsigned int | length () const
| Returns the number of elements in the instance.
MStatus | remove (unsigned int index)
| Remove the array element at the given index.
MStatus | insert (float element, unsigned int index)
| Inserts a new value into the array at the given index.
MStatus | append (float element)
| Adds a new element to the end of the array.
MStatus | copy (const MFloatArray &source)
| Copy the contents of the source array to this array.
MStatus | clear ()
| Clear the contents of the array.
MStatus | get (float[]) const
| Copy the elements of the array into the given C++ array of floats.
MStatus | get (double[]) const
| Copy the elements of the array into the given C++ array of doubles.
void | setSizeIncrement (unsigned int newIncrement)
| Set the size by which the array will be expanded whenever expansion is necessary.
unsigned int | sizeIncrement () const
| Return the size by which the array will be expanded whenever expansion is necessary.
float | operator[] (unsigned int index) const
| NO SCRIPT SUPPORT.
float & | operator[] (unsigned int index)
| NO SCRIPT SUPPORT.
## Static Public Member Functions
static const char * | className ()
| Returns the name of this class.
## Friends
OPENMAYA_EXPORT std::ostream & | operator<< (std::ostream &os, const MFloatArray &array)
| NO SCRIPT SUPPORT.

## Constructor & Destructor Documentation

MFloatArray | ( |  | ) |

Default constructor.

The instance is set to contain no elements.

MFloatArray | ( | const MFloatArray & | other | ) |

Copy Constructor.

Parameters:

  [in] | other | the array with which to initialize this instance

MFloatArray | ( | const float | src[],
|  | unsigned int | count
| ) |  |

Create a new array of floats and initialize it with the given float elements.

Parameters:

  [in] | src | a C++ array of floats
  [in] | count | the number of elements in the src array

MFloatArray | ( | const double | src[],
|  | unsigned int | count
| ) |  |

Create a new array of floats and initialize it with the given double elements.

Parameters:

  [in] | src | a C++ array of floats
  [in] | count | the number of elements in the src array

MFloatArray | ( | unsigned int | initialSize,
|  | float | initialValue = `0`
| ) |  |

Create a new array of floats of a specified size and initialize all the elements with the given initial value.

Parameters:

  [in] | initialSize | the initial size of the array
  [in] | initialValue | the initial value of each element

## Member Function Documentation

MFloatArray & operator= | ( | const MFloatArray & | other | ) |

Assignment operator copies all of the elements of the other array into this one.

Parameters:

  [in] | other | the array being copied

Returns:
  A reference to this array

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

Search for all occurrences

Sets the value of the indicated element to the indicated float value.

NOTE: This method does not grow the array if the index is out of bounds. Only a valid index should be used.

Parameters:

  [in] | element | the new value for the indicated element
  [in] | index | the index of the element that is to be set to the the new value

Returns:
  MS::kSuccess if the value was set successfully and MS::kFailure otherwise

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

Search for all occurrences

Sets the value of the indicated element to the indicated double value.

NOTE: This method does not grow the array if the index is out of bounds. Only a valid index should be used.

Parameters:

  [in] | element | the new value for the indicated element
  [in] | index | the index of the element that is to be set to the the new value

Returns:
  MS::kSuccess if the value was set successfully and MS::kFailure otherwise

MStatus setLength | ( | unsigned int | length | ) |

Search for all occurrences

Set the length of the array.

This will grow and shrink the array as desired. Elements that are grown have uninitialized values, while those which are shrunk will lose the data contained in the deleted elements (ie. it will release the memory).

Parameters:

  [in] | length | the new size of the array

Examples:
  flipUVCmd.cpp, peltOverlapCmd.cpp, and XmlGeometryCache.cpp.

unsigned int length | ( |  | ) | const

Search for all occurrences

Returns the number of elements in the instance.

Returns:
  The number of elements in the instance

Examples:
  exportJointClusterDataCmd.cpp, getPointAndNormal.cpp, meshRemapCmd.cpp, objExport.cpp, peltOverlapCmd.cpp, sampleCmd.cpp, volumeLightCmd.cpp, and XmlGeometryCache.cpp.

MStatus remove | ( | unsigned int | index | ) |

Search for all occurrences

Remove the array element at the given index.

All array elements following the removed element are shifted toward the first element.

Parameters:

  [in] | index | index of the element to be removed

Returns:
  MS::kSuccess if the remove was successful and MS::kFailure otherwise

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

Search for all occurrences

Inserts a new value into the array at the given index.

The initial element at that index, and all following elements, are shifted towards the last. If the array cannot be expanded in size by 1 element, then the insert will fail and the existing array will remain unchanged.

Parameters:

  [in] | element | the new value to insert into the array
  [in] | index | the index of the element to set to the the new value

Returns:
  MS::kSuccess if the insert was successful and MS::kFailure otherwise

MStatus append | ( | float | element | ) |

Search for all occurrences

Adds a new element to the end of the array.

If the array cannot be expanded in size by 1 element, then the append will fail and the existing array will remain unchanged.

Parameters:

  [in] | element | the value for the new last element

Returns:
  MS::kSuccess if the append was successful and MS::kFailure otherwise

Examples:
  meshOpFtyAction.cpp, sampleCmd.cpp, sampleParticles.cpp, and volumeLightCmd.cpp.

MStatus copy | ( | const MFloatArray & | source | ) |

Search for all occurrences

Copy the contents of the source array to this array.

Parameters:

  [in] | source | array to copy from

Returns:
  MS::kSuccess if the copy was successful and MS::kFailure otherwise

MStatus clear | ( |  | ) |

Search for all occurrences

Clear the contents of the array.

After this operation the length method will return 0. This does not change the amount of memory allocated to the array, only the number of valid elements in it.

- MS::kSuccess if the operation is successful and MS::kFailure otherwise

Examples:
  apiMeshGeom.h.

MStatus get | ( | float | array[] | ) | const

Search for all occurrences

Copy the elements of the array into the given C++ array of floats.

No checking is done to ensure that the destination C++ array of floats is large enough to hold all the elements of the instance.

Parameters:

  [out] | array | the array to populate

Returns:
  MS::kSuccess if the array argument is a non-zero pointer and MS::kFailure otherwise

MStatus get | ( | double | array[] | ) | const

Search for all occurrences

Copy the elements of the array into the given C++ array of doubles.

No checking is done to ensure that the destination C++ array of doubles is large enough to hold all the elements of the instance.

Parameters:

  [out] | array | the array to populate

Returns:
  MS::kSuccess if the array argument is a non-zero pointer and MS::kFailure otherwise

void setSizeIncrement | ( | unsigned int | newIncrement | ) |

Search for all occurrences

Set the size by which the array will be expanded whenever expansion is necessary.

Parameters:

  [in] | newIncrement | the new increment

unsigned int sizeIncrement | ( |  | ) | const

Search for all occurrences

Return the size by which the array will be expanded whenever expansion is necessary.

Returns:
  The size increment.

float operator[] | ( | unsigned int | index | ) | const

NO SCRIPT SUPPORT.

Index operator.

Returns the value of the element at the given index. No range checking is done - valid indices are 0 to length()-1.

Parameters:

  [in] | index | the index of the element whose value is to be returned

Returns:
  The value of the indicated element.

float & operator[] | ( | unsigned int | index | ) |

NO SCRIPT SUPPORT.

Index operator allowing assignment to an element of the array.

Returns a reference to the element at the given index. No range checking is done - valid indices are 0 to length()-1.

Parameters:

  [in] | index | the index of the desired element

Returns:
  A reference to the indicated element

const char * className | ( |  | ) | `[static]`

Search for all occurrences

Returns the name of this class.

Returns:
  The name of this class.

## Friends And Related Function Documentation

OPENMAYA_EXPORT std::ostream& operator<< | ( | std::ostream & | os,
|  | const MFloatArray & | array
| ) |  | `[friend]`

NO SCRIPT SUPPORT.

The format used is [1.1, 2.2, 3.3, ... 9.9].

Parameters:

  [in] | os | the ostream to print to
  [in] | array | the MFloatArray whose value is to be printed

Returns:
  The ostream reference, s, provided as the first parameter.

MFloatArray MFloatArray MFloatArray MFloatArray MFloatArray MFloatArray MFloatArray MFloatArray MFloatArray MFloatArray
MFloatArray MFloatArray MFloatArray MFloatArray MFloatArray MFloatArray MFloatArray MFloatArray MFloatArray MFloatArray