Communicator.SelectionManager

 SelectionManager

This class provides the main interface into the selection functionality of the viewer. The class manages a list of selection items that are optionally highlighted as the user selects objects in the scene.

Properties

Methods

Properties

Static ifcSelectionFilter

ifcSelectionFilter: function

Type declaration

    • (nodeId: number, model: Model): number | null
    • Parameters

      • nodeId: number
      • model: Model

      Returns number | null

Methods

add

  • add(itemOrItems: NodeSelectionItem | NodeSelectionItem[] | null, suppressCallback?: boolean): void
  • Manually adds an item or array of items to the selection set. Triggers a selection event.

    Parameters

    • itemOrItems: NodeSelectionItem | NodeSelectionItem[] | null

      A selectionItem or selectionItem array that will be added to the current selection set.

    • Optional suppressCallback: boolean

      Optional boolean param to suppress the selectionArray callbacks calls to this generate.

    Returns void

advanceIncrementalSelection

  • Adds the next batch of instances selected by the supplied selection context to the selection set.

    Parameters

    • handle: IncrementalSelectionId

      The handle to an active area selection context.

    • Optional predicate: function | null

      An optional function that returns true if a given NodeSelectionItem should be added to the selection set. If false is returned, the item will not be added.

    Returns Promise<boolean>

    true if there are possibly more items to select and false if not.

advanceVolumeSelection    [deprecated]

beginConvexPolyhedronSelection

  • Creates a new and active selection context for the provided selection volume. The selection volume is a convex polyhedron defined by the bounded intersection of its half-spaces.

    Parameters

    • volumePlanes: Plane[]

      The planes used to define volume. A point p is inside the volume if and only if (plane.determineSide(p) == true) for all supplied planes.

    • heuristicOrigin: Point3

      A point used to compute distances against for ordering returned results. This is typically (but not necessarily) the center of the volume.

    • config: IncrementalPickConfig

      The configuration object used for this selection operation.

    Returns Promise<IncrementalSelectionId>

    The handle for the selection context.

beginRayDrillSelection

  • Creates a new and active selection context for the provided selection ray. The ray is created at the supplied ray origin and is cast into the scene. Faces are selected if they lie along the ray. Lines and points are selected if they lie within the ray's box radius.

    Note: Somewhat confusingly ray drill selection is actually a selection by volume. The provided ray origin and radius are used to create a frustum to preform the selection. This has some consequences. For example, the SelectionResults returned by advancing a ray drill selection will not have selection positions, since they were not selected at a single point.

    Parameters

    • rayCssOrigin: Point2

      The coordinate in css pixel space for the selection ray's origin.

    • rayCssBoxRadius: number

      The radius around the ray in css pixel space used for line and point selection proximity.

    • config: IncrementalPickConfig

      The configuration object used for this selection operation.

    Returns Promise<IncrementalSelectionId>

    The handle for the selection context.

beginScreenSelectByArea

  • Creates a new and active selection context for the provided selection window.

    Parameters

    • areaCssMin: Point2

      The minimum coordinate in css pixel space for the selection window.

    • areaCssMax: Point2

      The maximum coordinate in css pixel space for the selection window.

    • config: IncrementalPickConfig

      The configuration object used for this selection operation.

    Returns Promise<IncrementalSelectionId>

    The handle for the selection context.

beginSphereSelection

  • Creates a new and active selection context for the provided selection sphere.

    Parameters

    • sphereCenter: Point3

      The center of the selection sphere.

    • sphereRadius: number

      The radius of the selection sphere.

    • config: IncrementalPickConfig

      The configuration object used for this selection operation.

    Returns Promise<IncrementalSelectionId>

    The handle for the selection context.

clear

  • clear(triggerCallback?: boolean): void
  • Removes all items from the selection set.

    Parameters

    • Optional triggerCallback: boolean

      triggers a null selection callback when true.

    Returns void

contains

containsParent

  • Checks if the parent of a selection item is in the selection set.

    Parameters

    Returns NodeSelectionItem | null

    parent selection item, or null if not found

each

  • each(func: function): void
  • Iterates over all selection items. The function passed in will be called once for every selection item and will receive the item as its parameter.

    Parameters

    Returns void

endIncrementalSelection

