#include <MStringArray.h>

Class Description

Array of MStrings data type.

This class implements an array of MStrings. 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:: AbcBullet/AbcBullet.cpp, AbcBullet/MayaTransformCollectionWriter.cpp, AbcBullet/MayaTransformWriter.cpp, AbcBullet/MayaUtility.cpp, AbcExport/AbcExport.cpp, AbcExport/MayaMeshWriter.cpp, AbcExport/MayaUtility.cpp, AbcImport/AbcImport.cpp, AbcImport/AlembicNode.cpp, AbcImport/AlembicNode.h, AbcImport/CreateSceneHelper.cpp, AbcImport/CreateSceneHelper.h, AbcImport/MeshHelper.cpp, AbcImport/NodeIteratorVisitorHelper.cpp, AbcImport/util.cpp, animImportExport/animImportExport.cpp, apiMeshShape/apiMeshGeometryOverride.cpp, atomImportExport/atomAnimLayers.cpp, atomImportExport/atomAnimLayers.h, atomImportExport/atomFileUtils.cpp, atomImportExport/atomImportExport.cpp, atomImportExport/atomNodeNameReplacer.cpp, atomImportExport/atomNodeNameReplacer.h, autoLoader/moduleLogic.cpp, autoLoader/threadData.h, blast2Cmd/blast2Cmd.cpp, blindDataShader/blindDataMesh.cpp, cgFx/cgfxAttrDef.cpp, cgFx/cgfxAttrDef.h, cgFx/cgfxEffectDef.cpp, cgFx/cgfxFindImage.cpp, cgFx/cgfxFindImage.h, cgFx/cgfxProfile.cpp, cgFx/cgfxProfile.h, cgFx/cgfxShaderCmd.cpp, cgFx/cgfxShaderNode.cpp, cgFx/cgfxShaderNode.h, cleanPerFaceAssignment/cleanPerFaceAssignmentCmd.cpp, closestPointOnCurve/closestPointOnCurveCmd.cpp, conditionTest/conditionTest.cpp, convertEdgesToFacesCmd/convertEdgesToFacesCmd.cpp, convertVerticesToEdgesCmd/convertVerticesToEdgesCmd.cpp, convertVerticesToFacesCmd/convertVerticesToFacesCmd.cpp, customPrimitiveGenerator/customPrimitiveGenerator.cpp, customSpriteShader/customSpriteShader.cpp, customTextureShader/customTextureShaderOverride.cpp, cvExpandCmd/cvExpandCmd.cpp, D3DViewportRenderer/D3DResourceManager.cpp, D3DViewportRenderer/D3DResourceManager.h, D3DViewportRenderer/D3DViewportRenderer.cpp, ddsFloatReader.cpp, dx11Shader/dx11Shader.cpp, dx11Shader/dx11Shader.h, dx11Shader/dx11ShaderCmd.cpp, dx11Shader/dx11ShaderCompileHelper.cpp, dx11Shader/dx11ShaderOverride.cpp, dx11Shader/dx11ShaderStrings.cpp, dx11Shader/dx11ShaderStrings.h, dx11Shader/dx11ShaderUniformParamBuilder.cpp, eventTest/eventTest.cpp, externalDropCallback/externalDropCallback.cpp, filteredAsciiFile/filteredAsciiFile.cpp, fragmentDumper/fragmentDumper.cpp, glslShader/GLSLShader.cpp, glslShader/GLSLShader.h, glslShader/GLSLShaderCmd.cpp, glslShader/GLSLShaderStrings.cpp, glslShader/GLSLShaderStrings.h, gpuCache/CacheReaderAlembic.cpp, gpuCache/gpuCacheCmd.cpp, gpuCache/gpuCacheCmd.h, gpuCache/gpuCacheDrawOverride.cpp, gpuCache/gpuCacheShapeNode.cpp, gpuCache/gpuCacheShapeNode.h, gpuCache/gpuCacheSubSceneOverride.cpp, gpuCache/gpuCacheUtil.h, gpuCache/gpuCacheVramQuery.cpp, hlslShader/hlslShader.cpp, hlslShader/hlslShader.h, hwApiTextureTest/hwApiTextureTest.cpp, hwColorPerVertexShader/hwColorPerVertexShader.cpp, hwPhongShader/hwPhongShader.cpp, hwPhongShader/hwPhongShader.h, hwReflectBumpShader_NV20/hwReflectBumpShader_NV20.cpp, hwRefractReflectShader_NV20/hwRefractReflectShader_NV20.cpp, identityNode/identityNode.cpp, lensDistortionCallback/lensDistortionCallback.cpp, lensDistortionCallback/lensDistortionCallback.h, lepTranslator/lepTranslator.cpp, lineManipContainer/lineManipContainer.cpp, lockEvent/lockEvent.cpp, manipOverride/manipOverride.cpp, maTranslator/maTranslator.cpp, narrowPolyViewer/narrowPolyViewer.cpp, narrowPolyViewer/narrowPolyViewer.h, nodeCreatedCBCmd/nodeCreatedCBCmd.cpp, nodeCreatedCBCmd/nodeCreatedCBCmd.h, objExport/objExport.cpp, offsetNode/offsetNode.cpp, OpenEXR.cpp, peltOverlapCmd/peltOverlapCmd.cpp, pluginCallbacks/pluginCallbacks.cpp, polyRawExporter/polyRawWriter.cpp, qtForms.cpp, rawfootPrintNode/rawfootPrintNode.cpp, referenceQueryCmd/referenceQueryCmd.cpp, sceneAssembly/adskRepresentationCmd.cpp, sceneAssembly/adskRepresentations.cpp, sceneAssembly/adskSceneMetadataCmd.cpp, sceneAssembly/assemblyDefinition.cpp, sceneAssembly/assemblyDefinition.h, sceneAssembly/assemblyReference.cpp, sceneAssembly/assemblyReference.h, sceneAssembly/assemblyReferenceInitialRep.cpp, simpleImageFile/simpleImageFile.cpp, skinClusterWeights/skinClusterWeights.cpp, squareScaleManipContext/squareScaleManipContext.cpp, swissArmyManip/swissArmyManip.cpp, testCameraSetCmd/testCameraSetCmd.cpp, tiffFloatReader.cpp, udpDevice/udpDevice.cpp, uiDrawManager/uiDrawManager.cpp, vertexBufferGenerator/vertexBufferGenerator.cpp, viewRenderOverride/viewRenderOverrideOperations.cpp, viewRenderOverride/viewRenderOverrideUserOperation.cpp, viewRenderOverridePointLightShadows/viewRenderOverridePointLightShadows.cpp, viewRenderOverrideShadows/viewRenderOverrideShadows.cpp, viewRenderOverrideTargets/viewRenderOverrideTargets.cpp, vp2BlinnShader/vp2BlinnShader.cpp, whatisCmd/whatisCmd.cpp, XmlGeometryCache/XmlGeometryCache.cpp, and XmlGeometryCacheDesc/XmlGeometryCacheDesc.cpp.

