Class SimpleToolWrapper

A simple class wrapper to inherit in your tool which contains the initialization and storage of the simple tool component utility. See one of the Simple samples to see how to use this class and the wrapper framework

Implements

IDisposable

Index

Constructors

Accessors

session simpleTool

Methods

setupSimpleTool teardown

Constructors

constructor

new SimpleToolWrapper(): SimpleToolWrapper
Returns SimpleToolWrapper

Accessors

session

get session(): IPlayerUISession<Record<string, never>>
Returns IPlayerUISession<Record<string, never>>
Remarks
The player UI session that the tool is running in Use this to access the player UI session, or any of the session's components

simpleTool

get simpleTool(): ISimpleTool
Returns ISimpleTool
Remarks
The simple tool instance that is created and managed by the wrapper Use this to access any of the tools components, or mess with the tools window visibility

Methods

setupSimpleTool

setupSimpleTool(
session: IPlayerUISession<Record<string, never>>,
options: ISimpleToolOptions,
): void
Parameters
- session: IPlayerUISession<Record<string, never>>
- options: ISimpleToolOptions
Returns void
Remarks
Setup the simple tool instance with the given options This will create and initialize the simple tool instance

teardown

teardown(): void
Returns void
Remarks
Teardown the simple tool instance This will call the teardown function on the simple tool instance This function is automatically invoked by the Editor Extension system when the editor is shutting down

Implementation of IDisposable.teardown