endVolumeSelection    [deprecated]

exportSelectionData

  • exportSelectionData(): Object[]
  • Exports selection objects so that they may be loaded back into the the system at a later time using loadSelectionData.

    Returns Object[]

    exported selection data.

getFirst

  • Gets the least recent selection item.

    Returns NodeSelectionItem | null

    the least recently selected item (if any).

getHighlightFaceElementSelection

  • getHighlightFaceElementSelection(): boolean
  • Gets whether face elements will be highlighted on selection.

    Returns boolean

    boolean the current value for face element selection highlighting.

getHighlightLineElementSelection

  • getHighlightLineElementSelection(): boolean
  • Gets whether line elements will be highlighted on selection.

    Returns boolean

    boolean the current value for line element selection highlighting.

getHighlightNodeSelection

  • getHighlightNodeSelection(): boolean
  • Gets whether nodes will be highlighted on selection.

    Returns boolean

    the current value for node selection highlighting.

getHighlightPointElementSelection

  • getHighlightPointElementSelection(): boolean
  • Gets whether point elements will be highlighted on selection.

    Returns boolean

    boolean the current value for point element selection highlighting.

getIgnoreEntityWhenTogglingChildSelection

  • getIgnoreEntityWhenTogglingChildSelection(): boolean

getLast

  • Gets the most recent selection item.

    Returns NodeSelectionItem | null

    the most recently selected item (if any).

getNodeElementSelectionColor

  • getNodeElementSelectionColor(): Color
  • Gets the color to use for face and line selection.

    Returns Color

    the color used for face and line selection.

getNodeElementSelectionHighlightMode

getNodeElementSelectionOutlineColor

  • getNodeElementSelectionOutlineColor(): Color
  • Gets the color to use for outlining face and line selection.

    Returns Color

    color the color used for outlining face and line selection.

getNodeSelectionColor

  • getNodeSelectionColor(): Color
  • Gets the color to be used when selecting nodes.

    Returns Color

    the color that is applied to a selected node.

getNodeSelectionHighlightMode

getNodeSelectionOutlineColor

  • getNodeSelectionOutlineColor(): Color
  • Gets the color to be used for outlining the node selection.

    Returns Color

    the color for node selection outline.

getPickTolerance

  • getPickTolerance(): number
  • Gets the pick tolerance in pixels for line and point picking.

    The default value is 20.

    Returns number

    number Pick tolerance value in pixels

getPruneSelectionDescendants

  • getPruneSelectionDescendants(): boolean

getResult

  • Gets a selection at the specified index. The first selected item will be at index 0.

    Parameters

    • index: number

      index of selection item to get

    Returns NodeSelectionItem | null

    the selection result at the given index.

getResults

  • getResults(): NodeSelectionItem[]
  • Gets all current selection items.

    Returns NodeSelectionItem[]

    array of all selection items.

getSelectParentIfSelected

  • getSelectParentIfSelected(): boolean

getSelectedLayers

  • getSelectedLayers(): LayerName[]
  • Gets all selected layers.

    Returns LayerName[]

getSelectedTypes

  • getSelectedTypes(): GenericType[]
  • Gets all selected IFC types.

    Returns GenericType[]

getSelectionFilter

getSingleEntityToggleModeEnabled

  • getSingleEntityToggleModeEnabled(): boolean

getSuppressImplicitRemovalCallback

  • getSuppressImplicitRemovalCallback(): boolean

isNodeSelected

  • isNodeSelected(nodeId: NodeId): boolean
  • Checks whether a node, or its parents, appear in the selection set or not. Note: for the purposes of this function element selections on a node are considered the same as node selection.

    Parameters

    • nodeId: NodeId

      Node to check for

    Returns boolean

    true if the node or its parents appear in the selection set. false otherwise

isSelected

loadSelectionData

  • loadSelectionData(datas: Object[] | string): void
  • Loads serialized selection items exported using exportSelectionData back into the SelectionManager. The current selection will be cleared. A selection event will be triggered for each loaded item. This method should not be called before the CallbackMap.modelStructureReady callback has been triggered.

    Parameters

    • datas: Object[] | string

    Returns void

