Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GumballTransform

Hierarchy

  • TransformationToolsManager
    • GumballTransform

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

  • new GumballTransform(viewport: IViewportApi, nodes: ITreeNode[], settings?: Partial<GumballTransformSettings>, id?: string): GumballTransform

  • Parameters

    • viewport: IViewportApi
    • nodes: ITreeNode[]
    • Optional settings: Partial<GumballTransformSettings>
    • Optional id: string

    Returns GumballTransform

Accessors

Protected canvasEventListenerToken

  • get canvasEventListenerToken(): string

  • Returns string

closed

  • get closed(): boolean

  • Check if the Transformations Tools are currently active.

    Returns boolean

enableRotation

  • get enableRotation(): boolean
  • set enableRotation(value: boolean): void

  • Returns boolean

  • Parameters

    • value: boolean

    Returns void

enableScaling

  • get enableScaling(): boolean
  • set enableScaling(value: boolean): void

  • Returns boolean

  • Parameters

    • value: boolean

    Returns void

enableTranslation

  • get enableTranslation(): boolean
  • set enableTranslation(value: boolean): void

  • Returns boolean

  • Parameters

    • value: boolean

    Returns void

id

  • get id(): string

  • The id of the transformation tools instance. This can be used to identify the transformation tools instance and is useful when working with multiple transformation tools instances.

    Returns string

Protected initialOffset

  • get initialOffset(): vec3

  • Returns vec3

Protected initialTransform

  • get initialTransform(): mat4[]

  • Returns mat4[]

Protected instanceTransform

  • get instanceTransform(): mat4[]

  • Returns mat4[]

Protected keysPressed

  • get keysPressed(): {}

  • Returns {}

    • [key: string]: boolean

Protected nodes

  • get nodes(): ITreeNode[]

  • Returns ITreeNode[]

Protected parentObject

  • get parentObject(): Object3D<Object3DEventMap>

  • Returns Object3D<Object3DEventMap>

Protected pivotOffset

  • get pivotOffset(): mat4

  • Returns mat4

Protected previousTransformationToolsMatrix

  • get previousTransformationToolsMatrix(): mat4[]

  • Returns mat4[]

Protected restrictionManager

  • get restrictionManager(): undefined | IRestrictionManager

  • Returns undefined | IRestrictionManager

Protected reuseTransformation

  • get reuseTransformation(): boolean

  • Returns boolean

scale

  • get scale(): number

  • Returns number

settings

  • get settings(): undefined | Partial<Settings>

  • Returns undefined | Partial<Settings>

show

  • get show(): boolean
  • set show(value: boolean): void

  • Show or hide the Transformation Tools.

    Returns boolean

  • Show or hide the Transformation Tools.

    Parameters

    • value: boolean

    Returns void

Protected singleNode

  • get singleNode(): boolean

  • Returns boolean

space

  • get space(): "local" | "world"

  • Returns "local" | "world"

transformationToolsPlaceholderMatrix

  • get transformationToolsPlaceholderMatrix(): mat4

  • Returns mat4

type

  • get type(): "gumball"

  • Returns "gumball"

Protected viewport

  • get viewport(): IViewportApi

  • Returns IViewportApi

Methods

close

  • close(): void

  • Close the transformation tools and remove it from the viewport.

    Returns void

closeLogic

  • closeLogic(): void

  • Returns void

Protected getMatrix

  • getMatrix(previousMatrix: mat4, instanceMatrix: mat4): mat4

  • Parameters

    • previousMatrix: mat4
    • instanceMatrix: mat4

    Returns mat4

Protected initialize

  • initialize(): mat4

  • Returns mat4

keyPressed

  • keyPressed(key: string | string[]): boolean

  • Parameters

    • key: string | string[]

    Returns boolean

onKeyDown

  • onKeyDown(event: KeyboardEvent, pointerInCanvas: boolean): void

  • Parameters

    • event: KeyboardEvent
    • pointerInCanvas: boolean

    Returns void

onKeyDownLogic

  • onKeyDownLogic(event: KeyboardEvent, pointerInCanvas: boolean): void

  • Parameters

    • event: KeyboardEvent
    • pointerInCanvas: boolean

    Returns void

onKeyUp

  • onKeyUp(event: KeyboardEvent, pointerInCanvas: boolean): void

  • Parameters

    • event: KeyboardEvent
    • pointerInCanvas: boolean

    Returns void

onKeyUpLogic

  • onKeyUpLogic(event: KeyboardEvent, pointerInCanvas: boolean): void

  • Parameters

    • event: KeyboardEvent
    • pointerInCanvas: boolean

    Returns void

onMouseWheel

  • onMouseWheel(event: WheelEvent): void

onPointerDown

  • onPointerDown(event: PointerEvent): void

onPointerDownLogic

  • onPointerDownLogic(event: PointerEvent): void

  • Parameters

    • event: PointerEvent

    Returns void

onPointerEnd

  • onPointerEnd(event: PointerEvent): void

onPointerEndLogic

  • onPointerEndLogic(event: PointerEvent): void

  • Parameters

    • event: PointerEvent

    Returns void

onPointerMove

  • onPointerMove(event: PointerEvent): void

onPointerMoveLogic

  • onPointerMoveLogic(event: PointerEvent): void

  • Parameters

    • event: PointerEvent

    Returns void

onPointerOut

  • onPointerOut(event: PointerEvent): void

onPointerOutLogic

  • onPointerOutLogic(event: PointerEvent): void

  • Parameters

    • event: PointerEvent

    Returns void

onPointerUp

  • onPointerUp(event: PointerEvent): void

  • Parameters

    • event: PointerEvent

    Returns void

onPointerUpLogic

  • onPointerUpLogic(event: PointerEvent): void

  • Parameters

    • event: PointerEvent

    Returns void

Protected toggleCameraFreeze

  • toggleCameraFreeze(freeze: boolean): void

  • Parameters

    • freeze: boolean

    Returns void

Protected updateObjectMatrices

  • updateObjectMatrices(): void

  • Returns void

Protected updateObjects

  • updateObjects(): void

  • Returns void