SelectionManager

class SelectionManager()

Accessors

viewer

Methods

add()
advanceIncrementalSelection()
beginConvexPolyhedronSelection()
beginRayDrillSelection()
beginScreenSelectByArea()
beginSphereSelection()
clear()
contains()
containsParent()
each()
endIncrementalSelection()
exportSelectionData()
getFirst()
getHighlightFaceElementSelection()
getHighlightLineElementSelection()
getHighlightNodeSelection()
getHighlightPointElementSelection()
getIgnoreEntityWhenTogglingChildSelection()
getLast()
getNodeElementSelectionColor()
getNodeElementSelectionHighlightMode()
getNodeElementSelectionOutlineColor()
getNodeSelectionColor()
getNodeSelectionHighlightMode()
getNodeSelectionOutlineColor()
getPickTolerance()
getPruneSelectionDescendants()
getResult()
getResults()
getSelectParentIfSelected()
getSelectedLayers()
getSelectedTypes()
getSelectionFilter()
getSingleEntityToggleModeEnabled()
getSuppressImplicitRemovalCallback()
isNodeSelected()
isSelected()
loadSelectionData()
remove()
selectAllFromPoint()
selectAllFromRay()
selectFromPoint()
selectFromRay()
selectLayer()
selectNode()
selectType()
set()
setHighlightFaceElementSelection()
setHighlightLineElementSelection()
setHighlightNodeSelection()
setHighlightPointElementSelection()
setIgnoreEntityWhenTogglingChildSelection()
setNodeElementSelectionColor()
setNodeElementSelectionHighlightMode()
setNodeElementSelectionOutlineColor()
setNodeSelectionColor()
setNodeSelectionHighlightMode()
setNodeSelectionOutlineColor()
setPickTolerance()
setPruneSelectionDescendants()
setSelectParentIfSelected()
setSelectionFilter()
setSingleEntityToggleModeEnabled()
setSuppressImplicitRemovalCallback()
size()
toggle()

Accessors

Methods

add

SelectionManager.add(itemOrItems, suppressCallback)

Arguments:	itemOrItems (`NodeSelectionItem()` \| [`NodeSelectionItem()`] \| null) – suppressCallback (`boolean()`) –
Return type:	void

advanceIncrementalSelection

SelectionManager.advanceIncrementalSelection(handle, predicate)

Arguments:	handle (`IncrementalSelectionId()`) – predicate (`function \| null()`) –
Return type:	Promise <boolean>

SelectionManager.predicate(item)

Arguments:	item (`NodeSelectionItem()`) – None
Return type:	Promise <boolean>

beginConvexPolyhedronSelection

SelectionManager.beginConvexPolyhedronSelection(volumePlanes, heuristicOrigin, config)

Arguments:	volumePlanes ([Plane]) – heuristicOrigin (`Point3()`) – config (`IncrementalPickConfig()`) –
Return type:	Promise <`IncrementalSelectionId()`>

beginRayDrillSelection

SelectionManager.beginRayDrillSelection(rayCssOrigin, rayCssBoxRadius, config, view)

Arguments:	rayCssOrigin (`Point2()`) – rayCssBoxRadius (`number()`) – config (`IncrementalPickConfig()`) – view (`IView()`) –
Return type:	Promise <`IncrementalSelectionId()`>

beginScreenSelectByArea

SelectionManager.beginScreenSelectByArea(areaCssMin, areaCssMax, config, view)

Arguments:	areaCssMin (`Point2()`) – areaCssMax (`Point2()`) – config (`IncrementalPickConfig()`) – view (`IView()`) –
Return type:	Promise <`IncrementalSelectionId()`>

beginSphereSelection

SelectionManager.beginSphereSelection(sphereCenter, sphereRadius, config)

Arguments:	sphereCenter (`Point3()`) – sphereRadius (`number()`) – config (`IncrementalPickConfig()`) –
Return type:	Promise <`IncrementalSelectionId()`>

clear

SelectionManager.clear(triggerCallback)

Arguments:	triggerCallback (`boolean()`) –
Return type:	void

contains

SelectionManager.contains(item)

Arguments:	item (`SelectionItem()`) – None
Return type:	boolean

containsParent

SelectionManager.containsParent(item)

Arguments:	item (`NodeSelectionItem()`) – None
Return type:	`NodeSelectionItem()` \| null

