GetAllItemsUnderMouseCursor Method

In This Topic

Returns all the visible (on screen) and selectable entities (which may include the parents stack for nested entities) under the mouse cursor in the active viewport.

Syntax

Visual Basic
C#

'Declaration
 
Public Function GetAllItemsUnderMouseCursor( _
   ByVal mousePos As Point, _
   Optional ByVal selectableOnly As Boolean _
) As ViewportLayout.SelectedItem()

public ViewportLayout.SelectedItem[] GetAllItemsUnderMouseCursor( 
   Point mousePos,
   bool selectableOnly
)

Parameters

mousePos: Mouse position in screen coordinates
selectableOnly: When true, checks the devDept.Eyeshot.Entities.Entity.Selectable property, otherwise no.

Return Value

The list of entity indices.

Remarks

The sensitivity is affected by the PickBoxSize parameter.Only the entities that are visible on screen and in the selectionBox are considered, the ones covered by other entities are not considered.The AssemblySelectionMode determines whether the top level entities or nested entities are returned.

Reference

ViewportLayout Class
ViewportLayout Members
AssemblySelectionMode Property
UpdateVisibleSelection Method
GetAllCrossingEntities Method
GetAllEntitiesUnderMouseCursor Method
GetAllLabelsUnderMouseCursor Method

Send Feedback