OpenMayaUI.MSelectInfo Class Reference

OpenMayaUI.MSelectInfo Class Reference
+ 本参考页将链接到以下概述主题:

Class Description

Selection state information used in MPxSurfaceShapeUI.select.

Method resolution order:
-   MSelectInfo
-   MDrawInfo
-   __builtin__.object
+ Inheritance diagram for OpenMayaUI.MSelectInfo:

Public Member Functions

__init__ ()
 
addSelection ()
 
getAlignmentMatrix ()
 
getLocalRay ()
 
isRay ()
 
selectClosest ()
 
selectForHilite ()
 
selectOnHilitedOnly ()
 
selectPath ()
 
selectRect ()
 
selectable ()
 
selectableComponent ()
 
setSnapPoint ()
 
singleSelection ()
 
view ()
 
- Public Member Functions inherited from OpenMayaUI.MDrawInfo
__init__ ()
 
canDrawComponent ()
 
completelyInside ()
 
displayStatus ()
 
displayStyle ()
 
getPrototype ()
 
inSelect ()
 
inUserInteraction ()
 
inclusiveMatrix ()
 
multiPath ()
 
objectDisplayStatus ()
 
pluginObjectDisplayStatus ()
 
projectionMatrix ()
 
setMultiPath ()
 
userChangingViewContext ()
 
view ()
 

Properties

 highestPriority
 

Constructor & Destructor Documentation

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

Member Function Documentation

OpenMayaUI.MSelectInfo.addSelection ( )
addSelection(item, point, list, points, mask, isComponent) -> self

Adds components or objects to the active selection list.

* item (MSelectionList) - The component or object to add to the list
* point (MPoint) - The world space point representing the selected object. This is used during single-click selection when the click overlaps multiple objects in order to determine which point is closest to the camera.
* list [OUT] (MSelectionList) - The selection list to add the item(s) to
* points [OUT] (MPointArray) - A copy of the points of all currently selected components in the list (if components are selected)
* mask (MSelectionMask) - Mask used to determine selection priority
* isComponent (bool) - Indicates whether item to be added is an object or a component
OpenMayaUI.MSelectInfo.getAlignmentMatrix ( )
getAlignmentMatrix() -> MMatrix

Returns the alignment matrix.
This method is used to find ray object intersection.
OpenMayaUI.MSelectInfo.getLocalRay ( )
getLocalRay() -> [MPoint, MVector]

Returns the selection ray defined by its starting point (MPoint) and its direction (MVector).
This method is used to find ray object intersection.
OpenMayaUI.MSelectInfo.isRay ( )
isRay() -> bool

Returns True if there is a selection ray.
This method isused to find ray object intersection.
OpenMayaUI.MSelectInfo.selectable ( )
selectable(mask) -> bool

Given the selection mask, this method determines if the object is selectable.

* mask (MSelectionMask) - the mask to test
OpenMayaUI.MSelectInfo.selectableComponent ( )
selectableComponent(displayed, mask) -> bool

Given the selection mask, this method determines if the component is selectable.

* displayed (bool) - is the component displayed
* mask (MSelectionMask) - selection mask
OpenMayaUI.MSelectInfo.selectClosest ( )
selectClosest() -> bool

Returns True if we want to select the closest object.
OpenMayaUI.MSelectInfo.selectForHilite ( )
selectForHilite(mask) -> bool

Given the selection mask, can this object be selected for the hilite list.

* mask (MSelectionMask) - the mask to test
OpenMayaUI.MSelectInfo.selectOnHilitedOnly ( )
selectOnHilitedOnly() -> bool

Returns True if you can only select components if the object is hilited.
OpenMayaUI.MSelectInfo.selectPath ( )
selectPath() -> MDagPath

Returns a path to the item that is being selected.
OpenMayaUI.MSelectInfo.selectRect ( )
selectRect() -> [int, int, int, int]

Get the current selection rectangle dimensions, defined by:
  its lower left corner - x coordinate,
  its lower left corner - y coordinate,
  its width,
  its height.
OpenMayaUI.MSelectInfo.setSnapPoint ( )
setSnapPoint(point) -> bool

When a snapping operation is being performed the shape's overridden MPxSurfaceShapeUI.snap() method can call this method to set the point to be snapped to. If setSnapPoint() is called multiple times then the point passed in which is nearest to the current cursor location will be used. So the shape can either compute the snap point itself and call setSnapPoint() once or it can make a series of calls and let setSnapPoint() determine the closest of those for itself.

* point (MPoint) - The point to be snapped to, must be given in world space coordinates.
OpenMayaUI.MSelectInfo.singleSelection ( )
singleSelection() -> bool

This method determines if we want to select a single object.
OpenMayaUI.MSelectInfo.view ( )
view() -> M3dView

Returns the view that the current selection is taking place in.

Property Documentation

OpenMayaUI.MSelectInfo.highestPriority
static
 The highest selection priority value.