MArgList Class Reference
 
 
 

#include <MArgList.h>


Class Description

Create and retrieve argument lists.

This class is used to create and retrieve argument lists that can be passed to API class methods that require arglists.

Do not use MArgList to parse flags for a plug-in command as the flags will not work if the command is called from Python. Use MArgParser or MArgDatabase instead.

Examples:

AbcExport/AbcExport.cpp, AbcExport/AbcExport.h, AbcImport/AbcImport.cpp, AbcImport/AbcImport.h, animExportUtil/animFileExport.h, animImportExport/animFileUtils.h, animImportExport/animImportExport.h, animInfoCmd/animInfoCmd.cpp, apiMeshShape/apiMeshData.cpp, apiMeshShape/apiMeshData.h, AshliShader/fxManagerCmd.cpp, atomImportExport/atomFileUtils.h, atomImportExport/atomImportExport.h, blindComplexDataCmd/blindComplexDataCmd.cpp, blindDoubleDataCmd/blindDoubleDataCmd.cpp, blindShortDataCmd/blindShortDataCmd.cpp, cameraSetSubclass/testExCameraSetCmd.cpp, cameraSetSubclass/testExCameraSetCmd.h, cgfxShaderCmd.cpp, cgfxShaderCmd.h, cleanPerFaceAssignment/cleanPerFaceAssignmentCmd.cpp, cleanPerFaceAssignment/cleanPerFaceAssignmentCmd.h, closestPointCmd/closestPointCmd.cpp, closestPointOnCurve/closestPointOnCurveCmd.cpp, closestPointOnCurve/closestPointOnCurveCmd.h, closestPointOnNurbsSurfaceCmd/closestPointOnNurbsSurfaceCmd.cpp, closestPointOnNurbsSurfaceCmd/closestPointOnNurbsSurfaceCmd.h, clothPaintAttrCmd/clothPaintAttrCmd.cpp, clothPaintAttrCmd/clothPaintAttrCmd.h, clusterWeightFunction/clusterWeightFunction.cpp, conditionTest/conditionTest.cpp, convertBumpCmd/convertBumpCmd.cpp, convertEdgesToFacesCmd/convertEdgesToFacesCmd.cpp, convertVerticesToEdgesCmd/convertVerticesToEdgesCmd.cpp, convertVerticesToFacesCmd/convertVerticesToFacesCmd.cpp, createClipCmd/createClipCmd.cpp, cvExpandCmd/cvExpandCmd.cpp, cvPosCmd/cvPosCmd.cpp, dagMessageCmd/dagMessageCmd.cpp, dagPoseInfoCmd/dagPoseInfoCmd.cpp, deletedMsgCmd/deletedMsgCmd.cpp, dx11Shader/dx11ShaderCmd.cpp, dx11Shader/dx11ShaderCmd.h, eventTest/eventTest.cpp, exampleCameraSetView/exampleCameraSetViewCmd.h, exportJointClusterDataCmd/exportJointClusterDataCmd.cpp, exportSkinClusterDataCmd/exportSkinClusterDataCmd.cpp, fileIOMsgCmd/fileIOMsgCmd.cpp, filteredAsciiFile/filteredAsciiFile.cpp, findFileTexturesCmd/findFileTexturesCmd.cpp, findTexturesPerPolygonCmd/findTexturesPerPolygonCmd.cpp, fluidInfoCmd/fluidInfoCmd.cpp, fxManagerCmd.h, geometryCacheConverter/geometryCacheConverter.cpp, geometrySurfaceConstraint/geometrySurfaceConstraint.cpp, geometrySurfaceConstraint/geometrySurfaceConstraint.h, getAttrAffectsCmd/getAttrAffectsCmd.cpp, gpuCache/gpuCacheCmd.cpp, gpuCache/gpuCacheCmd.h, helix2Cmd/helix2Cmd.cpp, helixCmd/helixCmd.cpp, helixQtCmd.cpp, helixQtCmd.h, helixTool/helixTool.cpp, helloCmd/helloCmd.cpp, helloWorldCmd/helloWorldCmd.cpp, hlslShader/hlslShader.cpp, hlslShader/hlslShader.h, hwApiTextureTest/hwApiTextureTest.cpp, iffInfoCmd/iffInfoCmd.cpp, iffPixelCmd/iffPixelCmd.cpp, iffPpmCmd/iffPpmCmd.cpp, instanceCallbackCmd/instanceCallbackCmd.cpp, instancerListCmd/instancerListCmd.cpp, intersectCmd/intersectCmd.cpp, intersectOnNurbsSurfaceCmd/intersectOnNurbsSurfaceCmd.cpp, intersectOnNurbsSurfaceCmd/intersectOnNurbsSurfaceCmd.h, latticeNoise/latticeNoise.h, latticeNoise/latticeNoiseCmd.cpp, lensDistortionCallback/lensDistortionCallback.cpp, lensDistortionCallback/lensDistortionCallback.h, listLightLinksCmd/listLightLinksCmd.cpp, listPolyHolesCmd/listPolyHolesCmd.cpp, listRichSelectionCmd/listRichSelectionCmd.cpp, lockEvent/lockEvent.cpp, manipOverride/customTriadManip.h, manipOverride/manipOverride.cpp, meshOpCmd/meshOpCmd.cpp, meshOpCmd/meshOpCmd.h, meshReorder/meshRemapCmd.cpp, meshReorder/meshRemapCmd.h, meshReorder/meshReorderCmd.cpp, meshReorder/meshReorderCmd.h, MetadataSample/createMetadataCmd.cpp, MetadataSample/createMetadataCmd.h, MetadataSample/metadataBase.cpp, MetadataSample/metadataBase.h, motionPathCmd/motionPathCmd.cpp, motionTraceCmd/motionTraceCmd.cpp, moveCurveCVsCmd/moveCurveCVsCmd.cpp, moveNumericTool/moveNumericTool.cpp, moveTool/moveTool.cpp, multiPlugInfoCmd/multiPlugInfoCmd.cpp, nodeCreatedCBCmd/nodeCreatedCBCmd.cpp, nodeCreatedCBCmd/nodeCreatedCBCmd.h, nodeIconCmd/nodeIconCmd.cpp, nodeInfoCmd/nodeInfoCmd.cpp, nodeMessageCmd/nodeMessageCmd.cpp, particlePathsCmd/particlePathsCmd.cpp, particleSystemInfoCmd/particleSystemInfoCmd.cpp, peltOverlapCmd/peltOverlapCmd.cpp, pfxInfoCmd/pfxInfoCmd.cpp, pickCmd/pickCmd.cpp, pointOnMeshInfo/pointOnMeshCmd.cpp, pointOnMeshInfo/pointOnMeshCmd.h, polyMessageCmd/polyMessageCmd.cpp, polyPrimitiveCmd/polyPrimitiveCmd.cpp, progressWindowCmd/progressWindowCmd.cpp, qtForms.cpp, qtForms.h, referenceQueryCmd/referenceQueryCmd.cpp, renderViewInteractiveRenderCmd/renderViewInteractiveRenderCmd.cpp, renderViewRenderCmd/renderViewRenderCmd.cpp, renderViewRenderRegionCmd/renderViewRenderRegionCmd.cpp, richMoveCmd/richMoveCmd.cpp, sampleCmd/sampleCmd.cpp, sampleParticles/sampleParticles.cpp, saveSwatchesCmd.cpp, saveSwatchesCmd.h, scanDagCmd/scanDagCmd.cpp, scanDagSyntax/scanDagSyntax.cpp, sceneAssembly/adskRepresentationCmd.cpp, sceneAssembly/adskRepresentationCmd.h, skinClusterWeights/skinClusterWeights.cpp, spiralAnimCurveCmd/spiralAnimCurveCmd.cpp, splitUVCmd/splitUVCmd.cpp, splitUVCmd/splitUVCmd.h, surfaceCreateCmd/surfaceCreateCmd.cpp, surfaceTwistCmd/surfaceTwistCmd.cpp, template/helloTemplateWorld/helloTemplateWorld.cpp, template/zoomCameraTemplate/zoomCameraTemplate.cpp, testCameraSetCmd/testCameraSetCmd.cpp, threadedBoundingBox/threadedBoundingBox.cpp, threadingLockTests/threadingLockTests.cpp, threadTestCmd/threadTestCmd.cpp, threadTestWithLocksCmd/threadTestWithLocksCmd.cpp, translateCmd/translateCmd.cpp, undoRedoMsgCmd/undoRedoMsgCmd.cpp, userMsgCmd/userMsgCmd.cpp, viewCallbackTest/viewCallbackTest.cpp, viewCaptureCmd/viewCaptureCmd.cpp, volumeLightCmd/volumeLightCmd.cpp, whatisCmd/whatisCmd.cpp, xmlAssembly/AssemblyCommand.cpp, xmlAssembly/AssemblyCommand.h, xmlAssembly/XMLGeneratorCommand.cpp, xmlAssembly/XMLGeneratorCommand.h, and zoomCameraCmd/zoomCameraCmd.cpp.