remove

  • remove(itemOrItems: NodeSelectionItem | NodeSelectionItem[], suppressCallback?: boolean): void
  • Manually removes an item or an array of items from the selection set. Triggers a selection event.

    Parameters

    • itemOrItems: NodeSelectionItem | NodeSelectionItem[]

      A selectionItem or an array of selection items that will be removed from the current selection set.

    • Optional suppressCallback: boolean

      Optional boolean param to suppress the selectionArray callbacks calls to this generate.

    Returns void

selectAllFromPoint

  • Performs a selection operation from the given position on the canvas. All candidate entities are selected. This method triggers a selection event.

    Parameters

    • point: Point2

      The canvas position to select from.

    • config: PickConfig

      The configuration object used for this picking operation.

    • Optional selectionMode: SelectionMode

      The mode to use for this selection.

    Returns Promise<void>

    Promise that resolves when this operation has completed.

selectAllFromRay

  • Performs a selection operation from the given world-space ray. All candidate entities are selected. This method triggers a selection event.

    Parameters

    • ray: Ray

      The world-space ray to perform the selection with.

    • config: PickConfig

      The configuration object used for this picking operation.

    • Optional selectionMode: SelectionMode

      The mode to use for this selection.

    Returns Promise<void>

    Promise that resolves when this operation has completed.

selectFromPoint

  • Performs a selection operation from the given position on the canvas. The best candidate entity is selected. This method triggers a selection event.

    Parameters

    • point: Point2

      The canvas position to select from.

    • config: PickConfig

      The configuration object used for this picking operation.

    • Optional selectionMode: SelectionMode

      The mode to use for this selection.

    Returns Promise<void>

    Promise that resolves when this operation has completed.

selectFromRay

  • Performs a selection operation from the given world-space ray. The best candidate entity is selected. This method triggers a selection event.

    Parameters

    • ray: Ray

      The world-space ray to perform the selection with.

    • config: PickConfig

      The configuration object used for this picking operation.

    • Optional selectionMode: SelectionMode

      The mode to use for this selection.

    Returns Promise<void>

    Promise that resolves when this operation has completed.

selectLayer

  • Adds all items in a layer to the selection set.

    Parameters

    Returns void

selectNode

  • Selects a node with the given Id.

    Parameters

    • nodeId: NodeId | null

      nodeId of the node to select. Pass null to clear the selection.

    • Optional selectionMode: SelectionMode

    Returns SelectionType

    the selection type of this operation.

selectType

  • Adds all items with an IFC type to the selection set.

    Parameters

    Returns void

set

  • Manually removes all currently selected items (if any) from the selection set and adds the supplied item. Triggers a selection event.

    Parameters

    Returns void

setHighlightFaceElementSelection

  • setHighlightFaceElementSelection(highlightFaceElementSelection: boolean): DeprecatedPromise
  • Sets whether face elements should be highlighted when a selection occurs. By default the system will automatically highlight face elements associated with a selection item.

    Parameters

    • highlightFaceElementSelection: boolean

      value indicating whether selected face elements should be highlighted.

    Returns DeprecatedPromise

setHighlightLineElementSelection

  • setHighlightLineElementSelection(highlightLineElementSelection: boolean): DeprecatedPromise
  • Sets whether line elements should be highlighted when a selection occurs. By default the system will automatically highlight line elements associated with a selection item.

    Parameters

    • highlightLineElementSelection: boolean

      value indicating whether selected line elements should be highlighted.

    Returns DeprecatedPromise

setHighlightNodeSelection

  • Sets whether nodes should be highlighted when a selection occurs. By default, the system will automatically highlight the node associated with a selection item.

    Parameters

    • highlightSelection: boolean

    Returns DeprecatedPromise

setHighlightPointElementSelection

  • setHighlightPointElementSelection(highlightPointElementSelection: boolean): DeprecatedPromise
  • Sets whether point elements should be highlighted when a selection occurs. By default the system will automatically highlight point elements associated with a selection item.

    Parameters

    • highlightPointElementSelection: boolean

      value indicating whether selected point elements should be highlighted.

    Returns DeprecatedPromise

