Viewer - Interaction
    Preparing search index...

    Class AbstractInteractionManagerAbstract

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    A filter that is applied during the intersection process. While intersecting, only nodes where this filter applies will be evaluated. The filters can be set per INTERACTION_STATE.

    Accessors

    • 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

    Methods

    • 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