List of all members.

Public Member Functions

  MArgList ()
  The default class constructor.
  MArgList (const MArgList &other)
  The copy constructor.
  ~MArgList ()
  The class destructor.
unsigned int  length (MStatus *ReturnStatus=NULL) const
  Returns the number of arguments in the arglist.
bool  asBool (unsigned int index, MStatus *ret=NULL) const
  Return the value of the argument at a given position in the arglist as an bool.
int  asInt (unsigned int index, MStatus *ret=NULL) const
  Return the value of the argument at a given position in the arglist as an integer.
double  asDouble (unsigned int index, MStatus *ret=NULL) const
  Return the value of the argument at a given position in the arglist as a double.
MString  asString (unsigned int index, MStatus *ret=NULL) const
  Return the value of the argument at a given position in the arglist as an MString.
MDistance  asDistance (unsigned int index, MStatus *ret=NULL) const
  Return the value of the argument at a given position in the arglist as an MDistance.
MAngle  asAngle (unsigned int index, MStatus *ret=NULL) const
  Return the value of the argument at a given position in the arglist as an MAngle.
MTime  asTime (unsigned int index, MStatus *ret=NULL) const
  Return the value of the argument at a given position in the arglist as an MTime.
MVector  asVector (unsigned int &index, unsigned int numElements=3, MStatus *ReturnStatus=NULL) const
  Return the value of the argument at a given position in the arglist as an MVector.
