Viewer - Interaction
    Preparing search index...

    Class SelectOnUpManager

    SelectOnUpManager is a convenience class that extends SelectManager and automatically configures it to select on pointer up events.

    This maintains backward compatibility while leveraging the unified SelectManager implementation.

    Hierarchy (View Summary)

    Index

    Constructors

    • Parameters

      • Optionalid: string
      • OptionalinteractionEffect: IInteractionEffect
      • OptionaldeselectOnEmpty: boolean

      Returns SelectOnUpManager

    Accessors

    • get deselectOnEmpty(): boolean

      Returns boolean

    • set deselectOnEmpty(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get effectMaterial(): IMaterialAbstractData | undefined

      The effect material that is applied to the node once the effect (selection, hovering or dragging) is active. If no effect material is applied, the effect will not be changed. (Note that this is only for backwards compatibility, use interactionEffect instead)

      Returns IMaterialAbstractData | undefined

    • set effectMaterial(value: IMaterialAbstractData | undefined): void

      The effect material that is applied to the node once the effect (selection, hovering or dragging) is active. If no effect material is applied, the effect will not be changed. (Note that this is only for backwards compatibility, use interactionEffect instead)

      Parameters

      • value: IMaterialAbstractData | undefined

      Returns void

    • get gatheredGroupedNodes(): { [key: string]: ITreeNode[] }

      Returns { [key: string]: ITreeNode[] }

    • get id(): string

      The unique id of the interaction manager.

      Returns string

    • get interactionEffect(): IInteractionEffect | undefined

      The effect that is applied to the node once the effect (selection, hovering or dragging) is active. If no interaction effect is applied, the effect will not be changed.

      Returns IInteractionEffect | undefined

    • set interactionEffect(value: IInteractionEffect | undefined): void

      The effect that is applied to the node once the effect (selection, hovering or dragging) is active. If no interaction effect is applied, the effect will not be changed.

      Parameters

      • value: IInteractionEffect | undefined

      Returns void

    • get removalKey(): string

      Returns string

    • set removalKey(value: string): void

      Parameters

      • value: string

      Returns void

    • get viewport(): IViewportApi | undefined

      The reference to the viewer.

      Returns IViewportApi | undefined

    • set viewport(value: IViewportApi | undefined): void

      The reference to the viewer.

      Parameters

      Returns void

    Methods

    • Called internally when adding the interaction manager to an interaction engine. Here the viewport is set.

      Parameters

      Returns void

    • For onDown events (pointerdown) this method is called. The pointer event is already translated into a ray. An array of intersections is provided that is the result of an intersection with the ray and the scene with the applied filters. (Note that filters of other InteractionManagers may also apply, therefore you need to sanitize the intersections in that case)

      Parameters

      Returns void

    • For onEnd events (pointerup, pointerout) this method is called. The pointer event is already translated into a ray. An array of intersections is provided that is the result of an intersection with the ray and the scene with the applied filters. (Note that filters of other InteractionManagers may also apply, therefore you need to sanitize the intersections in that case)

      Parameters

      Returns void

    • For onKeyDown events this method is called.

      Parameters

      • event: KeyboardEvent
      • pointerInCanvas: boolean

      Returns void

    • For onKeyUp events this method is called.

      Parameters

      • event: KeyboardEvent
      • pointerInCanvas: boolean

      Returns void

    • For onMove events (pointermove) this method is called. The pointer event is already translated into a ray. An array of intersections is provided that is the result of an intersection with the ray and the scene with the applied filters. (Note that filters of other InteractionManagers may also apply, therefore you need to sanitize the intersections in that case)

      Parameters

      Returns void

    • Called internally to remove the viewport from the manager and to clean up.

      Returns void

    • Select a node. The point and distance of the intersection can be freely chosen and are provided in the event callbacks.

      Parameters

      • intersection: Omit<IRayTracingIntersection, "type">

      Returns void