Public Member Functions
	MStringArray ()
	Default constructor. More...

	MStringArray (const MStringArray &other)
	Copy constructor. More...

	MStringArray (const MString strings[], unsigned int count)
	Create a new array of MStrings and initialize it with the given elements. More...

	MStringArray (const char *strings[], unsigned int count)
	Create a new array of MStrings and initialize it with the given elements. More...

	MStringArray (unsigned int initialSize, const MString &initialValue)
	Create a new array of strings of a specified size and initialize all the elements with the given initial value. More...

	~MStringArray ()
	The class destructor.

MString	operator[] (unsigned int index) const
	Index operator. More...

MStringArray &	operator= (const MStringArray &other)
	Assignment operator copies all of the elements of the other array into this one. More...

MStatus	set (const MString &element, unsigned int index)
	Sets the value of the indicated element to the indicated value. More...

MStatus	set (char *element, unsigned int index)
	Sets the value of the indicated element to the indicated char* value. More...

MStatus	setLength (unsigned int length)
	Set the length of the array. More...

unsigned int	length () const
	Returns the number of elements in the instance. More...

MStatus	remove (unsigned int index)
	Remove the array element at the given index. More...

MStatus	insert (const MString &element, unsigned int index)
	Inserts a new value into the array at the given index. More...