MPoint  asPoint (unsigned int &index, unsigned int numElements=3, MStatus *ReturnStatus=NULL) const
  Return the value of the argument at a given position in the arglist as an MPoint.
MMatrix  asMatrix (unsigned int &index, MStatus *ret=NULL) const
  Get the value of the MMatrix argument at a given position in the arglist.
MIntArray  asIntArray (unsigned int &index, MStatus *ReturnStatus=NULL) const
  Get the value of the MIntArray argument at a given position in the arglist.
MDoubleArray  asDoubleArray (unsigned int &index, MStatus *ReturnStatus=NULL) const
  Get the value of the MDoubleArray argument at a given position in the arglist.
const MStringArray  asStringArray (unsigned int &index, MStatus *ReturnStatus=NULL) const
  Get the value of the MStringArray argument at a given position in the arglist.
MArgList operator= (const MArgList &other)
  The assignment operator.
unsigned int  flagIndex (const char *shortFlag, const char *longFlag=NULL) const
  Return the index entry of the requested flag, if it has been set.
MStatus  addArg (bool arg)
  Add a new bool argument to the arglist.
MStatus  addArg (int arg)
  Add a new integer argument to the arglist.
MStatus  addArg (double arg)
  Add a new double argument to the arglist.
MStatus  addArg (const MString &arg)
  Add a new MString argument to the arglist.
