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.beginScreenSelectByArea
SelectionManager.prototype.beginRayDrillSelection
SelectionManager.prototype.beginConvexPolyhedronSelection
SelectionManager.prototype.beginSphereSelection
SelectionManager.prototype.advanceIncrementalSelection
SelectionManager.prototype.endIncrementalSelection
View.prototype.beginScreenSelectByArea
View.prototype.beginRayDrillSelection
View.prototype.beginConvexPolyhedronSelection
View.prototype.beginSphereSelection
View.prototype.advanceIncrementalSelection
View.prototype.endIncrementalSelection
Interfaces
Configuration object detailing how a convex polyhedron… |
|
Configuration object detailing how a ray drll selection… |
|
Configuration object detailing how a screen by area… |
|
Configuration object detailing how a sphere selection… |
Type aliases
Configuration object detailing how an incremental… |
|
Determines whether or not selections are performed using… |
|
Type used for a selection predicate. The predicate is… |
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
Promise
that resolves when completed.
isIdle
- Communicator.Util.IncrementalSelection.isIdle()
Returns whether or not this object has an active selection in progress.
- Return type
boolean
- Returns
true
if active andfalse
if 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
SelectionManager
as 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
outItems
when selection has completed.
Selected objects will incrementally be added to the
outItems
argument 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
Promise
that 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
IncrementalSelection
object that can be used to perform incremental selections.- Arguments
mode (
M()
) – Controls whether or not selections are performed using theView
or theSelectionManager
viewer (
Communicator.WebViewer()
) – TheWebViewer
of the scene.
- Return type
Communicator.Util.IncrementalSelection
- Returns
The created
IncrementalSelection
object.
isConvexPolyhedronConfig
- Communicator.Util.IncrementalSelection.isConvexPolyhedronConfig(config)
Determines if the input
BeginConfig
is aConvexPolyhedronConfig
.- Arguments
config (
Communicator.Util.IncrementalSelection.BeginConfig()
) – The config to test.
- Return type
unknown
- Returns
true
ifconfig
is aConvexPolyhedronConfig
andfalse
otherwise.
isRayDrillConfig
- Communicator.Util.IncrementalSelection.isRayDrillConfig(config)
Determines if the input
BeginConfig
is aRayDrillConfig
.- Arguments
config (
Communicator.Util.IncrementalSelection.BeginConfig()
) – The config to test.
- Return type
unknown
- Returns
true
ifconfig
is aRayDrillConfig
andfalse
otherwise.
isScreenByAreaConfig
- Communicator.Util.IncrementalSelection.isScreenByAreaConfig(config)
Determines if the input
BeginConfig
is aScreenByAreaConfig
.- Arguments
config (
Communicator.Util.IncrementalSelection.BeginConfig()
) – The config to test.
- Return type
unknown
- Returns
true
ifconfig
is aScreenByAreaConfig
andfalse
otherwise.
isSphereConfig
- Communicator.Util.IncrementalSelection.isSphereConfig(config)
Determines if the input
BeginConfig
is aSphereConfig
.- Arguments
config (
Communicator.Util.IncrementalSelection.BeginConfig()
) – The config to test.
- Return type
unknown
- Returns
true
ifconfig
is aSphereConfig
andfalse
otherwise.