Class DefaultTool

Hierarchy (view full)

Constructors

constructor

Properties

_currentToolIdMask app children? editor id initial? onContextMenu? onEnter? onExit? onKeyDown? onKeyUp? onMouseClick? onMouseDblClick? onMouseDown? onMouseEnter? onMouseLeave? onMouseMove? onMouseOut? onMouseOver? onMouseUp? onMouseWheel? onPointerCancel? onPointerDown? onPointerDownUp? onPointerMove? onPointerUp? parent type id initial

Methods

enter exit getCurrent getCurrentToolIdMask getIsActive getPath handleEvent setCurrentToolIdMask setIsActive transition children

Constructors

constructor

Properties

_currentToolIdMask

_currentToolIdMask: Ref<string> = ...

This is a hack / escape hatch that will tell the editor to report a different state as active (in getCurrentToolId()) when this state is active. This is usually used when a tool transitions to a child of a different state for a certain interaction and then returns to the original tool when that interaction completes; and where we would want to show the original tool as active in the UI.

app

app: App

Optional children

children?: Record<string, StateNode>

editor

editor: App

id

id: string

Optional initial

initial?: string

Optional onContextMenu

onContextMenu?: ((info) => void)

Type declaration

Optional onEnter

onEnter?: TLEnterEventHandler

Optional onExit

onExit?: TLExitEventHandler

Optional onKeyDown

onKeyDown?: ((info) => void)

Type declaration

Optional onKeyUp

onKeyUp?: ((info) => void)

Type declaration

Optional onMouseClick

onMouseClick?: ((info) => void)

Type declaration

Optional onMouseDblClick

onMouseDblClick?: ((info) => void)

Type declaration

Optional onMouseDown

onMouseDown?: ((info) => void)

Type declaration

Optional onMouseEnter

onMouseEnter?: ((info) => void)

Type declaration

Optional onMouseLeave

onMouseLeave?: ((info) => void)

Type declaration

Optional onMouseMove

onMouseMove?: ((info) => void)

Type declaration

Optional onMouseOut

onMouseOut?: ((info) => void)

Type declaration

Optional onMouseOver

onMouseOver?: ((info) => void)

Type declaration

Optional onMouseUp

onMouseUp?: ((info) => void)

Type declaration

Optional onMouseWheel

onMouseWheel?: ((info) => void)

Type declaration

Optional onPointerCancel

onPointerCancel?: ((info) => void)

Type declaration

Optional onPointerDown

onPointerDown?: ((info) => void)

Type declaration

Optional onPointerDownUp

onPointerDownUp?: ((info) => void)

Type declaration

Optional onPointerMove

onPointerMove?: ((info) => void)

Type declaration

Optional onPointerUp

onPointerUp?: ((info) => void)

Type declaration

parent

parent: StateNode

type

type: TLStateNodeType

Static id

id: string = 'default'

Static initial

initial: string = 'idle'

Methods

enter

exit

getCurrent

  • getCurrent(): any

  • This node's current active child node, if any.

    Returns any

getCurrentToolIdMask

getIsActive

  • getIsActive(): boolean

  • Whether this node is active.

    Returns boolean

getPath

  • getPath(): string

  • This node's path of active state nodes

    Returns string

handleEvent

setCurrentToolIdMask

setIsActive

transition

  • transition(id, info?): DefaultTool

  • Transition to a new active child state node.

    Parameters

    • id: string

      The id of the child state node to transition to.

    • info: {
          event?: InteractiveEvent;
          name?: string;
          object?: InteractiveObject;
          [key: string]: any;
      } = {}

      Any data to pass to the onEnter and onExit handlers.

    Returns DefaultTool

    Example

    parentState.transition('childStateA')
    parentState.transition('childStateB', { myData: 4 })

Static children

  • children(): typeof Idle[]

  • Returns typeof Idle[]

Settings

Member Visibility

Theme

On This Page