MStatus  addArg (const MDistance &arg)
  Add a new MDistance argument to the arglist.
MStatus  addArg (const MAngle &arg)
  Add a new MAngle argument to the arglist.
MStatus  addArg (const MTime &arg)
  Add a new MTime argument to the arglist.
MStatus  addArg (const MVector &arg)
  Add a new MVector argument to the arglist.
MStatus  addArg (const MPoint &arg)
  Add a new MPoint argument to the arglist.
MStatus  get (unsigned int index, bool &ret) const
  This method is not available in Python.
MStatus  get (unsigned int index, int &ret) const
  This method is not available in Python.
MStatus  get (unsigned int index, double &ret) const
  This method is not available in Python.
MStatus  get (unsigned int index, MString &ret) const
  This method is not available in Python.
MStatus  get (unsigned int index, MDistance &ret) const
  This method is not available in Python.
MStatus  get (unsigned int index, MAngle &ret) const
  This method is not available in Python.
MStatus  get (unsigned int index, MTime &ret) const
  This method is not available in Python.
MStatus  get (unsigned int &index, MVector &ret, unsigned int numElements=3) const
  This method is not available in Python.
MStatus  get (unsigned int &index, MPoint &ret, unsigned int numElements=3) const
  This method is not available in Python.
MStatus  get (unsigned int &index, MMatrix &ret) const
  This method is not available in Python.
MStatus  get (unsigned int &index, MIntArray &ret) const
  This method is not available in Python.
MStatus  get (unsigned int &index, MDoubleArray &ret) const
  This method is not available in Python.
MStatus  get (unsigned int &index, MStringArray &ret) const
  This method is not available in Python.

Static Public Member Functions

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

Friends

OPENMAYA_EXPORT std::ostream &  operator<< (std::ostream &os, const MArgList &args)
  This method is not available in Python.

Constructor & Destructor Documentation

MArgList ( const MArgList other )

The copy constructor.

Initialize a new arglist with the values from another arglist.

Parameters:
[in] other the arglist to copy from.

Member Function Documentation

unsigned int length ( MStatus ReturnStatus = NULL ) const

Returns the number of arguments in the arglist.

