Class SimpleToolWrapper`Beta`

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
Beta
Returns SimpleToolWrapper

Accessors

session

get session(): IPlayerUISession<Record<string, never>>
Beta
Returns IPlayerUISession<Record<string, never>>

simpleTool

get simpleTool(): ISimpleTool
Beta
Returns ISimpleTool

Methods

setupSimpleTool

setupSimpleTool(
session: IPlayerUISession<Record<string, never>>,
options: ISimpleToolOptions,
): void
Beta
Parameters
- session: IPlayerUISession<Record<string, never>>
- options: ISimpleToolOptions
Returns void

teardown

teardown(): void
Beta
Returns void
Remarks
Initiates the teardown and cleanup of this disposable item.

Implementation of IDisposable.teardown