Class GumballTransform

Hierarchy

TransformationToolsManager
- GumballTransform

Implements

IGumballTransform

Constructors

constructor

new GumballTransform(
    viewport: IViewportApi,
    nodes: ITreeNode[],
    settings?: Partial<GumballTransformSettings>,
    id?: string,
): GumballTransform
Parameters
- viewport: IViewportApi
- nodes: ITreeNode[]
- Optionalsettings: Partial<GumballTransformSettings>
- Optionalid: string
Returns GumballTransform
Overrides TransformationToolsManager.constructor

Accessors

`Protected`canvasEventListenerToken

get canvasEventListenerToken(): string
Returns string
Inherited from TransformationToolsManager.canvasEventListenerToken

closed

get closed(): boolean
Check if the Transformations Tools are currently active.

Returns boolean
Implementation of IGumballTransform.closed
Inherited from TransformationToolsManager.closed

enableRotation

get enableRotation(): boolean
Returns boolean
set enableRotation(value: boolean): void
Parameters
- value: boolean
Returns void

enableScaling

get enableScaling(): boolean
Returns boolean
set enableScaling(value: boolean): void
Parameters
- value: boolean
Returns void

enableTranslation

get enableTranslation(): boolean
Returns boolean
set enableTranslation(value: boolean): void
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
Implementation of IGumballTransform.id
Inherited from TransformationToolsManager.id

`Protected`initialOffset

get initialOffset(): vec3
Returns vec3
Inherited from TransformationToolsManager.initialOffset

`Protected`initialTransform

get initialTransform(): mat4[]
Returns mat4[]
Inherited from TransformationToolsManager.initialTransform

`Protected`instanceTransform

get instanceTransform(): mat4[]
Returns mat4[]
Inherited from TransformationToolsManager.instanceTransform

`Protected`keysPressed

get keysPressed(): { [key: string]: boolean }
Returns { [key: string]: boolean }
Inherited from TransformationToolsManager.keysPressed

`Protected`nodes

get nodes(): ITreeNode[]
Returns ITreeNode[]
Inherited from TransformationToolsManager.nodes

`Protected`parentObject

get parentObject(): Object3D
Returns Object3D
Inherited from TransformationToolsManager.parentObject

`Protected`pivotOffset

get pivotOffset(): mat4
Returns mat4
Inherited from TransformationToolsManager.pivotOffset

`Protected`previousTransformationToolsMatrix

get previousTransformationToolsMatrix(): mat4[]
Returns mat4[]
Inherited from TransformationToolsManager.previousTransformationToolsMatrix

`Protected`restrictionManager

get restrictionManager(): IRestrictionManager | undefined
Returns IRestrictionManager | undefined
Inherited from TransformationToolsManager.restrictionManager

`Protected`reuseTransformation

get reuseTransformation(): boolean
Returns boolean
Inherited from TransformationToolsManager.reuseTransformation

scale

get scale(): number
Returns number

settings

get settings(): Partial<Settings> | undefined
Returns Partial<Settings> | undefined
Inherited from TransformationToolsManager.settings

show

get show(): boolean
Show or hide the Transformation Tools.

Returns boolean
Implementation of IGumballTransform.show
Inherited from TransformationToolsManager.show
set show(value: boolean): void
Show or hide the Transformation Tools.
Parameters
- value: boolean
Returns void
Implementation of IGumballTransform.show
Inherited from TransformationToolsManager.show

`Protected`singleNode

get singleNode(): boolean
Returns boolean
Inherited from TransformationToolsManager.singleNode

space

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

transformationToolsPlaceholderMatrix

get transformationToolsPlaceholderMatrix(): mat4
Returns mat4
Overrides TransformationToolsManager.transformationToolsPlaceholderMatrix

type

get type(): "gumball"
Returns "gumball"
Overrides TransformationToolsManager.type

`Protected`viewport

get viewport(): IViewportApi
Returns IViewportApi
Inherited from TransformationToolsManager.viewport

Methods

close

close(): void
Close the transformation tools and remove it from the viewport.

Returns void
Implementation of IGumballTransform.close
Inherited from TransformationToolsManager.close

closeLogic

closeLogic(): void
Returns void
Overrides TransformationToolsManager.closeLogic

`Protected`getMatrix

