ScSelectionManager

class ScSelectionManager()

Constructors

constructor()

Methods

advanceIncrementalSelection()
beginConvexPolyhedronSelection()
beginRayDrillSelection()
beginScreenAreaSelection()
beginSphereSelection()
compositePickFromScreen()
endIncrementalSelection()
getPickTolerance()
pickAllFromRay()
pickAllFromScreen()
pickCompositeFromRay()
pickFromRay()
pickFromScreen()
setPickTolerance()

Constructors

ScSelectionManager.constructor(sc)

Arguments:	sc (Instance) – None
Return type:	`ScSelectionManager()`

Methods

advanceIncrementalSelection

ScSelectionManager.advanceIncrementalSelection(handle, allowForStreamIdle)

Arguments:	handle (`IncrementalSelectionId()`) – None allowForStreamIdle (`boolean()`) – None
Return type:	Promise <[`SelectionItem()`] \| null>

beginConvexPolyhedronSelection

ScSelectionManager.beginConvexPolyhedronSelection(volumePlanes, heuristicOrigin, config)

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

beginRayDrillSelection

ScSelectionManager.beginRayDrillSelection(viewKey, rayCssOrigin, rayCssBoxRadius, config)

Arguments:	viewKey (`ViewKey()`) – None rayCssOrigin (`Point2()`) – None rayCssBoxRadius (`number()`) – None config (`IncrementalPickConfig()`) – None
Return type:	Promise <`IncrementalSelectionId()`>

beginScreenAreaSelection

ScSelectionManager.beginScreenAreaSelection(viewKey, areaCssMin, areaCssMax, config)

Arguments:	viewKey (`ViewKey()`) – None areaCssMin (`Point2()`) – None areaCssMax (`Point2()`) – None config (`IncrementalPickConfig()`) – None
Return type:	Promise <`IncrementalSelectionId()`>

beginSphereSelection

ScSelectionManager.beginSphereSelection(sphereCenter, sphereRadius, config)

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

compositePickFromScreen

ScSelectionManager.compositePickFromScreen(viewKey, point, config, isDrawing)

Arguments:	viewKey (`ViewKey()`) – None point (`Point2()`) – None config (`PickConfig()`) – None isDrawing (`boolean()`) – None
Return type:	Promise <`CompositeSelectionItem()`>

endIncrementalSelection

ScSelectionManager.endIncrementalSelection(handle)

Arguments:	handle (`IncrementalSelectionId()`) – None
Return type:	void

getPickTolerance

ScSelectionManager.getPickTolerance()

Return type:	number

pickAllFromRay

ScSelectionManager.pickAllFromRay(ray, config)

Arguments:	ray (`Ray()`) – None config (`PickConfig()`) – None
Return type:	Promise <[`NodeEntitySelectionItem()`]>

pickAllFromScreen

ScSelectionManager.pickAllFromScreen(viewKey, point, config, isDrawing)

Arguments:	viewKey (`ViewKey()`) – None point (`Point2()`) – None config (`PickConfig()`) – None isDrawing (`boolean()`) – None
Return type:	Promise <[`NodeEntitySelectionItem()`]>

pickCompositeFromRay

ScSelectionManager.pickCompositeFromRay(ray, config)

Arguments:	ray (`Ray()`) – None config (`PickConfig()`) – None
Return type:	Promise <`CompositeSelectionItem()`>

pickFromRay

ScSelectionManager.pickFromRay(ray, config)

Arguments:	ray (`Ray()`) – None config (`PickConfig()`) – None
Return type:	Promise <`NodeEntitySelectionItem()` \| null>

pickFromScreen

ScSelectionManager.pickFromScreen(viewKey, point, config, isDrawing)

Arguments:	viewKey (`ViewKey()`) – None point (`Point2()`) – None config (`PickConfig()`) – None isDrawing (`boolean()`) – None
Return type:	Promise <`NodeEntitySelectionItem()` \| null>

setPickTolerance

ScSelectionManager.setPickTolerance(tolerance)

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