Parameters:
[out] ReturnStatus the return status
Returns:
The number of arguments in the arglist.
Status Codes:
Examples:
animInfoCmd/animInfoCmd.cpp, blindComplexDataCmd/blindComplexDataCmd.cpp, blindDoubleDataCmd/blindDoubleDataCmd.cpp, cameraSetSubclass/testExCameraSetCmd.cpp, cgfxShaderCmd.cpp, closestPointCmd/closestPointCmd.cpp, clothPaintAttrCmd/clothPaintAttrCmd.cpp, convertBumpCmd/convertBumpCmd.cpp, createClipCmd/createClipCmd.cpp, cvPosCmd/cvPosCmd.cpp, dagPoseInfoCmd/dagPoseInfoCmd.cpp, exportJointClusterDataCmd/exportJointClusterDataCmd.cpp, exportSkinClusterDataCmd/exportSkinClusterDataCmd.cpp, findFileTexturesCmd/findFileTexturesCmd.cpp, fluidInfoCmd/fluidInfoCmd.cpp, getAttrAffectsCmd/getAttrAffectsCmd.cpp, helix2Cmd/helix2Cmd.cpp, helixCmd/helixCmd.cpp, hwApiTextureTest/hwApiTextureTest.cpp, iffInfoCmd/iffInfoCmd.cpp, iffPixelCmd/iffPixelCmd.cpp, iffPpmCmd/iffPpmCmd.cpp, intersectCmd/intersectCmd.cpp, latticeNoise/latticeNoiseCmd.cpp, lensDistortionCallback/lensDistortionCallback.cpp, listRichSelectionCmd/listRichSelectionCmd.cpp, meshOpCmd/meshOpCmd.cpp, meshReorder/meshRemapCmd.cpp, meshReorder/meshReorderCmd.cpp, motionTraceCmd/motionTraceCmd.cpp, moveNumericTool/moveNumericTool.cpp, moveTool/moveTool.cpp, particleSystemInfoCmd/particleSystemInfoCmd.cpp, pfxInfoCmd/pfxInfoCmd.cpp, pickCmd/pickCmd.cpp, pointOnMeshInfo/pointOnMeshCmd.cpp, polyPrimitiveCmd/polyPrimitiveCmd.cpp, richMoveCmd/richMoveCmd.cpp, sampleCmd/sampleCmd.cpp, sampleParticles/sampleParticles.cpp, saveSwatchesCmd.cpp, scanDagCmd/scanDagCmd.cpp, skinClusterWeights/skinClusterWeights.cpp, testCameraSetCmd/testCameraSetCmd.cpp, threadingLockTests/threadingLockTests.cpp, threadTestCmd/threadTestCmd.cpp, threadTestWithLocksCmd/threadTestWithLocksCmd.cpp, translateCmd/translateCmd.cpp, undoRedoMsgCmd/undoRedoMsgCmd.cpp, viewCallbackTest/viewCallbackTest.cpp, volumeLightCmd/volumeLightCmd.cpp, and whatisCmd/whatisCmd.cpp.
bool asBool ( unsigned int  index,
MStatus ReturnStatus = NULL 
) const

Return the value of the argument at a given position in the arglist as an bool.

Parameters:
[in] index the index of the desired argument
[out] ReturnStatus the return status
Returns:
The bool value of the indicated argument.
Status Codes:
Examples:
cameraSetSubclass/testExCameraSetCmd.cpp, pointOnMeshInfo/pointOnMeshCmd.cpp, testCameraSetCmd/testCameraSetCmd.cpp, and volumeLightCmd/volumeLightCmd.cpp.
int asInt ( unsigned int  index,
MStatus ReturnStatus = NULL 
) const

Return the value of the argument at a given position in the arglist as an integer.

Parameters:
[in] index the index of the desired argument
[out] ReturnStatus the return status
Returns:
The integer value of the indicated argument.
Status Codes:
Examples:
blindComplexDataCmd/blindComplexDataCmd.cpp, cameraSetSubclass/testExCameraSetCmd.cpp, fluidInfoCmd/fluidInfoCmd.cpp, meshOpCmd/meshOpCmd.cpp, pointOnMeshInfo/pointOnMeshCmd.cpp, polyPrimitiveCmd/polyPrimitiveCmd.cpp, sampleCmd/sampleCmd.cpp, sampleParticles/sampleParticles.cpp, testCameraSetCmd/testCameraSetCmd.cpp, threadingLockTests/threadingLockTests.cpp, threadTestCmd/threadTestCmd.cpp, and threadTestWithLocksCmd/threadTestWithLocksCmd.cpp.
double asDouble ( unsigned int  index,
MStatus ReturnStatus = NULL 
) const
MDistance asDistance ( unsigned int  index,
MStatus ReturnStatus = NULL 
) const

Return the value of the argument at a given position in the arglist as an MDistance.

Parameters:
[in] index the index of the desired argument
[out] ReturnStatus the return status
Returns:
The MDistance value of the indicated argument.
Status Codes:
MAngle asAngle ( unsigned int  index,
MStatus ReturnStatus = NULL 
) const

Return the value of the argument at a given position in the arglist as an MAngle.

Parameters:
[in] index the index of the desired argument
[out] ReturnStatus the return status
Returns:
The MAngle value of the indicated argument.
Status Codes:
MTime asTime ( unsigned int  index,
MStatus ReturnStatus = NULL 
) const