MStatus	append (const MString &element)
	Adds a new element to the end of the array. More...

MStatus	clear ()
	Clear the contents of the array. More...

MStatus	get (MString array[]) const
	Copy the elements of the array into the array of MStrings. More...

MStatus	get (char *array[]) const
	Copy the elements of the array into the C++ array of character pointers. More...

int	indexOf (const MString &element) const
	Get the location of the string in the array. More...

void	setSizeIncrement (unsigned int newIncrement)
	Set the size by which the array will be expanded whenever expansion is necessary. More...

unsigned int	sizeIncrement () const
	Return the size by which the array will be expanded whenever expansion is necessary. More...

MString &	operator[] (unsigned int index)
	NO SCRIPT SUPPORT. More...

Static Public Member Functions
static const char *	className ()
	Returns the name of this class. More...

Friends
class	MString

OPENMAYA_EXPORT std::ostream &	operator<< (std::ostream &os, const MStringArray &array)
	NO SCRIPT SUPPORT. More...

Constructor & Destructor Documentation

OPENMAYA_MAJOR_NAMESPACE_OPEN MStringArray ( )

Default constructor.

The instance is set to contain no elements.

MStringArray ( const MStringArray & other )

Copy constructor.

Parameters

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

MStringArray	(	const MString	src[],
		unsigned int	count
	)

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

Parameters

[in]	src	an array of MStrings
[in]	count	the number of elements in the src array

MStringArray	(	const char *	src[],
		unsigned int	count
	)

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

The MStringArray object then owns the character strings and it is responsible for freeing them. The user is responsible for freeing the original array of pointers to type char.

Parameters

[in]	src	a C++ array of character pointers
[in]	count	the number of elements in the array

MStringArray	(	unsigned int	initialSize,
		const MString &	initialValue
	)

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

MString operator[] ( unsigned int index ) const

Index operator.

Returns the value of the element at the given index. If the index is out of the range 0 - length()-1, returns a NULL string.

Parameters

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

Returns: The value of the indicated element.

