TrackballRotateTool

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

Hierarchy

• BaseTool
  • TrackballRotateTool

Index

Constructors

• constructor

Properties

• _resizeObservers
• _viewportAddedListener
• cleanUp
• configuration
• mode
• mouseDragCallback
• supportedInteractionTypes
• toolGroupId
• touchDragCallback
• toolName

Methods

• _dragCallback
• _getViewportsInfo
• applyActiveStrategy
• applyActiveStrategyCallback
• getToolName
• onSetToolActive
• onSetToolDisabled
• preMouseDownCallback
• rotateCamera
• setActiveStrategy
• setConfiguration

Constructors

constructor

• new TrackballRotateTool(toolProps?: PublicToolProps, defaultToolProps?: SharedToolProp): TrackballRotateTool

• Overrides BaseTool.constructor

  Parameters

  • toolProps: PublicToolProps = {}

  • defaultToolProps: SharedToolProp = ...

  Returns TrackballRotateTool

Properties

_resizeObservers

_resizeObservers: Map<any, any> = ...

_viewportAddedListener

_viewportAddedListener: (evt: any) => void

Type declaration

• • (evt: any): void

  • Parameters

    • evt: any

    Returns void

cleanUp

cleanUp: () => void

Type declaration

• • (): void

  • Returns void

publicconfiguration

configuration: Record<string, any>

Inherited from BaseTool.configuration

publicmode

mode: ToolModes

Inherited from BaseTool.mode

Tool Mode - Active/Passive/Enabled/Disabled/

mouseDragCallback

mouseDragCallback: (evt: InteractionEventType) => void

Type declaration

• • (evt: InteractionEventType): void

  • Parameters

    • evt: InteractionEventType

    Returns void

publicsupportedInteractionTypes

supportedInteractionTypes: InteractionTypes[]

Inherited from BaseTool.supportedInteractionTypes

Supported Interaction Types - currently only Mouse

publictoolGroupId

toolGroupId: string

Inherited from BaseTool.toolGroupId

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

Overrides BaseTool.toolName

Methods

_dragCallback

• _dragCallback(evt: InteractionEventType): void

• Parameters

  • evt: InteractionEventType

  Returns void

_getViewportsInfo

• _getViewportsInfo(): any[]

• Returns any[]

publicapplyActiveStrategy

• applyActiveStrategy(enabledElement: IEnabledElement, operationData: unknown): any

• Inherited from BaseTool.applyActiveStrategy

  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

• Inherited from BaseTool.applyActiveStrategyCallback

  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

• Inherited from BaseTool.getToolName

  Returns the name of the tool

  ---

  Returns string

  The name of the tool.

onSetToolActive

• onSetToolActive(): void

• Returns void

onSetToolDisabled

• onSetToolDisabled(): void

• Returns void

preMouseDownCallback

• preMouseDownCallback(evt: InteractionEventType): boolean

• Parameters

  • evt: InteractionEventType

  Returns boolean

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

• Inherited from BaseTool.setActiveStrategy

  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

• Inherited from BaseTool.setConfiguration

  merges the new configuration with the tool configuration

  ---

  Parameters

  • newConfiguration: Record<string, any>

  Returns void