Return the value of the argument at a given position in the arglist as an MTime.

Parameters:
[in] index the index of the desired argument
[out] ReturnStatus the return status
Returns:
The MTime value of the indicated argument.
Status Codes:
MVector asVector ( unsigned int &  index,
unsigned int  numElements = 3,
MStatus ReturnStatus = NULL 
) const

Return the value of the argument at a given position in the arglist as an MVector.

Parameters:
[in,out] index index of the first argument to be used as an element of the vector. On success it will be updated to point to the last argument used to build the vector (i.e. incremented by numElements-1). On failure it will be updated to point to the argument where the failure occurred.
[in] numElements dimension of the vector to be returned. This should not exceed 3, which is the maximum number of dimensions that an MVector can hold.
[out] ReturnStatus the return status
Returns:
The MVector value of the indicated argument.
Status Codes:
Examples:
listRichSelectionCmd/listRichSelectionCmd.cpp, moveNumericTool/moveNumericTool.cpp, moveTool/moveTool.cpp, richMoveCmd/richMoveCmd.cpp, and translateCmd/translateCmd.cpp.
MPoint asPoint ( unsigned int &  index,
unsigned int  numElements = 3,
MStatus ReturnStatus = NULL 
) const

Return the value of the argument at a given position in the arglist as an MPoint.

Parameters:
[in,out] index index of the first argument to be used as an element of the point. On success it will be updated to point to the last argument used to build the point (i.e. incremented by numElements-1). On failure it will be updated to point to the argument where the failure occurred.
[in] numElements dimension of the point to be returned. This should not exceed 4, which is the maximum number of dimensions that an MPoint can hold.
[out] ReturnStatus the return status
Returns:
The MPoint value of the indicated argument.
Status Codes:
MMatrix asMatrix ( unsigned int &  index,
MStatus ret = NULL 
) const

Get the value of the MMatrix argument at a given position in the arglist.

Parameters:
[in,out] index index of the first argument to be used in building the matrix. On success it will be updated to point to the last argument used to build the matrix (i.e. it will be incremented by 15). On failure it will be updated to point to the argument where the failure occurred.
[out] ret the return status
Returns:
The MMatrix value of the indicated argument.
Status Codes:
MIntArray asIntArray ( unsigned int &  index,
MStatus ReturnStatus = NULL 
) const

Get the value of the MIntArray argument at a given position in the arglist.

Parameters:
[in,out] index index of the first argument to be used in building the array. That argument will be taken as an integer count of the number of array elements which follow it. On success the index will be updated to point to the argument for the last array element (i.e. incremented by the number of elements). On failure it will be updated to point to the argument where the failure occurred.
[out] ReturnStatus API status code
Returns:
MIntArray
MDoubleArray asDoubleArray ( unsigned int &  index,
MStatus ReturnStatus = NULL 
) const

Get the value of the MDoubleArray argument at a given position in the arglist.

Parameters:
[in,out] index index of the first argument to be used in building the array. That argument will be taken as an integer count of the number of array elements which follow it. On success the index will be updated to point to the argument for the last array element (i.e. incremented by the number of elements). On failure it will be updated to point to the argument where the failure occurred.
[out] ReturnStatus API status code
Returns:
MDoubleArray
Examples:
skinClusterWeights/skinClusterWeights.cpp.
const MStringArray asStringArray ( unsigned int &  index,
MStatus ReturnStatus = NULL 
) const

Get the value of the MStringArray argument at a given position in the arglist.

Parameters:
[in,out] index index of the first argument to be used in building the array. That argument will be taken as an integer count of the number of array elements which follow it. On success the index will be updated to point to the argument for the last array element (i.e. incremented by the number of elements). On failure it will be updated to point to the argument where the failure occurred.
[out] ReturnStatus API status code
Returns:
MStringArray
Examples:
skinClusterWeights/skinClusterWeights.cpp.
MArgList & operator= ( const MArgList other )

