Manage what is selectable in Maya. (OpenMaya) (OpenMaya.py) More...

#include <MSelectionMask.h>

Public Member Functions
	OPENMAYA_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.

	MSelectionMask ()
	Constructor. More...

	MSelectionMask (const MString &selTypeName)
	Constructor. More...

	MSelectionMask (const MSelectionMask &in)
	Copy constructor. More...

virtual	~MSelectionMask ()
	Class destructor. More...

MStatus	setMask (MSelectionMask &mask)
	Sets the selection type for this mask to the selection type of the specified mask. More...

MStatus	addMask (SelectionType selType)
	Add the specified selection type to this mask. More...

bool	intersects (MSelectionMask &mask, MStatus *ReturnStatus=NULL) const
	Returns true if the specified selection mask is contained within this selection mask. More...

MSelectionMask	operator\| (MSelectionMask &mask)
	Add the selection type of the specified mask to this mask. More...

MSelectionMask &	operator= (const MSelectionMask &other)
	Assignment operator. More...

Static Public Member Functions
static bool	registerSelectionType (const MString &selTypeName, int priority=0)
	Registers a new selection type. More...

static bool	deregisterSelectionType (const MString &selTypeName)
	Unregisters a previously registered selection type. More...

static int	getSelectionTypePriority (const MString &selTypeName)
	Gets the selection priority corresponding to a given selection type. More...

Detailed Description

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

MSelectionMask mask( MSelectionMask::kSelectNurbsSurfaces );
mask.addMask( MSelectionMask::kSelectNurbsCurves );
mask = mask | MSelectionMask::kSelectCameras | MSelectionMask::kSelectLights;
MGlobal::setObjectSelectionMask( mask );

Examples:: apiDirectionalLightShape/apiDirectionalLightShape.cpp, apiDirectionalLightShape/apiDirectionalLightShape.h, apiMeshShape/apiMeshGeometryOverride.cpp, apiMeshShape/apiMeshShape.cpp, apiMeshShape/apiMeshShape.h, apiMeshShape/apiMeshShapeUI.cpp, apiMeshShape/apiMeshSubSceneOverride.cpp, footPrintNode_AnimatedMaterial/footPrintNode_GeometryOverride_AnimatedMaterial.cpp, footPrintNode_GeometryOverride/footPrintNode_GeometryOverride.cpp, footPrintNode_SubSceneOverride/footPrintNode_SubSceneOverride.cpp, geometryOverrideExample1/geometryOverrideExample1.cpp, geometryOverrideExample1/geometryOverrideExample1.h, geometryOverrideExample2/geometryOverrideExample2.cpp, geometryOverrideExample2/geometryOverrideExample2.h, gpuCache/gpuCacheShapeNode.cpp, gpuCache/gpuCacheShapeNode.h, gpuCache/gpuCacheSubSceneOverride.cpp, grabUVMain.cpp, and tessellatedQuad/TessellatedQuadGeomOverride.cpp.

Constructor & Destructor Documentation

OPENMAYA_MAJOR_NAMESPACE_OPEN MSelectionMask ( )

Constructor.

Creates an empty selection mask.

MSelectionMask ( const MString & selTypeName )

Constructor.

Creates a selection mask of the specified type.

Parameters

[in] selTypeName name of the selection type

MSelectionMask ( const MSelectionMask & in )

Copy constructor.

Duplicates the given mask

Parameters

[in] in mask to be copied

~MSelectionMask ( )

virtual

Class destructor.

Removes the selection mask.

Member Function Documentation

MStatus setMask ( MSelectionMask & mask )

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

MS::kSuccess the selection type was successfully set
MS::kFailure object error

MStatus addMask ( SelectionType selType )

Add the specified selection type to this mask.

Parameters

[in] selType the selection type to add

Returns

MS::kSuccess the selection type was successfully added
MS::kFailure object error

Examples:: apiMeshShape/apiMeshGeometryOverride.cpp, and apiMeshShape/apiMeshSubSceneOverride.cpp.

bool intersects	(	MSelectionMask &	mask,
		MStatus *	ReturnStatus = `NULL`
	)		const

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:

MS::kSuccess this method succeeded
MS::kFailure object error

MSelectionMask operator| ( MSelectionMask & 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

MSelectionMask & operator= ( const MSelectionMask & other )

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.

Examples:: footPrintNode_AnimatedMaterial/footPrintNode_GeometryOverride_AnimatedMaterial.cpp, footPrintNode_GeometryOverride/footPrintNode_GeometryOverride.cpp, footPrintNode_SubSceneOverride/footPrintNode_SubSceneOverride.cpp, and gpuCache/gpuCachePluginMain.cpp.

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.

Examples:: footPrintNode_AnimatedMaterial/footPrintNode_GeometryOverride_AnimatedMaterial.cpp, footPrintNode_GeometryOverride/footPrintNode_GeometryOverride.cpp, footPrintNode_SubSceneOverride/footPrintNode_SubSceneOverride.cpp, and gpuCache/gpuCachePluginMain.cpp.

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.

Examples:: gpuCache/gpuCachePluginMain.cpp.

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

MSelectionMask.h
MSelectionMask.cpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation