OpenMaya.MSelectionMask Class Reference

Class Description

Selection masks provide a way to control what is selectable in Maya.

Inheritance diagram for OpenMaya.MSelectionMask:

Public Member Functions
	__init__ ()
	addMask ()
	copy ()
	intersects ()
	setMask ()

Static Public Member Functions
	deregisterSelectionType ()
	getSelectionTypePriority ()
	registerSelectionType ()

Static Public Attributes
int	kSelectAnimAny = 68
int	kSelectAnimCurves = 63
int	kSelectAnimInTangents = 65
int	kSelectAnimKeyframes = 64
int	kSelectAnimMask = 67
int	kSelectAnimOutTangents = 66
int	kSelectCVs = 30
int	kSelectCameras = 6
int	kSelectClusters = 8
int	kSelectCollisionModels = 21
int	kSelectComponentsMask = 62
int	kSelectCurveKnots = 47
int	kSelectCurveParmPoints = 46
int	kSelectCurves = 26
int	kSelectCurvesOnSurfaces = 53
int	kSelectDynamicConstraints = 82
int	kSelectEdges = 42
int	kSelectEditPoints = 32
int	kSelectEmitters = 16
int	kSelectFacets = 43
int	kSelectFields = 17
int	kSelectFluids = 77
int	kSelectFollicles = 79
int	kSelectGuideLines = 71
int	kSelectHairSystems = 78
int	kSelectHandles = 0
int	kSelectHulls = 31
int	kSelectIkEndEffectors = 3
int	kSelectIkHandles = 2
int	kSelectIsoparms = 52
int	kSelectJointPivots = 57
int	kSelectJoints = 4
int	kSelectLatticePoints = 55
int	kSelectLattices = 7
int	kSelectLights = 5
int	kSelectLocalAxis = 1
int	kSelectLocators = 28
int	kSelectManipulators = 70
int	kSelectMeshComponents = 45
int	kSelectMeshEdges = 34
int	kSelectMeshFaces = 36
int	kSelectMeshFreeEdges = 35
int	kSelectMeshLines = 44
int	kSelectMeshUVs = 40
int	kSelectMeshVerts = 33
int	kSelectMeshes = 12
int	kSelectNCloths = 80
int	kSelectNParticles = 83
int	kSelectNRigids = 81
int	kSelectNurbsCurves = 10
int	kSelectNurbsSurfaces = 11
int	kSelectObjectGroups = 75
int	kSelectObjectsMask = 29
int	kSelectOrientationLocators = 23
int	kSelectPPStrokes = 54
int	kSelectParticleShapes = 15
int	kSelectParticles = 56
int	kSelectPivots = 60
int	kSelectPointsForGravity = 72
int	kSelectPointsOnCurvesForGravity = 73
int	kSelectPointsOnSurfacesForGravity = 74
int	kSelectRigidBodies = 19
int	kSelectRigidConstraints = 20
int	kSelectRotatePivots = 59
int	kSelectScalePivots = 58
int	kSelectSculpts = 9
int	kSelectSelectHandles = 61
int	kSelectSketchPlanes = 14
int	kSelectSprings = 18
int	kSelectSubdiv = 13
int	kSelectSubdivMeshEdges = 38
int	kSelectSubdivMeshFaces = 39
int	kSelectSubdivMeshMaps = 76
int	kSelectSubdivMeshPoints = 37
int	kSelectSurfaceEdge = 51
int	kSelectSurfaceKnots = 49
int	kSelectSurfaceParmPoints = 48
int	kSelectSurfaceRange = 50
int	kSelectSurfaces = 27
int	kSelectTemplates = 69
int	kSelectTextures = 25
int	kSelectUVLocators = 24
int	kSelectVertices = 41
int	kSelectXYZLocators = 22

Constructor & Destructor Documentation

OpenMaya.MSelectionMask.__init__

(

)

x.__init__(...) initializes x; see help(type(x)) for signature

Member Function Documentation

OpenMaya.MSelectionMask.addMask

(

)

addMask(selType) -> self

Add the specified selection type to this mask.

* selType (int) - the selection type to add.

Valid selection types:
  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
  kSelectComponentsMask
  kSelectAnimCurves
  kSelectAnimKeyframes
  kSelectAnimInTangents
  kSelectAnimOutTangents
  kSelectAnimMask
  kSelectAnimAny
  kSelectTemplates
  kSelectManipulators
  kSelectGuideLines
  kSelectPointsForGravity
  kSelectPointsOnCurvesForGravity
  kSelectPointsOnSurfacesForGravity
  kSelectObjectGroups
  kSelectSubdivMeshMaps
  kSelectFluids
  kSelectHairSystems
  kSelectFollicles
  kSelectNCloths
  kSelectNRigids
  kSelectDynamicConstraints
  kSelectNParticles

OpenMaya.MSelectionMask.copy

(

)

copy(source) -> self

Copy data from source selection mask.

* source (MSelectionMask) - The source selection mask to copy from

OpenMaya.MSelectionMask.deregisterSelectionType ( )

static

deregisterSelectionType(selTypeName) -> bool

Unregisters a previously registered selection type.

* selTypeName (string) - Name of the selection type.

OpenMaya.MSelectionMask.getSelectionTypePriority ( )

static

getSelectionTypePriority(selTypeName) -> int

Gets the selection priority corresponding to a given selection type.

* selTypeName (string) - Name of the selection type.

OpenMaya.MSelectionMask.intersects

(

)

intersects(mask) -> bool
intersects(selType) -> bool

Returns True if the specified selection mask or selection type is contained within this selection mask.

* mask (MSelectionMask) - the selection mask to test.
* selType (int) - the selection type to test.  See addMask() for a list of valid selection masks.

OpenMaya.MSelectionMask.registerSelectionType ( )

static

registerSelectionType(selTypeName, priority=0) -> bool

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.

* selTypeName (string) - Name of the selection type.
* priority (int) - Priority of the selection type.

OpenMaya.MSelectionMask.setMask

(

)

setMask(mask) -> self
setMask(selType) -> self

Sets the selection mask to the specified selection mask or selection type.

* mask (MSelectionMask) - the selection mask to be set.
* selType (int) - the selection type to be set.  See addMask() for a list of valid selection masks.