The assignment operator.

Allows assignment between MArgList instances.

Parameters:
[in] other The object to copy from.
unsigned int flagIndex ( const char *  shortFlag,
const char *  longFlag = NULL 
) const

Return the index entry of the requested flag, if it has been set.

Parameters:
[in] shortFlag the short version of the flag
[in] longFlag the int version of the flag (if any)
Returns:
The unsigned int index of the indicated argument if it has been set, kInvalidArgIndex otherwise.
Examples:
cameraSetSubclass/testExCameraSetCmd.cpp, and testCameraSetCmd/testCameraSetCmd.cpp.
MStatus addArg ( bool  arg )

Add a new bool argument to the arglist.

Parameters:
[in] arg the new bool argument
Returns:
Examples:
helixTool/helixTool.cpp, listRichSelectionCmd/listRichSelectionCmd.cpp, manipOverride/manipOverride.cpp, moveNumericTool/moveNumericTool.cpp, moveTool/moveTool.cpp, and richMoveCmd/richMoveCmd.cpp.
MStatus addArg ( int  arg )

Add a new integer argument to the arglist.

Parameters:
[in] arg the new integer argument
Returns:
MStatus addArg ( double  arg )

Add a new double argument to the arglist.

Parameters:
[in] arg the new double argument
Returns:
MStatus addArg ( const MString arg )

Add a new MString argument to the arglist.

Parameters:
[in] arg the new MString argument
Returns:
MStatus addArg ( const MDistance arg )

Add a new MDistance argument to the arglist.

Parameters:
[in] arg the new MDistance argument
Returns:
MStatus addArg ( const MAngle arg )

Add a new MAngle argument to the arglist.

Parameters:
[in] arg the new MAngle argument
Returns:
MStatus addArg ( const MTime arg )

Add a new MTime argument to the arglist.

Parameters:
[in] arg the new MTime argument
Returns:
MStatus addArg ( const MVector arg )

Add a new MVector argument to the arglist.

Parameters:
[in] arg the new MVector argument
Returns:
MStatus addArg ( const MPoint arg )

Add a new MPoint argument to the arglist.

Parameters:
[in] arg the new MPoint argument
Returns:
MStatus get ( unsigned int  index,
int &  ret 
) const

This method is not available in Python.

Get the value of the integer argument at a given position in the arglist.

Python Notes

Use asInt() instead.

Parameters:
[in] index the index of the desired argument
[out] ret the integer value is returned in this argument.
Returns:
MStatus get ( unsigned int  index,
double &  ret 
) const

This method is not available in Python.

Get the value of the double argument at a given position in the arglist.

Python Notes

Use asDouble() instead.

Parameters:
[in] index the index of the desired argument
[out] ret the double value is returned in this argument.
Returns:
MStatus get ( unsigned int  index,
MString ret 
) const

This method is not available in Python.

Get the value of the MString argument at a given position in the arglist.

Python Notes

Use asString() instead.

Parameters:
[in] index the index of the desired argument
[out] ret the MString value is returned in this argument.
Returns:
MStatus get ( unsigned int  index,
MDistance ret 
) const

This method is not available in Python.

Get the value of the MDistance argument at a given position in the arglist.

Python Notes

Use asDistance() instead.

Parameters:
[in] index the index of the desired argument
[out] ret the MDistance value is returned in this argument.
Returns:
MStatus get ( unsigned int  index,
MAngle ret 
) const

This method is not available in Python.

Get the value of the MAngle argument at a given position in the arglist.

Python Notes

Use asAngle() instead.

Parameters:
[in] index the index of the desired argument
[out] ret the MAngle value is returned in this argument.
Returns:
MStatus get ( unsigned int  index,
MTime ret 
) const

This method is not available in Python.

Get the value of the MTime argument at a given position in the arglist.

Python Notes

Use asTime() instead.

