MIntArray Class Reference
 
 
 
MIntArray Class Reference

#include <MIntArray.h>


Class Description

Array of integers data type.

This class implements an array of integers. 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.

Examples:

AbcExport/MayaMeshWriter.cpp, AbcExport/MayaPointPrimitiveWriter.cpp, AbcImport/AlembicNode.cpp, AbcImport/CreateSceneHelper.cpp, AbcImport/MeshHelper.cpp, AbcImport/NodeIteratorVisitorHelper.cpp, animCubeNode/animCubeNode.cpp, animExportUtil/animExportUtil.cpp, apiMeshShape/apiMeshCreator.cpp, apiMeshShape/apiMeshCreator.h, apiMeshShape/apiMeshData.cpp, apiMeshShape/apiMeshGeom.h, apiMeshShape/apiMeshGeometryOverride.h, blindDataShader/blindDataMesh.cpp, blindDataShader/blindDataShader.cpp, cgfxShaderNode.cpp, cgfxShaderNode.h, cleanPerFaceAssignment/cleanPerFaceAssignmentCmd.cpp, convertEdgesToFacesCmd/convertEdgesToFacesCmd.cpp, convertVerticesToEdgesCmd/convertVerticesToEdgesCmd.cpp, convertVerticesToFacesCmd/convertVerticesToFacesCmd.cpp, customPrimitiveGenerator/customPrimitiveGenerator.cpp, cvColorShader/cvColorShader.cpp, dx11Shader/dx11Shader.cpp, flipUVCmd/flipUVCmd.cpp, flipUVCmd/flipUVCmd.h, gpuCache/CacheReaderAlembic.cpp, gpuCache/gpuCacheUtil.h, hairCollisionSolver/hairCollisionSolver.cpp, hwPhongShader/hwPhongShader.cpp, instancerListCmd/instancerListCmd.cpp, intersectCmd/intersectCmd.cpp, listPolyHolesCmd/listPolyHolesCmd.cpp, meshOpCmd/meshOpCmd.h, meshOpCmd/meshOpFty.cpp, meshOpCmd/meshOpFty.h, meshOpCmd/meshOpFtyAction.cpp, meshOpCmd/meshOpNode.cpp, meshOpCmd/polyModifierCmd.cpp, meshOpCmd/polyModifierCmd.h, meshReorder/meshMapUtils.cpp, meshReorder/meshMapUtils.h, meshReorder/meshRemapCmd.cpp, meshReorder/meshRemapCmd.h, meshReorder/meshRemapTool.cpp, meshReorder/meshRemapTool.h, meshReorder/meshReorderCmd.cpp, meshReorder/meshReorderCmd.h, meshReorder/meshReorderTool.h, MetadataSample/createMetadataCmd.cpp, MetadataSample/createMetadataCmd.h, moveNumericTool/moveNumericTool.cpp, nodeCreatedCBCmd/nodeCreatedCBCmd.cpp, nodeCreatedCBCmd/nodeCreatedCBCmd.h, objExport/objExport.cpp, ownerEmitter/ownerEmitter.cpp, ownerEmitter/ownerEmitter.h, particlePathsCmd/particlePathsCmd.cpp, particleSystemInfoCmd/particleSystemInfoCmd.cpp, pluginMain.cpp, polyPrimitiveCmd/polyPrimitiveCmd.cpp, polyRawExporter/polyRawWriter.cpp, polyRawExporter/polyRawWriter.h, polyRawExporter/polyWriter.cpp, polyRawExporter/polyWriter.h, polyX3DExporter/polyWriter.cpp, polyX3DExporter/polyWriter.h, polyX3DExporter/polyX3DWriter.cpp, polyX3DExporter/polyX3DWriter.h, shellNode/shellNode.cpp, simpleEmitter/simpleEmitter.cpp, simpleEmitter/simpleEmitter.h, simpleFluidEmitter/simpleFluidEmitter.h, simpleSpring/simpleSpring.h, skinClusterWeights/skinClusterWeights.cpp, splitUVCmd/polyModifierCmd.cpp, splitUVCmd/polyModifierCmd.h, splitUVCmd/splitUVCmd.cpp, splitUVCmd/splitUVCmd.h, splitUVCmd/splitUVFty.cpp, splitUVCmd/splitUVFty.h, splitUVCmd/splitUVFtyAction.cpp, splitUVCmd/splitUVNode.cpp, sweptEmitter/sweptEmitter.cpp, sweptEmitter/sweptEmitter.h, testNobjectNode/testNobjectNode.cpp, testNpassiveNode/testNpassiveNode.cpp, vertexBufferGenerator/vertexBufferGenerator.cpp, viewRenderOverride/viewRenderOverrideOperations.cpp, viewRenderOverrideShadows/viewRenderOverrideShadows.cpp, volumeLightCmd/volumeLightCmd.cpp, xmlAssembly/BBoxesRep.cpp, and xmlAssembly/BoundingBoxRep.cpp.