getMatrix(previousMatrix: mat4, instanceMatrix: mat4): mat4
Parameters
- previousMatrix: mat4
- instanceMatrix: mat4
Returns mat4
Inherited from TransformationToolsManager.getMatrix

`Protected`initialize

initialize(): mat4
Returns mat4
Inherited from TransformationToolsManager.initialize

keyPressed

keyPressed(key: string | string[]): boolean
Parameters
- key: string | string[]
Returns boolean
Inherited from TransformationToolsManager.keyPressed

onKeyDown

onKeyDown(event: KeyboardEvent, pointerInCanvas: boolean): void
Parameters
- event: KeyboardEvent
- pointerInCanvas: boolean
Returns void
Implementation of IGumballTransform.onKeyDown
Inherited from TransformationToolsManager.onKeyDown

onKeyDownLogic

onKeyDownLogic(event: KeyboardEvent, pointerInCanvas: boolean): void
Parameters
- event: KeyboardEvent
- pointerInCanvas: boolean
Returns void
Overrides TransformationToolsManager.onKeyDownLogic

onKeyUp

onKeyUp(event: KeyboardEvent, pointerInCanvas: boolean): void
Parameters
- event: KeyboardEvent
- pointerInCanvas: boolean
Returns void
Implementation of IGumballTransform.onKeyUp
Inherited from TransformationToolsManager.onKeyUp

onKeyUpLogic

onKeyUpLogic(event: KeyboardEvent, pointerInCanvas: boolean): void
Parameters
- event: KeyboardEvent
- pointerInCanvas: boolean
Returns void
Overrides TransformationToolsManager.onKeyUpLogic

onMouseWheel

onMouseWheel(event: WheelEvent): void
Parameters
- event: WheelEvent
Returns void
Implementation of IGumballTransform.onMouseWheel
Overrides TransformationToolsManager.onMouseWheel

onPointerDown

onPointerDown(event: PointerEvent): void
Parameters
- event: PointerEvent
Returns void
Implementation of IGumballTransform.onPointerDown
Inherited from TransformationToolsManager.onPointerDown

onPointerDownLogic

onPointerDownLogic(event: PointerEvent): void
Parameters
- event: PointerEvent
Returns void
Overrides TransformationToolsManager.onPointerDownLogic

onPointerEnd

onPointerEnd(event: PointerEvent): void
Parameters
- event: PointerEvent
Returns void
Implementation of IGumballTransform.onPointerEnd
Inherited from TransformationToolsManager.onPointerEnd

onPointerEndLogic

onPointerEndLogic(event: PointerEvent): void
Parameters
- event: PointerEvent
Returns void
Overrides TransformationToolsManager.onPointerEndLogic

onPointerMove

onPointerMove(event: PointerEvent): void
Parameters
- event: PointerEvent
Returns void
Implementation of IGumballTransform.onPointerMove
Inherited from TransformationToolsManager.onPointerMove

onPointerMoveLogic

onPointerMoveLogic(event: PointerEvent): void
Parameters
- event: PointerEvent
Returns void
Overrides TransformationToolsManager.onPointerMoveLogic

onPointerOut

onPointerOut(event: PointerEvent): void
Parameters
- event: PointerEvent
Returns void
Implementation of IGumballTransform.onPointerOut
Inherited from TransformationToolsManager.onPointerOut

onPointerOutLogic

onPointerOutLogic(event: PointerEvent): void
Parameters
- event: PointerEvent
Returns void
Overrides TransformationToolsManager.onPointerOutLogic

onPointerUp

onPointerUp(event: PointerEvent): void
Parameters
- event: PointerEvent
Returns void
Implementation of IGumballTransform.onPointerUp
Inherited from TransformationToolsManager.onPointerUp

onPointerUpLogic

onPointerUpLogic(event: PointerEvent): void
Parameters
- event: PointerEvent
Returns void
Overrides TransformationToolsManager.onPointerUpLogic

`Protected`toggleCameraFreeze

toggleCameraFreeze(freeze: boolean): void
Parameters
- freeze: boolean
Returns void
Inherited from TransformationToolsManager.toggleCameraFreeze

`Protected`updateObjectMatrices

updateObjectMatrices(): void
Returns void
Inherited from TransformationToolsManager.updateObjectMatrices

`Protected`updateObjects

updateObjects(): void
Returns void
Inherited from TransformationToolsManager.updateObjects