Babylon.js API documentation|

Class GizmoHandle Abstract

Base class for SlateGizmo handles

Hierarchy

GizmoHandle
- SideHandle
- CornerHandle

Index

Constructors

constructor

Properties

node

Accessors

Methods

Constructors

constructor

new GizmoHandle(gizmo: SlateGizmo, scene: Scene): GizmoHandle

- Defined in .temp/docdirectory/doc.d.ts:128042
Creates a handle for a SlateGizmo

Parameters
- gizmo: SlateGizmo
  
  associated SlateGizmo
- scene: Scene
  
  scene
Returns GizmoHandle

Properties

node Search playground for node

node: TransformNode

Node of this handle

Accessors

drag

set drag(value: boolean): void

- Defined in .temp/docdirectory/doc.d.ts:128032
Sets drag state

Parameters
- value: boolean
Returns void

gizmo

get gizmo(): SlateGizmo

- Defined in .temp/docdirectory/doc.d.ts:128024
Returns the gizmo carrying this handle

Returns SlateGizmo

hover

set hover(value: boolean): void

- Defined in .temp/docdirectory/doc.d.ts:128028
Sets hover state

Parameters
- value: boolean
Returns void

state

get state(): HandleState

- Defined in .temp/docdirectory/doc.d.ts:128019
The current state of the handle

Returns HandleState

Methods

Abstract createNode Search playground for createNode

createNode(): TransformNode

- Defined in .temp/docdirectory/doc.d.ts:128061
Creates the meshes and parent node of the handle Should be overridden by child classes

Returns TransformNode
created node

dispose Search playground for dispose

dispose(): void

- Defined in .temp/docdirectory/doc.d.ts:128065
Disposes the handle

Returns void

setDragBehavior Search playground for setDragBehavior

setDragBehavior(dragStartFn: ((event: { position: Vector3 }) => void), dragFn: ((event: { position: Vector3 }) => void), dragEndFn: (() => void)): void

- Defined in .temp/docdirectory/doc.d.ts:128051
Binds callbacks from dragging interaction

Parameters
- dragStartFn: ((event: { position: Vector3 }) => void)
  
  Function to call on drag start
  - - (event: { position: Vector3 }): void
    - Parameters
      - event: { position: Vector3 }
        position: Vector3
      Returns void
- dragFn: ((event: { position: Vector3 }) => void)
  
  Function to call on drag
  - - (event: { position: Vector3 }): void
    - Parameters
      - event: { position: Vector3 }
        position: Vector3
      Returns void
- dragEndFn: (() => void)
  
  Function to call on drag end
  - - (): void
    - Returns void
Returns void