setIgnoreEntityWhenTogglingChildSelection

  • setIgnoreEntityWhenTogglingChildSelection(strictMode: boolean): void
  • Enables / disables ignore entity when toggling child selection mode.

    When enabled, a Selection.NodeSelectionItem that has a selected ancestor may only be toggled if it does not contain an entity selection. A selection item without an entity selection is usually generated from selecting a node via a model tree control. A selection item containing an entity selection is usually generated as a result of a viewport picking operation.

    This behavior is enabled by default. See Also: toggle

    Parameters

    • strictMode: boolean

    Returns void

setNodeElementSelectionColor

  • Sets the color to use for node element selection. This method should not be called before the sceneReady callback has been triggered.

    Parameters

    • color: Color

      the color to apply to selected node elements.

    Returns DeprecatedPromise

setNodeElementSelectionHighlightMode

  • Sets the highlighting mode for selected node elements. The default behavior is to highlight the node element and render an overlay outline. This method should not be called before the sceneReady callback has been triggered.

    Parameters

    Returns DeprecatedPromise

setNodeElementSelectionOutlineColor

  • Gets the color to use for outlining node element selection. This method should not be called before the sceneReady callback has been triggered.

    Parameters

    • color: Color

      the color used for outlining face and line selection.

    Returns DeprecatedPromise

setNodeSelectionColor

  • Sets the color to be used when selecting nodes. This method should not be called before the sceneReady callback has been triggered.

    Parameters

    • color: Color

      the color to apply to the selected node.

    Returns DeprecatedPromise

setNodeSelectionHighlightMode

  • Sets the highlighting mode for selected nodes. The default behavior is to highlight the node and render an overlay outline. This method should not be called before the sceneReady callback has been triggered.

    Parameters

    Returns DeprecatedPromise

setNodeSelectionOutlineColor

  • Sets color for the node selection outline. This method should not be called before the sceneReady callback has been triggered.

    Parameters

    • color: Color

      the color to apply to the node selection outline.

    Returns DeprecatedPromise

setPickTolerance

  • setPickTolerance(tolerance: number): void
  • Sets the pick tolerance in pixels for line and point picking. If a line or point is within this pixel tolerance of the click point, it will be prioritized over the face at the click position.

    The default value is 20.

    Parameters

    • tolerance: number

    Returns void

setPruneSelectionDescendants

  • setPruneSelectionDescendants(pruneSelectionDescendants: boolean): void
  • Enables / disables descendant pruning and clears the current selection set. When enabled, a parent and child will not be present in the same selection set. This behavior is enabled by default.

    Parameters

    • pruneSelectionDescendants: boolean

    Returns void

setSelectParentIfSelected

  • setSelectParentIfSelected(selectParent: boolean): void
  • Enables / disables automatic parent selection. When enabled, if a selected part is selected again, its parent will be selected. This behavior is enabled by default.

    Parameters

    • selectParent: boolean

    Returns void

setSelectionFilter

  • This allows manipulating the selected NodeId. To reset the filter, set it to null.

    Parameters

    • selectionFilter: SelectionFilter | null

      function that manipulates the selected NodeId.

    Returns void

setSingleEntityToggleModeEnabled

  • setSingleEntityToggleModeEnabled(enabled: boolean): void
  • Enables / disables single entity toggle mode.

    When enabled, limits the selection set to containing only one entity selection for each node id. Toggling with an entity selection that has the same node id as a Selection.NodeSelectionItem already in the selection set will remove that item from the selection set.

    This behavior is disabled by default. See Also: toggle

    Parameters

    • enabled: boolean

    Returns void

setSuppressImplicitRemovalCallback

  • setSuppressImplicitRemovalCallback(suppress: boolean): void
  • Sets whether to generate selectionArray callbacks with implicitly removed nodes.

    For example, consider the case where you have a parent node that has a multiple child nodes. Normally, if the parent begins selected and then a child is removed from the selection set there will be two selectionArray callbacks generated. The first will for the removal of the parent node. The second wil be for the addition of all of it's children except the one that was initially removed.

    When this behavior is enabled only a single selectionArray callback will be generated for the child node that was removed.

    This behavior is disabled by default.

    Parameters

    • suppress: boolean

    Returns void

size

  • size(): number
  • Gets the number of selection items.

    Returns number

    the number of selected items.

toggle

  • Manually adds or removes an item from the selection set. Triggers a selection event.

    Parameters

    Returns void