each

SelectionManager.each(func)

Arguments:	func (`function()`) –
Return type:	void

SelectionManager.func(s)

Arguments:	s (`NodeSelectionItem()`) – None
Return type:	void

endIncrementalSelection

SelectionManager.endIncrementalSelection(handle)

Arguments:	handle (`IncrementalSelectionId()`) –
Return type:	Promise <void>

exportSelectionData

SelectionManager.exportSelectionData()

Return type:	[object]

getFirst

SelectionManager.getFirst()

Return type:	`NodeSelectionItem()` \| null

getHighlightFaceElementSelection

SelectionManager.getHighlightFaceElementSelection()

Return type:	boolean

getHighlightLineElementSelection

SelectionManager.getHighlightLineElementSelection()

Return type:	boolean

getHighlightNodeSelection

SelectionManager.getHighlightNodeSelection()

Return type:	boolean

getHighlightPointElementSelection

SelectionManager.getHighlightPointElementSelection()

Return type:	boolean

getIgnoreEntityWhenTogglingChildSelection

SelectionManager.getIgnoreEntityWhenTogglingChildSelection()

Return type:	boolean

getLast

SelectionManager.getLast()

Return type:	`NodeSelectionItem()` \| null

getNodeElementSelectionColor

SelectionManager.getNodeElementSelectionColor()

Return type:	Color

getNodeElementSelectionHighlightMode

SelectionManager.getNodeElementSelectionHighlightMode()

Return type:	SelectionHighlightMode

getNodeElementSelectionOutlineColor

SelectionManager.getNodeElementSelectionOutlineColor()

Return type:	Color

getNodeSelectionColor

SelectionManager.getNodeSelectionColor()

Return type:	Color

getNodeSelectionHighlightMode

SelectionManager.getNodeSelectionHighlightMode()

Return type:	SelectionHighlightMode

getNodeSelectionOutlineColor

SelectionManager.getNodeSelectionOutlineColor()

Return type:	Color

getPickTolerance

SelectionManager.getPickTolerance()

Return type:	number

getPruneSelectionDescendants

SelectionManager.getPruneSelectionDescendants()

Return type:	boolean

getResult

SelectionManager.getResult(index)

Arguments:	index (`number()`) –
Return type:	`NodeSelectionItem()` \| null

getResults

SelectionManager.getResults()

Return type:	[`NodeSelectionItem()`]

getSelectParentIfSelected

SelectionManager.getSelectParentIfSelected()

Return type:	boolean

getSelectedLayers

SelectionManager.getSelectedLayers()

Return type:	[LayerName]

getSelectedTypes

SelectionManager.getSelectedTypes()

Return type:	[GenericType]

getSelectionFilter

SelectionManager.getSelectionFilter()

Return type:	SelectionFilter \| null

getSingleEntityToggleModeEnabled

SelectionManager.getSingleEntityToggleModeEnabled()

Return type:	boolean

getSuppressImplicitRemovalCallback

SelectionManager.getSuppressImplicitRemovalCallback()

Return type:	boolean

isNodeSelected

SelectionManager.isNodeSelected(nodeId)

Arguments:	nodeId (NodeId) –
Return type:	boolean

isSelected

SelectionManager.isSelected(item)

Arguments:	item (`SelectionItem()`) – None
Return type:	boolean

loadSelectionData

SelectionManager.loadSelectionData(datas)

Arguments:	datas (`[object] \| string()`) – None
Return type:	void

remove

SelectionManager.remove(itemOrItems, suppressCallback)

Arguments:	itemOrItems (`NodeSelectionItem()` \| [`NodeSelectionItem()`]) – suppressCallback (`boolean()`) –
Return type:	void

selectAllFromPoint

SelectionManager.selectAllFromPoint(point, config, selectionMode, view)

Arguments:	point (`Point2()`) – config (`PickConfig()`) – selectionMode (SelectionMode) – view (`IView()`) –
Return type:	Promise <void>

selectAllFromRay

SelectionManager.selectAllFromRay(ray, config, selectionMode, view)

Arguments:	ray (`Ray()`) – config (`PickConfig()`) – selectionMode (SelectionMode) – view (`IView()`) –
Return type:	Promise <void>

selectFromPoint

SelectionManager.selectFromPoint(point, config, selectionMode, view)