MStringArray & operator= ( const MStringArray & 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 MFnStringArrayData::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	(	const MString &	element,
		unsigned int	index
	)

Sets the value of the indicated element to the indicated 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 operation succeeded
MS::kInvalidParameter index out of range
MS::kFailure operation failed

Examples:: AbcBullet/MayaTransformCollectionWriter.cpp, and AbcExport/MayaMeshWriter.cpp.

MStatus set	(	char *	element,
		unsigned int	index
	)

Sets the value of the indicated element to the indicated char* 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 operation succeeded
MS::kInvalidParameter index out of range
MS::kFailure operation failed

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/NodeIteratorVisitorHelper.cpp, and cgFx/cgfxShaderNode.cpp.

unsigned int length ( ) const

Returns the number of elements in the instance.

Returns: The number of elements in the instance

Examples:: AbcBullet/AbcBullet.cpp, AbcBullet/MayaTransformCollectionWriter.cpp, AbcBullet/MayaUtility.cpp, AbcExport/AbcExport.cpp, AbcExport/MayaMeshWriter.cpp, AbcExport/MayaUtility.cpp, AbcImport/AbcImport.cpp, AbcImport/CreateSceneHelper.cpp, AbcImport/MeshHelper.cpp, AbcImport/util.cpp, animImportExport/animImportExport.cpp, apiMeshShape/apiMeshGeometryOverride.cpp, atomImportExport/atomAnimLayers.cpp, atomImportExport/atomFileUtils.cpp, atomImportExport/atomImportExport.cpp, atomImportExport/atomNodeNameReplacer.cpp, autoLoader/moduleLogic.cpp, blast2Cmd/blast2Cmd.cpp, cgFx/cgfxAttrDef.cpp, cgFx/cgfxEffectDef.cpp, cgFx/cgfxShaderNode.cpp, conditionTest/conditionTest.cpp, customSpriteShader/customSpriteShader.cpp, customTextureShader/customTextureShaderOverride.cpp, D3DViewportRenderer/D3DResourceManager.cpp, D3DViewportRenderer/D3DViewportRenderer.cpp, dx11Shader/dx11Shader.cpp, dx11Shader/dx11Shader.h, dx11Shader/dx11ShaderOverride.cpp, dx11Shader/dx11ShaderUniformParamBuilder.cpp, eventTest/eventTest.cpp, externalDropCallback/externalDropCallback.cpp, filteredAsciiFile/filteredAsciiFile.cpp, glslShader/GLSLShader.cpp, gpuCache/CacheReaderAlembic.cpp, gpuCache/gpuCacheCmd.cpp, gpuCache/gpuCacheDrawOverride.cpp, gpuCache/gpuCacheShapeNode.cpp, gpuCache/gpuCacheSubSceneOverride.cpp, gpuCache/gpuCacheUtil.h, gpuCache/gpuCacheVramQuery.cpp, hlslShader/hlslShader.cpp, hwApiTextureTest/hwApiTextureTest.cpp, hwPhongShader/hwPhongShader.cpp, lepTranslator/lepTranslator.cpp, lockEvent/lockEvent.cpp, manipOverride/manipOverride.cpp, maTranslator/maTranslator.cpp, nodeCreatedCBCmd/nodeCreatedCBCmd.cpp, objExport/objExport.cpp, peltOverlapCmd/peltOverlapCmd.cpp, pluginCallbacks/pluginCallbacks.cpp, polyRawExporter/polyRawWriter.cpp, rawfootPrintNode/rawfootPrintNode.cpp, referenceQueryCmd/referenceQueryCmd.cpp, sceneAssembly/adskRepresentationCmd.cpp, sceneAssembly/adskRepresentations.cpp, sceneAssembly/assemblyDefinition.cpp, sceneAssembly/assemblyReference.cpp, skinClusterWeights/skinClusterWeights.cpp, swissArmyManip/swissArmyManip.cpp, udpDevice/udpDevice.cpp, viewRenderOverride/viewRenderOverrideOperations.cpp, viewRenderOverride/viewRenderOverrideUserOperation.cpp, viewRenderOverridePointLightShadows/viewRenderOverridePointLightShadows.cpp, viewRenderOverrideShadows/viewRenderOverrideShadows.cpp, viewRenderOverrideTargets/viewRenderOverrideTargets.cpp, vp2BlinnShader/vp2BlinnShader.cpp, whatisCmd/whatisCmd.cpp, XmlGeometryCache/XmlGeometryCache.cpp, and XmlGeometryCacheDesc/XmlGeometryCacheDesc.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 operation succeeded
MS::kInvalidParameter index out of range
MS::kFailure operation failed

Examples:: atomImportExport/atomFileUtils.cpp, cleanPerFaceAssignment/cleanPerFaceAssignmentCmd.cpp, dx11Shader/dx11Shader.cpp, eventTest/eventTest.cpp, gpuCache/gpuCacheUtil.h, and nodeCreatedCBCmd/nodeCreatedCBCmd.cpp.

MStatus insert	(	const MString &	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:: atomImportExport/atomFileUtils.cpp, dx11Shader/dx11Shader.cpp, dx11Shader/dx11ShaderUniformParamBuilder.cpp, glslShader/GLSLShader.cpp, hlslShader/hlslShader.cpp, and sceneAssembly/assemblyReference.cpp.

MStatus append ( const MString & 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:: AbcBullet/AbcBullet.cpp, AbcExport/AbcExport.cpp, AbcImport/AlembicNode.cpp, AbcImport/MeshHelper.cpp, AbcImport/NodeIteratorVisitorHelper.cpp, atomImportExport/atomAnimLayers.cpp, blindDataShader/blindDataMesh.cpp, cgFx/cgfxAttrDef.cpp, cgFx/cgfxEffectDef.cpp, cgFx/cgfxFindImage.cpp, cgFx/cgfxProfile.cpp, cgFx/cgfxShaderCmd.cpp, cgFx/cgfxShaderNode.cpp, cleanPerFaceAssignment/cleanPerFaceAssignmentCmd.cpp, D3DViewportRenderer/D3DResourceManager.cpp, ddsFloatReader.cpp, dx11Shader/dx11Shader.cpp, dx11Shader/dx11ShaderCmd.cpp, dx11Shader/dx11ShaderCompileHelper.cpp, dx11Shader/dx11ShaderStrings.cpp, dx11Shader/dx11ShaderUniformParamBuilder.cpp, glslShader/GLSLShader.cpp, glslShader/GLSLShaderCmd.cpp, glslShader/GLSLShaderStrings.cpp, gpuCache/gpuCacheCmd.cpp, gpuCache/gpuCacheShapeNode.cpp, hlslShader/hlslShader.cpp, hwApiTextureTest/hwApiTextureTest.cpp, hwReflectBumpShader_NV20/hwReflectBumpShader_NV20.cpp, hwRefractReflectShader_NV20/hwRefractReflectShader_NV20.cpp, lensDistortionCallback/lensDistortionCallback.cpp, lineManipContainer/lineManipContainer.cpp, maTranslator/maTranslator.cpp, nodeCreatedCBCmd/nodeCreatedCBCmd.cpp, objExport/objExport.cpp, OpenEXR.cpp, sceneAssembly/assemblyDefinition.cpp, simpleImageFile/simpleImageFile.cpp, squareScaleManipContext/squareScaleManipContext.cpp, tiffFloatReader.cpp, vertexBufferGenerator/vertexBufferGenerator.cpp, XmlGeometryCache/XmlGeometryCache.cpp, and XmlGeometryCacheDesc/XmlGeometryCacheDesc.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

Examples:: animImportExport/animImportExport.cpp, atomImportExport/atomImportExport.cpp, cgFx/cgfxAttrDef.cpp, cgFx/cgfxShaderNode.cpp, conditionTest/conditionTest.cpp, D3DViewportRenderer/D3DResourceManager.cpp, eventTest/eventTest.cpp, filteredAsciiFile/filteredAsciiFile.cpp, lensDistortionCallback/lensDistortionCallback.cpp, lepTranslator/lepTranslator.cpp, maTranslator/maTranslator.cpp, nodeCreatedCBCmd/nodeCreatedCBCmd.cpp, objExport/objExport.cpp, XmlGeometryCache/XmlGeometryCache.cpp, and XmlGeometryCacheDesc/XmlGeometryCacheDesc.cpp.

MStatus get ( MString array[] ) const

Copy the elements of the array into the array of MStrings.

No checking is done to ensure that the destination array of MStrings 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:: AbcImport/NodeIteratorVisitorHelper.cpp.

MStatus get ( char * array[] ) const

Copy the elements of the array into the C++ array of character pointers.

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

int indexOf ( const MString & element ) const

Get the location of the string in the array.

Parameters

[in] element the string to locate

Returns: the index of the first occurrence of the string in the array or -1 if not found.

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.

MString & 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. If the index is outside the range 0 - length()-1, returns a NULL string.

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 MStringArray &	array
	)

friend

NO SCRIPT SUPPORT.

The format used is ["string", "string", "string", ... "string"].

Parameters

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

MStringArray.h
MStringArray.cpp

MStringArray Class Reference

Class Description

Public Member Functions

Static Public Member Functions

Friends

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation