MFloatPointArray Class Reference
 
 
 
MFloatPointArray Class Reference

This reference page is linked to from the following overview topics: Using IEnumerable and LINQ with the Maya .NET API, Evaluating shading nodes outside of the rendering context.


#include <MFloatPointArray.h>


Class Description

List of all members.

Public Member Functions

  MFloatPointArray ()
  Default constructor.
  MFloatPointArray (const MFloatPointArray &other)
  Copy constructor.
  MFloatPointArray (const MFloatPoint points[], unsigned int count)
  NO SCRIPT SUPPORT.
  MFloatPointArray (const float points[][4], unsigned int count)
  Create a new array of MFloatPoints and initialize it with the given elements.
  MFloatPointArray (const double points[][4], unsigned int count)
  Create a new array of MFloatPoints and initialize it with the given elements.
  MFloatPointArray (unsigned int initialSize, const MFloatPoint &initialValue=MFloatPoint::origin)
  Create a new array of MFloatPoints of a specified size and initialize all the elements with the given initial value.
  ~MFloatPointArray ()
  The class destructor.
const MFloatPoint operator[] (unsigned int index) const
  Index operator.
MFloatPointArray operator= (const MFloatPointArray &other)
  Assignment operator copies all of the elements of the other array into this one.
MStatus  set (const MFloatPoint &element, unsigned int index)
  Sets the value of the indicated element to the indicated value.
MStatus  set (unsigned int index, float x, float y, float z=0, float w=1)
  Sets the value of the indicated element to the indicated values.
MStatus  set (float element[4], unsigned int index)
  Sets the value of the indicated element to the indicated value.
MStatus  set (double element[4], unsigned int index)
  Sets the value of the indicated element to the indicated 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 (const MFloatPoint &element, unsigned int index)
  Inserts a new value into the array at the given index.
MStatus  append (const MFloatPoint &element)
  Adds a new element to the end of the array.
MStatus  append (float x, float y, float z=0, float w=1)
  Adds a new element to the end of the array.
MStatus  copy (const MFloatPointArray &source)
  Copy the contents of the source array to this array.
MStatus  clear ()
  Clear the contents of the array.
MStatus  get (float[][4]) const
  Copy the elements of the array into the C++ array of float arrays.
MStatus  get (double[][4]) const
  Copy the elements of the array into the C++ array of double arrays.
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.
MFloatPoint 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 MFloatPointArray &array)
  NO SCRIPT SUPPORT.

Constructor & Destructor Documentation

Default constructor.

The instance is set to contain no elements.

MFloatPointArray ( const MFloatPointArray other )

Copy constructor.

Parameters:
[in] other the array with which to initialize this instance
MFloatPointArray ( const MFloatPoint  src[],
unsigned int  count 
)

NO SCRIPT SUPPORT.

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

Parameters:
[in] src an array of MFloatPoints
[in] count the number of elements in the src array
MFloatPointArray ( const float  src[][4],
unsigned int  count 
)

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

Parameters:
[in] src a C++ array of float arrays of length four
[in] count the number of elements in the array
MFloatPointArray ( const double  src[][4],
unsigned int  count 
)

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

Parameters:
[in] src a C++ array of double arrays of length four
[in] count the number of elements in the array
MFloatPointArray ( unsigned int  initialSize,
const MFloatPoint initialValue = MFloatPoint::origin 
)

Create a new array of MFloatPoints 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

const MFloatPoint & operator[] ( unsigned int  index ) const

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.
MFloatPointArray & operator= ( const MFloatPointArray other )

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

If the other array was returned as a reference to internal data, then this array will also become a reference rather than doing a full copy.

Parameters:
[in] other the array being copied
Returns:
A reference to this array
MStatus set ( const MFloatPoint element,
unsigned int  index 
)

Sets the value of the indicated element to the indicated 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
Examples:
AbcImport/MeshHelper.cpp.
MStatus set ( unsigned int  index,
float  x,
float  y,
float  z = 0,
float  w = 1 
)

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

The x component of the element is set to x, the y component to y, the z component to z, and the w component to w.

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

Parameters:
[in] index the index of the element that is to be set to the the new value
[in] x the new value for the x component
[in] y the new value for the y component
[in] z the new value for the z component,defaulted to 0
[in] w the new value for the w component,defaulted to 1
Returns:
MS::kSuccess if the value was set successfully and MS::kFailure otherwise
MStatus set ( float  val[4],
unsigned int  index 
)

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

The x component of the element is set to val[0], the y component to val[1], the z component to val[2], and the w component to val[3].

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

Parameters:
[in] val 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  val[4],
unsigned int  index 
)

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

The x component of the element is set to val[0], the y component to val[1], the z component to val[2], and the w component to val[3].

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

Parameters:
[in] val 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 )

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:
AbcImport/MeshHelper.cpp, gpuCache/CacheReaderAlembic.cpp, testNobjectNode/testNobjectNode.cpp, and testNpassiveNode/testNpassiveNode.cpp.
MStatus remove ( unsigned int  index )

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 ( const MFloatPoint element,
unsigned int  index 
)

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 ( const MFloatPoint element )

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:
animCubeNode/animCubeNode.cpp, blindDataShader/blindDataMesh.cpp, meshOpCmd/meshOpFtyAction.cpp, meshReorder/meshMapUtils.cpp, sampleCmd/sampleCmd.cpp, sampleParticles/sampleParticles.cpp, and shellNode/shellNode.cpp.
MStatus append ( float  x,
float  y,
float  z = 0,
float  w = 1 
)

Adds a new element to the end of the array.

The appended element has the indicated values for its x,y,z and w components. The x component of the element is set to x, the y component to y, the z component to z, and the w component to w.

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] x the value for the x component
[in] y the value for the y component
[in] z the value for the z component, defaulted to 0
[in] w the value for the w component, defaulted to 1
Returns:
MS::kSuccess if the append was successful and MS::kFailure otherwise
MStatus copy ( const MFloatPointArray source )

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
Examples:
meshReorder/meshRemapCmd.cpp.
MStatus clear ( )

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.

Returns:
MS::kSuccess if the operation is successful and MS::kFailure otherwise
MStatus get ( float  dest[][4] ) const

Copy the elements of the array into the C++ array of float arrays.

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

Parameters:
[out] dest the array to populate
Returns:
MS::kSuccess if the array argument is a non-zero pointer and MS::kFailure otherwise
Examples:
AbcImport/MeshHelper.cpp.
MStatus get ( double  dest[][4] ) const

Copy the elements of the array into the C++ array of double arrays.

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

Parameters:
[out] dest 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 )

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

Parameters:
[in] newIncrement the new increment
unsigned int sizeIncrement ( ) const

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

Returns:
The size increment.
MFloatPoint & 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]

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 MFloatPointArray array 
) [friend]

NO SCRIPT SUPPORT.

The format used is [0: [x, y, z, w], 1: [x, y, z, w], 2: [x, y, z, w], ...].

Parameters:
[in] os the ostream to print to
[in] array the MFloatPointArray whose value is to be printed
Returns:
The ostream reference, s, provided as the first parameter.

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