Parameters:
[in] index the index of the desired argument
[out] ret the MTime value is returned in this argument.
Returns:
MStatus get ( unsigned int &  index,
MVector ret,
unsigned int  numElements = 3 
) const

This method is not available in Python.

Get the value of the MVector argument at a given position in the arglist.

Python Notes

Use asVector() instead.

Parameters:
[in,out] index index of the first argument to be used as an element of the vector. On success it will be updated to point to the last argument used to build the vector (i.e. incremented by numElements-1). On failure it will be updated to point to the argument where the failure occurred.
[out] ret the MVector value is returned in this argument.
[in] numElements dimension of the vector to be returned. This should not exceed 3, which is the maximum number of dimensions that an MVector can hold.
Returns:
MStatus get ( unsigned int &  index,
MPoint ret,
unsigned int  numElements = 3 
) const

This method is not available in Python.

Get the value of the MPoint argument at a given position in the arglist.

Python Notes

Use asPoint() instead.

Parameters:
[in,out] index index of the first argument to be used as an element of the point. On success it will be updated to point to the last argument used to build the point (i.e. incremented by numElements-1). On failure it will be updated to point to the argument where the failure occurred.
[out] ret the MPoint value is returned in this argument.
[in] numElements dimension of the point to be returned. This should not exceed 4, which is the maximum number of dimensions that an MPoint can hold.
Returns:
MStatus get ( unsigned int &  index,
MMatrix ret 
) const

This method is not available in Python.

Get the value of the MMatrix argument at a given position in the arglist.

Python Notes

Use asMatrix() instead.

Parameters:
[in,out] index index of the first argument to be used in building the matrix. On success it will be updated to point to the last argument used to build the matrix (i.e. it will be incremented by 15). On failure it will be updated to point to the argument where the failure occurred.
[out] ret the MMatrix value is returned in this argument.
Returns:
MStatus get ( unsigned int &  index,
MIntArray ret 
) const

This method is not available in Python.

Get the value of the MIntArray argument at a given position in the arglist.

Python Notes

Use asIntArray() instead.

Parameters:
[in,out] index index of the first argument to be used in building the array. That argument will be taken as an integer count of the number of array elements which follow it. On success the index will be updated to point to the argument for the last array element (i.e. incremented by the number of elements). On failure it will be updated to point to the argument where the failure occurred.
[out] ret the MIntArray value is returned in this argument.
Returns:
MStatus get ( unsigned int &  index,
MDoubleArray ret 
) const

This method is not available in Python.

Get the value of the MDoubleArray argument at a given position in the arglist.

Python Notes

Use asDoubleArray() instead.

Parameters:
[in,out] index index of the first argument to be used in building the array. That argument will be taken as an integer count of the number of array elements which follow it. On success the index will be updated to point to the argument for the last array element (i.e. incremented by the number of elements). On failure it will be updated to point to the argument where the failure occurred.
[out] ret the MDoubleArray value is returned in this argument.
Returns:
MStatus get ( unsigned int &  index,
MStringArray ret 
) const

This method is not available in Python.

Get the value of the MStringArray argument at a given position in the arglist.

Python Notes

Use asStringArray() instead.

Parameters:
[in,out] index index of the first argument to be used in building the array. That argument will be taken as an integer count of the number of array elements which follow it. On success the index will be updated to point to the argument for the last array element (i.e. incremented by the number of elements). On failure it will be updated to point to the argument where the failure occurred.
[out] ret the MStringArray value is returned in this argument.
Returns:
const char * className ( ) [static]

Returns the name of this class.

Returns:
Name of this class.

Friends And Related Function Documentation

OPENMAYA_EXPORT std::ostream& operator<< ( std::ostream &  os,
const MArgList args 
) [friend]

This method is not available in Python.

The output is each string in the list, separated by spaces (and unquoted).

Parameters:
[in] os the ostream to print to
[in] args the MArgList whose contents are to be printed
Returns:
The ostream reference, s, provided as the first parameter.

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