Skip to main content

TrackballRotateTool

Tool that rotates the camera in the plane defined by the viewPlaneNormal and the viewUp.

Hierarchy

Index

Constructors

constructor

Properties

publicconfiguration

configuration: Record<string, any>

publicmode

mode: ToolModes

Tool Mode - Active/Passive/Enabled/Disabled/

mouseDragCallback

mouseDragCallback: (evt: InteractionEventType) => void

Type declaration

    • (evt: InteractionEventType): void
    • Parameters

      • evt: InteractionEventType

      Returns void

publicsupportedInteractionTypes

supportedInteractionTypes: InteractionTypes[]

Supported Interaction Types - currently only Mouse

publictoolGroupId

toolGroupId: string

ToolGroup ID the tool instance belongs to

touchDragCallback

touchDragCallback: (evt: InteractionEventType) => void

Type declaration

    • (evt: InteractionEventType): void
    • Parameters

      • evt: InteractionEventType

      Returns void

statictoolName

toolName: any

Methods

_dragCallback

  • _dragCallback(evt: InteractionEventType): void
  • Parameters

    • evt: InteractionEventType

    Returns void

publicapplyActiveStrategy

  • applyActiveStrategy(enabledElement: IEnabledElement, operationData: unknown): any
  • Applies the active strategy function to the enabled element with the specified operation data.


    Parameters

    • enabledElement: IEnabledElement

      The element that is being operated on.

    • operationData: unknown

      The data that needs to be passed to the strategy.

    Returns any

    The result of the strategy.

publicapplyActiveStrategyCallback

  • applyActiveStrategyCallback(enabledElement: IEnabledElement, operationData: unknown, callbackType: string): any
  • Applies the active strategy, with a given event type being applied. The event type function is found by indexing it on the active strategy function.


    Parameters

    • enabledElement: IEnabledElement

      The element that is being operated on.

    • operationData: unknown

      The data that needs to be passed to the strategy.

    • callbackType: string

      the type of the callback

    Returns any

    The result of the strategy.

publicgetToolName

  • getToolName(): string
  • Returns the name of the tool


    Returns string

    The name of the tool.

rotateCamera

  • rotateCamera(viewport: any, centerWorld: any, axis: any, angle: any): void
  • Parameters

    • viewport: any
    • centerWorld: any
    • axis: any
    • angle: any

    Returns void

publicsetActiveStrategy

  • setActiveStrategy(strategyName: string): void
  • Sets the active strategy for a tool. Strategies are multiple implementations of tool behavior that can be switched by tool configuration.


    Parameters

    • strategyName: string

      name of the strategy to be set as active

    Returns void

publicsetConfiguration

  • setConfiguration(newConfiguration: Record<string, any>): void
  • merges the new configuration with the tool configuration


    Parameters

    • newConfiguration: Record<string, any>

    Returns void