Arguments:	point (`Point2()`) – config (`PickConfig()`) – selectionMode (SelectionMode) – view (`IView()`) –
Return type:	Promise <void>

selectFromRay

SelectionManager.selectFromRay(ray, config, selectionMode, view)

Arguments:	ray (`Ray()`) – config (`PickConfig()`) – selectionMode (SelectionMode) – view (`IView()`) –
Return type:	Promise <void>

selectLayer

SelectionManager.selectLayer(layerName, selectionMode)

Arguments:	layerName (LayerName) – selectionMode (SelectionMode) –
Return type:	void

selectNode

SelectionManager.selectNode(nodeId, selectionMode)

Arguments:	nodeId (NodeId \| null) – selectionMode (SelectionMode) – None
Return type:	SelectionType

selectType

SelectionManager.selectType(genericType, selectionMode)

Arguments:	genericType (GenericType) – selectionMode (SelectionMode) – None
Return type:	void

set

SelectionManager.set(selection)

Arguments:	selection (`NodeSelectionItem()` \| null) – None
Return type:	void

setHighlightFaceElementSelection

SelectionManager.setHighlightFaceElementSelection(highlightFaceElementSelection)

Arguments:	highlightFaceElementSelection (`boolean()`) –
Return type:	Promise <void>

setHighlightLineElementSelection

SelectionManager.setHighlightLineElementSelection(highlightLineElementSelection)

Arguments:	highlightLineElementSelection (`boolean()`) –
Return type:	Promise <void>

setHighlightNodeSelection

SelectionManager.setHighlightNodeSelection(highlightSelection)

Arguments:	highlightSelection (`boolean()`) – None
Return type:	Promise <void>

setHighlightPointElementSelection

SelectionManager.setHighlightPointElementSelection(highlightPointElementSelection)

Arguments:	highlightPointElementSelection (`boolean()`) –
Return type:	Promise <void>

setIgnoreEntityWhenTogglingChildSelection

SelectionManager.setIgnoreEntityWhenTogglingChildSelection(strictMode)

Arguments:	strictMode (`boolean()`) – None
Return type:	void

setNodeElementSelectionColor

SelectionManager.setNodeElementSelectionColor(color)

Arguments:	color (Color) –
Return type:	Promise <void>

setNodeElementSelectionHighlightMode

SelectionManager.setNodeElementSelectionHighlightMode(highlightMode)

Arguments:	highlightMode (SelectionHighlightMode) –
Return type:	Promise <void>

setNodeElementSelectionOutlineColor

SelectionManager.setNodeElementSelectionOutlineColor(color)

Arguments:	color (Color) –
Return type:	Promise <void>

setNodeSelectionColor

SelectionManager.setNodeSelectionColor(color)

Arguments:	color (Color) –
Return type:	Promise <void>

setNodeSelectionHighlightMode

SelectionManager.setNodeSelectionHighlightMode(highlightMode)

Arguments:	highlightMode (SelectionHighlightMode) –
Return type:	Promise <void>

setNodeSelectionOutlineColor

SelectionManager.setNodeSelectionOutlineColor(color)

Arguments:	color (Color) –
Return type:	Promise <void>

setPickTolerance

SelectionManager.setPickTolerance(tolerance)

Arguments:	tolerance (`number()`) – None
Return type:	void

setPruneSelectionDescendants

SelectionManager.setPruneSelectionDescendants(pruneSelectionDescendants)

Arguments:	pruneSelectionDescendants (`boolean()`) – None
Return type:	void

setSelectParentIfSelected

SelectionManager.setSelectParentIfSelected(selectParent)

Arguments:	selectParent (`boolean()`) – None
Return type:	void

setSelectionFilter

SelectionManager.setSelectionFilter(selectionFilter)

Arguments:	selectionFilter (SelectionFilter \| null) –
Return type:	void

setSingleEntityToggleModeEnabled

SelectionManager.setSingleEntityToggleModeEnabled(enabled)

Arguments:	enabled (`boolean()`) – None
Return type:	void

setSuppressImplicitRemovalCallback

SelectionManager.setSuppressImplicitRemovalCallback(suppress)

Arguments:	suppress (`boolean()`) – None
Return type:	void

size

SelectionManager.size()

Return type:	number

toggle

SelectionManager.toggle(item)

Arguments:	item (`NodeSelectionItem()`) – None
Return type:	void