IncrementalSelection
- class Communicator.Util.IncrementalSelection()
This class is a high-level wrapper over the various incremental selection operations that can be performed.
See also:
SelectionManager.prototype.beginScreenSelectByAreaSelectionManager.prototype.beginRayDrillSelectionSelectionManager.prototype.beginConvexPolyhedronSelectionSelectionManager.prototype.beginSphereSelectionSelectionManager.prototype.advanceIncrementalSelectionSelectionManager.prototype.endIncrementalSelectionView.prototype.beginScreenSelectByAreaView.prototype.beginRayDrillSelectionView.prototype.beginConvexPolyhedronSelectionView.prototype.beginSphereSelectionView.prototype.advanceIncrementalSelectionView.prototype.endIncrementalSelection
Type aliases
Methods
Type aliases
BeginConfig
Configuration object detailing how an incremental selection begins.
Mode
Determines whether or not selections are performed using the View or the SelectionManager
Predicate
Type used for a selection predicate. The predicate is used to filter selection items.
Methods
clearSelection
- Communicator.Util.IncrementalSelection.clearSelection(this)
Stops and clears the selection.
- Arguments
- Return type
Promise[void]- Returns
A
Promisethat resolves when completed.
isIdle
- Communicator.Util.IncrementalSelection.isIdle()
Returns whether or not this object has an active selection in progress.
- Return type
boolean- Returns
trueif active andfalseif idle.
performSelection
- Communicator.Util.IncrementalSelection.performSelection(this, beginConfig, predicate)
Perform an incremental selection using the
SelectionManager- Arguments
beginConfig (
Communicator.Util.IncrementalSelection.BeginConfig()) –predicate (
{ }()) –
- Return type
Promise[void]- Returns
A Promise that resolves when the selection has completed.
Selected objects will incrementally be added to the
SelectionManageras the incremental selection progresses.
- Communicator.Util.IncrementalSelection.performSelection(this, beginConfig, predicate)
Perform an incremental selection using the
View- Arguments
beginConfig (
Communicator.Util.IncrementalSelection.BeginConfig()) –predicate (
{ }()) –
- Return type
Promise[[Communicator.Selection.NodeSelectionItem]]- Returns
A Promise of all selected items when selection has completed.
- Communicator.Util.IncrementalSelection.performSelection(this, beginConfig, predicate, outItems)
Perform an incremental selection using the
View- Arguments
beginConfig (
Communicator.Util.IncrementalSelection.BeginConfig()) –predicate (
{ }()) –outItems (
[Communicator.Selection.NodeSelectionItem]()) –
- Return type
Promise[[Communicator.Selection.NodeSelectionItem]]- Returns
A Promise that resolves to
outItemswhen selection has completed.
Selected objects will incrementally be added to the
outItemsargument as the incremental selection progresses.
- Communicator.Util.IncrementalSelection.performSelection(this, beginConfig, predicate)
- Arguments
beginConfig (
Communicator.Util.IncrementalSelection.BeginConfig()) –predicate (
{ }()) –
- Return type
Promise[{ }]
stopSelection
- Communicator.Util.IncrementalSelection.stopSelection()
Stops the selection.
- Return type
Promise[void]- Returns
A
Promisethat resolves when completed.
waitForIdle
- Communicator.Util.IncrementalSelection.waitForIdle()
Used to wait for this object to become idle.
- Return type
Promise[void]- Returns
A promise that resolves when this becomes idle.
create
- Communicator.Util.IncrementalSelection.create(mode, viewer)
Creates a new
IncrementalSelectionobject that can be used to perform incremental selections.- Arguments
mode (
M()) – Controls whether or not selections are performed using theViewor theSelectionManagerviewer (
Communicator.WebViewer()) – TheWebViewerof the scene.
- Return type
Communicator.Util.IncrementalSelection- Returns
The created
IncrementalSelectionobject.
isConvexPolyhedronConfig
- Communicator.Util.IncrementalSelection.isConvexPolyhedronConfig(config)
Determines if the input
BeginConfigis aConvexPolyhedronConfig.- Arguments
config (
Communicator.Util.IncrementalSelection.BeginConfig()) – The config to test.
- Return type
unknown- Returns
trueifconfigis aConvexPolyhedronConfigandfalseotherwise.
isRayDrillConfig
- Communicator.Util.IncrementalSelection.isRayDrillConfig(config)
Determines if the input
BeginConfigis aRayDrillConfig.- Arguments
config (
Communicator.Util.IncrementalSelection.BeginConfig()) – The config to test.
- Return type
unknown- Returns
trueifconfigis aRayDrillConfigandfalseotherwise.
isScreenByAreaConfig
- Communicator.Util.IncrementalSelection.isScreenByAreaConfig(config)
Determines if the input
BeginConfigis aScreenByAreaConfig.- Arguments
config (
Communicator.Util.IncrementalSelection.BeginConfig()) – The config to test.
- Return type
unknown- Returns
trueifconfigis aScreenByAreaConfigandfalseotherwise.
isSphereConfig
- Communicator.Util.IncrementalSelection.isSphereConfig(config)
Determines if the input
BeginConfigis aSphereConfig.- Arguments
config (
Communicator.Util.IncrementalSelection.BeginConfig()) – The config to test.
- Return type
unknown- Returns
trueifconfigis aSphereConfigandfalseotherwise.