MObjectArray Class Reference
 
 
 
MObjectArray Class Reference

This reference page is linked to from the following overview topics: Components, Geometry data, 4.5 Handling custom renderables for object overrides.


#include <MObjectArray.h>


Class Description

Array of MObjects data type.

This class implements an array of MObjects. 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/MayaNurbsSurfaceWriter.cpp, AbcImport/CreateSceneHelper.cpp, AbcImport/NurbsSurfaceHelper.cpp, AbcImport/util.cpp, AbcImport/util.h, animExportUtil/animExportUtil.cpp, apiMeshShape/apiMeshData.cpp, apiMeshShape/apiMeshData.h, apiMeshShape/apiMeshGeometryOverride.cpp, apiMeshShape/apiMeshIterator.cpp, apiMeshShape/apiMeshIterator.h, apiMeshShape/apiMeshShape.cpp, apiMeshShape/apiMeshShape.h, apiMeshShape/apiMeshShapeUI.cpp, apiSimpleShape/apiSimpleShape.cpp, apiSimpleShape/apiSimpleShape.h, apiSimpleShape/apiSimpleShapeIterator.cpp, apiSimpleShape/apiSimpleShapeIterator.h, apiSimpleShape/apiSimpleShapeUI.cpp, atomImportExport/atomAnimLayers.cpp, atomImportExport/atomAnimLayers.h, atomImportExport/atomCachedPlugs.cpp, atomImportExport/atomImportExport.cpp, cgfxShaderCmd.cpp, cgfxShaderNode.cpp, cgfxShaderNode.h, cleanPerFaceAssignment/cleanPerFaceAssignmentCmd.cpp, clusterWeightFunction/clusterWeightFunction.cpp, createClipCmd/createClipCmd.cpp, cvColorShader/cvColorShader.cpp, D3DViewportRenderer/D3DGeometryItem.cpp, D3DViewportRenderer/D3DViewportRenderer.cpp, DX11ViewportRenderer/DX11GeometryItem.cpp, DX11ViewportRenderer/DX11ViewportRenderer.cpp, findFileTexturesCmd/findFileTexturesCmd.cpp, findTexturesPerPolygonCmd/findTexturesPerPolygonCmd.cpp, gameInputDevice/gameInputDevice.cpp, geometrySurfaceConstraint/geometrySurfaceConstraint.cpp, geometrySurfaceConstraint/geometrySurfaceConstraint.h, getAttrAffectsCmd/getAttrAffectsCmd.cpp, gpuCache/CacheReaderAlembic.cpp, gpuCache/gpuCacheShapeNode.cpp, gpuCache/gpuCacheShapeNode.h, hairCollisionSolver/hairCollisionSolver.cpp, hwManagedTextureShader/hwManagedTextureShader.cpp, maTranslator/maTranslator.cpp, meshOpCmd/polyModifierCmd.cpp, meshReorder/meshMapUtils.cpp, meshReorder/meshMapUtils.h, meshReorder/meshRemapCmd.cpp, meshReorder/meshRemapTool.h, meshReorder/meshReorderCmd.cpp, meshReorder/meshReorderTool.h, MetadataSample/createMetadataCmd.h, MetadataSample/metadataBase.h, motionTraceCmd/motionTraceCmd.cpp, narrowPolyViewer/narrowPolyViewer.h, objExport/objExport.cpp, OpenGLViewportRenderer/OpenGLViewportRenderer.cpp, polyRawExporter/polyWriter.h, polyX3DExporter/polyWriter.h, randomizerDevice/randomizerDevice.cpp, sceneAssembly/assemblyReference.cpp, skinClusterWeights/skinClusterWeights.cpp, slopeShader/slopeShaderBehavior.cpp, splitUVCmd/polyModifierCmd.cpp, udpDevice/udpDevice.cpp, xmlAssembly/AssemblyCommand.h, xmlAssembly/AssemblyExporter.cpp, xmlAssembly/AssemblyPreloader.cpp, xmlAssembly/AssemblySceneLoader.cpp, xmlAssembly/AssetGuidManager.cpp, xmlAssembly/AssetGuidManager.h, xmlAssembly/BBoxesRep.h, xmlAssembly/BoundingBoxRep.h, xmlAssembly/CacheRep.h, xmlAssembly/ChildrenRep.cpp, xmlAssembly/ChildrenRep.h, xmlAssembly/FnAssetInstanceUtil.cpp, xmlAssembly/FnAssetInstanceUtil.h, xmlAssembly/XMLRepresentation.cpp, and xmlAssembly/XMLRepresentation.h.

List of all members.

Public Member Functions

  MObjectArray ()
  Default constructor.
  MObjectArray (const MObjectArray &other)
  Copy Constructor.
  MObjectArray (unsigned int initialSize, const MObject &initialValue=MObject::kNullObj)
  Create a new array of MObjects of a specified size and initialize all the elements with the given initial value.
  ~MObjectArray ()
  Class Destructor.
MObjectArray operator= (const MObjectArray &)
  Assignment operator.
const MObject operator[] (unsigned int index) const
  Index operator.
MStatus  set (const MObject &element, unsigned int index)
  Sets the value of the indicated element to the indicated MObject 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 MObject &element, unsigned int index)
  Inserts a new value into the array at the given index.
MStatus  append (const MObject &element)
  Adds a new element to the end of the array.
MStatus  copy (const MObjectArray &source)
  Copy the contents of the source array to this array.
MStatus  clear ()
  Clear the contents of the array.
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.
  MObjectArray (const MObject src[], unsigned int count)
  NO SCRIPT SUPPORT.
MStatus  get (MObject array[]) const
  NO SCRIPT SUPPORT.
MObject operator[] (unsigned int index)
  NO SCRIPT SUPPORT.

Static Public Member Functions

static const char *  className ()
  Returns the name of this class.

Constructor & Destructor Documentation

Default constructor.

The instance is set to contain no elements.

MObjectArray ( const MObjectArray other )

Copy Constructor.

Parameters:
[in] other the array with which to initialize this instance
MObjectArray ( unsigned int  initialSize,
const MObject initialValue = MObject::kNullObj 
)

Create a new array of MObjects 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
MObjectArray ( const MObject  src[],
unsigned int  count 
)

NO SCRIPT SUPPORT.

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

Parameters:
[in] src an array of MObjects
[in] count the number of elements in the src array

Member Function Documentation

MObjectArray & operator= ( const MObjectArray source )

Assignment operator.

Copies the source MObjectArray into the destination.

Parameters:
[in] source Source array to be copied.
Returns:
The destination array.
const MObject & 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 desired element
Returns:
A reference to the indicated element
MStatus set ( const MObject element,
unsigned int  index 
)

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

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:
xmlAssembly/AssemblySceneLoader.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 MObject 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 MObjectArray 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.

Returns:
true MS::kSuccess the operation is successful and MS::kFailure otherwise
Examples:
geometrySurfaceConstraint/geometrySurfaceConstraint.cpp, and slopeShader/slopeShaderBehavior.cpp.
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
Examples:
xmlAssembly/AssetGuidManager.cpp.
unsigned int sizeIncrement ( ) const

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

Returns:
The size increment.
MStatus get ( MObject  array[] ) const

NO SCRIPT SUPPORT.

Copy the elements of the array into the given array of MObjects.

No checking is done to ensure that the destination array of MObjects 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
Examples:
gpuCache/CacheReaderAlembic.cpp.
MObject & 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.

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