List of all members.

Public Member Functions

  MIntArray ()
  Default constructor.
  MIntArray (const MIntArray &other)
  Copy Constructor.
  MIntArray (const int src[], unsigned int count)
  Create a new array of integers and initialize it with the given elements.
  MIntArray (unsigned int initialSize, int initialValue=0)
  Create a new array of integers of a specified size and initialize all the elements with the given initial value.
  ~MIntArray ()
  The class destructor.
MIntArray operator= (const MIntArray &other)
  Assignment operator copies all of the elements of the other array into this one.
MStatus  set (int element, 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 (int element, unsigned int index)
  Inserts a new value into the array at the given index.
MStatus  append (int element)
  Adds a new element to the end of the array.
MStatus  copy (const MIntArray &source)
  Copy the contents of the source array to this array.
MStatus  clear ()
  Clear the contents of the array.
MStatus  get (int[]) const
  Copy the elements of the array into the given C++ array of ints.
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.
int &  operator[] (unsigned int index)
  NO SCRIPT SUPPORT.
int  operator[] (unsigned int index) const
  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 MIntArray &array)
  NO SCRIPT SUPPORT.

Constructor & Destructor Documentation

MIntArray ( )

Default constructor.

The instance is set to contain no elements.

MIntArray ( const MIntArray other )

Copy Constructor.

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

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

Parameters:
[in] src a C++ array of ints
[in] count the number of elements in the src array
MIntArray ( unsigned int  initialSize,
int  initialValue = 0 
)

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

MIntArray & operator= ( const MIntArray 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 (eg MFnIntArrayData::array), 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 ( int  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
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, cgfxShaderNode.cpp, flipUVCmd/flipUVCmd.cpp, gpuCache/CacheReaderAlembic.cpp, polyRawExporter/polyWriter.cpp, and polyX3DExporter/polyWriter.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
Examples:
cleanPerFaceAssignment/cleanPerFaceAssignmentCmd.cpp, meshReorder/meshMapUtils.cpp, and nodeCreatedCBCmd/nodeCreatedCBCmd.cpp.
MStatus insert ( int  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
Examples:
animExportUtil/animExportUtil.cpp.
MStatus copy ( const MIntArray 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
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.

Examples:
apiMeshShape/apiMeshCreator.cpp, cleanPerFaceAssignment/cleanPerFaceAssignmentCmd.cpp, listPolyHolesCmd/listPolyHolesCmd.cpp, meshReorder/meshMapUtils.cpp, meshReorder/meshRemapCmd.cpp, nodeCreatedCBCmd/nodeCreatedCBCmd.cpp, ownerEmitter/ownerEmitter.cpp, simpleEmitter/simpleEmitter.cpp, sweptEmitter/sweptEmitter.cpp, and volumeLightCmd/volumeLightCmd.cpp.
MStatus get ( int  array[] ) const

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

No checking is done to ensure that the destination C++ array of ints 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 )

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.
int & 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
int 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.
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 MIntArray array 
) [friend]

NO SCRIPT SUPPORT.

The format used is [1, 2, 3, ... 9].

Parameters:
[in] os the ostream to print to
[in] array the MIntArray 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: