class MSelectInfo

Jump to documentation

Inheritance:

MSelectInfo < MDrawInfo

public members:

	MSelectInfo ()
	MSelectInfo ( const MSelectInfo & in )
	~MSelectInfo ()
M3dView	view ()
bool	singleSelection () const
bool	selectClosest () const
bool	selectable ( MSelectionMask & mask ) const
bool	selectableComponent ( bool displayed, MSelectionMask & mask ) const
bool	isRay () const
MMatrix	getAlignmentMatrix () const
void	getLocalRay ( MPoint &, MVector & ) const
bool	selectForHilite ( const MSelectionMask & ) const
bool	selectOnHilitedOnly () const
int	highestPriority () const
void	setHighestPriority ( int )
void	addSelection ( const MSelectionList &item, const MPoint &point, MSelectionList &list, MPointArray &points, const MSelectionMask & mask, bool isComponent )
MDagPath	selectPath () const

Inherited from MDrawInfo:

public members:

MDrawRequest	getPrototype ( const MPxSurfaceShapeUI & drawHandler ) const
M3dView	view () const
const MDagPath	multiPath () const
const MMatrix	projectionMatrix () const
const MMatrix	inclusiveMatrix () const
M3dView::DisplayStyle	displayStyle () const
M3dView::DisplayStatus	displayStatus () const
bool	objectDisplayStatus ( M3dView::DisplayObjects ) const
bool	inSelect () const
bool	completelyInside () const
bool	canDrawComponent ( bool isDisplayOn, const MSelectionMask & compMask ) const

Documentation

Description

MSelectInfo is used with user defined shape selection and is passed as an argument to the MPxSurfaceShapeUI::select method. This class encapsulates all the selection state information for selected objects.

Functions

MSelectInfo:: MSelectInfo ()

Description

Constructor.

MSelectInfo:: MSelectInfo ( const MSelectInfo & other )

Description

Copy constructor.

Arguments

• other object to copy

MSelectInfo:: ~MSelectInfo ()

Description

Destructor.

M3dView MSelectInfo:: view ()

Description

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

Return Value

• the view

bool MSelectInfo:: singleSelection () const

Description

This methods determines if we want to select a single object.

Return Value

• true a single object should be selected
• false do not want to select a single object

bool MSelectInfo:: selectClosest () const

Description

Determines if we want to select the closest object.

Return Value

• true the closest object should be selected
• false do not want to select the closest object

bool MSelectInfo:: selectable ( MSelectionMask & mask ) const

Description

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

Arguments

• mask selection mask

Return Value

• true the object is selectable
• false the object not is selectable

bool MSelectInfo:: selectableComponent ( bool displayed, MSelectionMask & mask ) const

Description

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

Arguments

• displayed is the component displayed
• mask selection mask

Return Value

• true the component is selectable
• false the component not is selectable

bool MSelectInfo:: isRay () const

Description

Is there a selection ray. This method isused to find ray object intersection.

Return Value

• true there is a selection ray
• false there is no selection ray

MMatrix MSelectInfo:: getAlignmentMatrix () const

Description

Returns the alignment matrix. This method is used to find ray object intersection.

Return Value

• the alignment matrix

void MSelectInfo:: getLocalRay ( MPoint & pnt, MVector & vec ) const

Description

Get the selection ray. This method isused to find ray object intersection.

Arguments

• pnt ray starting point
• vec ray direction

bool MSelectInfo:: selectForHilite ( const MSelectionMask & mask ) const

Description

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

Arguments

• mask the mask to test

Return Value

• true can select for hilite
• false can't select for hilite

bool MSelectInfo:: selectOnHilitedOnly () const

Description

This means that you can only select components if the object is hilited.

Return Value

• true can only select components if object is hilited
• false can select components for non-hilited object

int MSelectInfo:: highestPriority () const

Description

Returns the highest selection priority value.

Return Value

• the priority value

void MSelectInfo:: setHighestPriority ( int value )

Description

Sets the highest selection priority value.

Arguments

• value the priority value

void MSelectInfo:: addSelection ( const MSelectionList &item, const MPoint &point, MSelectionList &list, MPointArray &points, const MSelectionMask & mask, bool isComponent )

Description

Adds components or objects to the active selection list. For an example of how this is used please refer to the method definition apiMeshShapeUI::select() in the devkit example code apiMeshShape.cpp.

Arguments

• item The component or object to add to the list
• point 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 The selection list to add the item(s) to
• points A copy of the points of all currently selected components in the list (if components are selected)
• mask Mask used to determine selection priority
• isComponent Indicates whether item to be added is an object or a component

MDagPath MSelectInfo:: selectPath () const

Description

Returns a path to the item that is being selected.

Return Value

• a path to the item being selected

This class has no child classes.