Interface ToolSpecificOptions

interface ToolSpecificOptions {
    allowed_view_modes?: ViewMode;
    alt_tool?: string;
    animation_channel?: string;
    brush?: BrushOptions;
    cursor?: string;
    modes?: string[];
    paintTool?: boolean;
    raycast_options?: { edges?: boolean; vertices?: boolean };
    selectElements?: boolean;
    selectFace?: boolean;
    toolbar?: string;
    transform_toolbar?: string;
    transformerMode?:
        | ""
        | "translate"
        | "scale"
        | "rotate"
        | "stretch"
        | "hidden";
    onCanvasClick?(raycast_data: RaycastResult): void;
    onCanvasMouseMove?(raycast_data: false | RaycastResult): any;
    onCanvasRightClick?(raycast_data: RaycastResult): any;
    onSelect?(): void;
    onTextureEditorClick?(raycast_data: RaycastResult): any;
    onUnselect?(): void;
}

Hierarchy (View Summary)

ToolSpecificOptions
- Tool

Implemented by

Tool

Index

Methods

onCanvasClick? onCanvasMouseMove? onCanvasRightClick? onSelect? onTextureEditorClick? onUnselect?

Properties

allowed_view_modes? alt_tool? animation_channel? brush? cursor? modes? paintTool? raycast_options? selectElements? selectFace? toolbar? transform_toolbar? transformerMode?

Methods

`Optional`onCanvasClick

onCanvasClick?(raycast_data: RaycastResult): void
Parameters
- raycast_data: RaycastResult
Returns void
- Defined in types/generated/interface/actions.d.ts:334

`Optional`onCanvasMouseMove

onCanvasMouseMove?(raycast_data: false | RaycastResult): any
Parameters
- raycast_data: false | RaycastResult
Returns any
- Defined in types/generated/interface/actions.d.ts:337

`Optional`onCanvasRightClick

onCanvasRightClick?(raycast_data: RaycastResult): any
Parameters
- raycast_data: RaycastResult
Returns any
- Defined in types/generated/interface/actions.d.ts:338

`Optional`onSelect

onSelect?(): void
Returns void
- Defined in types/generated/interface/actions.d.ts:335

`Optional`onTextureEditorClick

onTextureEditorClick?(raycast_data: RaycastResult): any
Parameters
- raycast_data: RaycastResult
Returns any
- Defined in types/generated/interface/actions.d.ts:339

`Optional`onUnselect

onUnselect?(): void
Returns void
- Defined in types/generated/interface/actions.d.ts:336

Properties

`Optional`allowed_view_modes

allowed_view_modes?: ViewMode

`Optional`alt_tool

alt_tool?: string

`Optional`animation_channel

animation_channel?: string

`Optional`brush

brush?: BrushOptions

`Optional`cursor

cursor?: string

`Optional`modes

modes?: string[]

`Optional`paintTool

paintTool?: boolean

`Optional`raycast_options

raycast_options?: { edges?: boolean; vertices?: boolean }

`Optional`selectElements

selectElements?: boolean

`Optional`selectFace

selectFace?: boolean

`Optional`toolbar

toolbar?: string

`Optional`transform_toolbar

transform_toolbar?: string

`Optional`transformerMode

transformerMode?: "" | "translate" | "scale" | "rotate" | "stretch" | "hidden"