MSelectionMask Class Reference
#include <MSelectionMask.h>
Manage what is selectable in Maya. (OpenMaya) (OpenMaya.py)
Selection masks provide a way to control what is selectable in Maya.
Selection masks can be created by OR'ing several types together, or by using the addMask method to add a selection type to an MSelectionMask .
Example - to set the object selection mask to nurbsSurfaces, nurbsCurves, cameras, and lights
apiDirectionalLightShape/apiDirectionalLightShape.cpp , apiDirectionalLightShape/apiDirectionalLightShape.h , apiMeshShape/apiMeshGeometryOverride.cpp , apiMeshShape/apiMeshShape.cpp , apiMeshShape/apiMeshShape.h , apiMeshShape/apiMeshShapeUI.cpp , apiMeshShape/apiMeshSubSceneOverride.cpp , footPrintNode_GeometryOverride/footPrintNode_GeometryOverride.cpp , footPrintNode_SubSceneOverride/footPrintNode_SubSceneOverride.cpp , gpuCache/gpuCacheShapeNode.cpp , gpuCache/gpuCacheShapeNode.h , gpuCache/gpuCacheSubSceneOverride.cpp , grabUVMain.cpp , and quadricShape/quadricShape.cpp .
enum SelectionType {
kSelectHandles ,
kSelectLocalAxis ,
kSelectIkHandles ,
kSelectIkEndEffectors ,
kSelectJoints ,
kSelectLights ,
kSelectCameras ,
kSelectLattices ,
kSelectClusters ,
kSelectSculpts ,
kSelectNurbsCurves ,
kSelectNurbsSurfaces ,
kSelectMeshes ,
kSelectSubdiv ,
kSelectSketchPlanes ,
kSelectParticleShapes ,
kSelectEmitters ,
kSelectFields ,
kSelectSprings ,
kSelectRigidBodies ,
kSelectRigidConstraints ,
kSelectCollisionModels ,
kSelectXYZLocators ,
kSelectOrientationLocators ,
kSelectUVLocators ,
kSelectTextures ,
kSelectCurves ,
kSelectSurfaces ,
kSelectLocators ,
kSelectObjectsMask ,
kSelectCVs ,
kSelectHulls ,
kSelectEditPoints ,
kSelectMeshVerts ,
kSelectMeshEdges ,
kSelectMeshFreeEdges ,
kSelectMeshFaces ,
kSelectSubdivMeshPoints ,
kSelectSubdivMeshEdges ,
kSelectSubdivMeshFaces ,
kSelectMeshUVs ,
kSelectVertices ,
kSelectEdges ,
kSelectFacets ,
kSelectMeshLines ,
kSelectMeshComponents ,
kSelectCurveParmPoints ,
kSelectCurveKnots ,
kSelectSurfaceParmPoints ,
kSelectSurfaceKnots ,
kSelectSurfaceRange ,
kSelectSurfaceEdge ,
kSelectIsoparms ,
kSelectCurvesOnSurfaces ,
kSelectPPStrokes ,
kSelectLatticePoints ,
kSelectParticles ,
kSelectJointPivots ,
kSelectScalePivots ,
kSelectRotatePivots ,
kSelectPivots ,
kSelectSelectHandles ,
kSelectComponentsMask ,
kSelectAnimCurves ,
kSelectAnimKeyframes ,
kSelectAnimInTangents ,
kSelectAnimOutTangents ,
kSelectAnimMask ,
kSelectAnimAny ,
kSelectTemplates ,
kSelectManipulators ,
kSelectGuideLines ,
kSelectPointsForGravity ,
kSelectPointsOnCurvesForGravity ,
kSelectPointsOnSurfacesForGravity ,
kSelectObjectGroups ,
kSelectSubdivMeshMaps ,
kSelectFluids ,
kSelectHairSystems ,
kSelectFollicles ,
kSelectNCloths ,
kSelectNRigids ,
kSelectDynamicConstraints ,
kSelectNParticles
} Types of objects which can be selected. More...
Types of objects which can be selected.
Enumerator kSelectHandles
kSelectLocalAxis
kSelectIkHandles
kSelectIkEndEffectors
kSelectJoints
kSelectLights
kSelectCameras
kSelectLattices
kSelectClusters
kSelectSculpts
kSelectNurbsCurves
kSelectNurbsSurfaces
kSelectMeshes
kSelectSubdiv
kSelectSketchPlanes
kSelectParticleShapes
kSelectEmitters
kSelectFields
kSelectSprings
kSelectRigidBodies
kSelectRigidConstraints
kSelectCollisionModels
kSelectXYZLocators
kSelectOrientationLocators
kSelectUVLocators
kSelectTextures
kSelectCurves
kSelectSurfaces
kSelectLocators
kSelectObjectsMask
kSelectCVs
kSelectHulls
kSelectEditPoints
kSelectMeshVerts
kSelectMeshEdges
kSelectMeshFreeEdges
kSelectMeshFaces
kSelectSubdivMeshPoints
kSelectSubdivMeshEdges
kSelectSubdivMeshFaces
kSelectMeshUVs
kSelectVertices
kSelectEdges
kSelectFacets
kSelectMeshLines
kSelectMeshComponents
kSelectCurveParmPoints
kSelectCurveKnots
kSelectSurfaceParmPoints
kSelectSurfaceKnots
kSelectSurfaceRange
kSelectSurfaceEdge
kSelectIsoparms
kSelectCurvesOnSurfaces
kSelectPPStrokes
kSelectLatticePoints
kSelectParticles
kSelectJointPivots
kSelectScalePivots
kSelectRotatePivots
kSelectPivots
kSelectSelectHandles
kSelectComponentsMask
kSelectAnimCurves
kSelectAnimKeyframes
kSelectAnimInTangents
kSelectAnimOutTangents
kSelectAnimMask
kSelectAnimAny
kSelectTemplates
kSelectManipulators
kSelectGuideLines
kSelectPointsForGravity
kSelectPointsOnCurvesForGravity
kSelectPointsOnSurfacesForGravity
kSelectObjectGroups
kSelectSubdivMeshMaps
kSelectFluids
kSelectHairSystems
kSelectFollicles
kSelectNCloths
kSelectNRigids
kSelectDynamicConstraints
kSelectNParticles
Constructor.
Creates an empty selection mask.
Constructor.
Creates a selection mask of the specified type.
Parameters
[in] selType the selection type of this mask
Constructor.
Creates a selection mask of the specified type.
Parameters
[in] selTypeName name of the selection type
Copy constructor.
Duplicates the given mask
Parameters
Class destructor.
Removes the selection mask.
Sets the selection mask to the specified selection type.
Parameters
[in] selType the selection type to be set
Returns
Sets the selection type for this mask to the selection type of the specified mask.
Parameters
[in] mask the mask with the selection type to be set
Returns
Add the specified selection type to this mask.
Parameters
[in] selType the selection type to add
Returns
Returns true if the specified selection type is contained within this selection mask.
Parameters
[in] selType the selection type to test
[out] ReturnStatus status code
Returns
true the specified selection type is contained in this mask
false the specified selection type is not in this mask
Status Codes:
Returns true if the specified selection mask is contained within this selection mask.
Parameters
[in] mask the selection mask to test
[out] ReturnStatus status code
Returns
true the specified selection mask is contained in this mask
false the specified selection mask is not in this mask
Status Codes:
Add the specified selection type to this mask.
Parameters
[in] selType the selection type to add
Returns The new mask
Add the selection type of the specified mask to this mask.
Parameters
[in] mask the mask containing the selection type to add
Returns The new mask
Assignment operator.
Parameters
[in] other the mask to be copied
Returns A reference to the copied mask
bool registerSelectionType
(
const MString &
selTypeName ,
int
priority = 0
)
static
Registers a new selection type.
It is perfectly legal for 2 plug-ins to register the same selection type. Currently we use the registration count. The selection type is deleted only when deregisterSelectionType() as been called the same number of times as this function - registerSelectionType() .
When registerSelectionType() is invoked and the selection type already exists,we neither enable it nor change its priority, just add its registration count by 1. The reason is the user might has modified these values after loading the plug-in that has register the selection type the first time.
Parameters
[in] selTypeName Name of the selection type.
[in] priority Priority of the selection type,see 'selectPriority' command.
Returns
true The selection type was successfully registered.
false Failed to register the selection type.
bool deregisterSelectionType
(
const MString &
selTypeName )
static
Unregisters a previously registered selection type.
Parameters
[in] selTypeName Name of the selection type.
Returns
true The selection type was successfully unregistered.
false Failed to unregister the selection type.
int getSelectionTypePriority
(
const MString &
selTypeName )
static
Gets the selection priority corresponding to a given selection type.
Parameters
[in] selTypeName Name of the selection type.
Returns The selection priority corresponding to a given selection type. return -1 if there is no select type named selTypeName.
The documentation for this class was generated from the following files:
MSelectionMask.h
MSelectionMask.cpp