Class AssetActiveCategoryRendererPlugin`Internal`

Plugin that handles the active categories for the asset preview. It is responsible for managing the state of the active categories and persisting it to the URL query, as well as syncing it with the layer manager.

Hierarchy

RendererPlugin & DisposableManaged & EventBus<Events, this> & Stateful<
    Write<
        WithCompute<WithDevtools<StoreApi<Store>>, ComputedStore>,
        StoreSubscribeWithSelector<Store & ComputedStore>,
    >,
    this,
>
- AssetActiveCategoryRendererPlugin

Implements

AssetRendererPlugin

Index

Constructors

constructor

Methods

activateCategory addDisposable addEventListener deactivateCategory dispatchEvent getActiveAndAvailableCategories getActiveCategories getCategoryStatus getInteractionMode getStore hookInitialize hookRegister? hookTeardown isTornDown setInteractionMode setMultiSelect

Constructors

constructor

new AssetActiveCategoryRendererPlugin(
    persisterBackend: LegacyCategoryStateStore,
    persister?: StatefulRendererPluginPersister,
    preferredCategory?: null | UserSelectableCategory,
    isAssetMeshable?: (asset: Asset) => boolean,
): AssetActiveCategoryRendererPlugin
Parameters
- persisterBackend: LegacyCategoryStateStore
- Optionalpersister: StatefulRendererPluginPersister
- preferredCategory: null | UserSelectableCategory = 'MESH'
- isAssetMeshable: (asset: Asset) => boolean = ...
Returns AssetActiveCategoryRendererPlugin
Overrides Mix(DisposableManaged, Evented<Events>(), Stateful(assetActiveCategoryRendererPluginStore)).constructor
- Defined in asset/category-select/src/lib/plugin/AssetActiveCategoryRendererPlugin.ts:45

Methods

activateCategory

activateCategory(category: UserSelectableCategory): void
Parameters
- category: UserSelectableCategory
Returns void
- Defined in asset/category-select/src/lib/plugin/AssetActiveCategoryRendererPlugin.ts:59

addDisposable

addDisposable(disposable: Disposable): void
Adds the given Disposable to be owned by this plugin.
Parameters
- disposable: Disposable
Returns void
Inherited from Mix(DisposableManaged, Evented<Events>(), Stateful(assetActiveCategoryRendererPluginStore)).addDisposable
- Defined in renderer-plugin/src/lib/mixins/DisposableManaged.ts:33

addEventListener

addEventListener<K extends keyof Events>(
event: K,
listener: (eventData: Events[K]) => void,
): EventHandle
Adds an event listener for a specific event.
Type Parameters
- K extends keyof Events
  The type of the event key.
Parameters
- event: K
  The event to listen to.
- listener: (eventData: Events[K]) => void
  The callback function to be invoked when the event is emitted.
Returns EventHandle
An EventHandle with a remove method to unsubscribe the listener.
Inherited from Mix(DisposableManaged, Evented<Events>(), Stateful(assetActiveCategoryRendererPluginStore)).addEventListener
- Defined in core/src/lib/Event/EventEmitter.ts:28

deactivateCategory

deactivateCategory(category: UserSelectableCategory): void
Parameters
- category: UserSelectableCategory
Returns void
- Defined in asset/category-select/src/lib/plugin/AssetActiveCategoryRendererPlugin.ts:63

dispatchEvent

dispatchEvent<K extends keyof Events>(...args: DispatchArgsOf<Events, K>): void
Dispatches the given event with given payload on the plugin.
Type Parameters
- K extends keyof Events
Parameters
- ...args: DispatchArgsOf<Events, K>
Returns void
Inherited from Mix(DisposableManaged, Evented<Events>(), Stateful(assetActiveCategoryRendererPluginStore)).dispatchEvent
- Defined in core/src/lib/Event/EventEmitter.ts:50

getActiveAndAvailableCategories

getActiveAndAvailableCategories(): ActivatableCategory[]
Returns ActivatableCategory[]
- Defined in asset/category-select/src/lib/plugin/AssetActiveCategoryRendererPlugin.ts:79

getActiveCategories

getActiveCategories(): ActivatableCategory[]
Returns ActivatableCategory[]
- Defined in asset/category-select/src/lib/plugin/AssetActiveCategoryRendererPlugin.ts:71

getCategoryStatus

getCategoryStatus(category: ActivatableCategory): undefined | CategoryStatus
Parameters
- category: ActivatableCategory
Returns undefined | CategoryStatus
- Defined in asset/category-select/src/lib/plugin/AssetActiveCategoryRendererPlugin.ts:75

getInteractionMode

getInteractionMode(): InteractionMode
Returns InteractionMode
See
InteractionMode
- Defined in asset/category-select/src/lib/plugin/AssetActiveCategoryRendererPlugin.ts:93

getStore

getStore(): Write
The store used by the plugin.

Returns Write
Deprecated
Do not use this directly in user-land code. Either:
- In React code, use the useRendererPluginStore or useRendererPluginStoreLazy hook.
- In non-React code, add methods to mutate the store to the plugin's API instead.
Inherited from Mix(DisposableManaged, Evented<Events>(), Stateful(assetActiveCategoryRendererPluginStore)).getStore
- Defined in renderer-plugin/src/lib/mixins/Stateful.ts:24

hookInitialize

hookInitialize(context: AssetRendererPluginContext): void
Parameters
- context: AssetRendererPluginContext
Returns void
Inherit Doc
Implementation of AssetRendererPlugin.hookInitialize
Overrides Mix(DisposableManaged, Evented<Events>(), Stateful(assetActiveCategoryRendererPluginStore)).hookInitialize
- Defined in asset/category-select/src/lib/plugin/AssetActiveCategoryRendererPlugin.ts:100

`Optional`hookRegister

hookRegister(context: unknown): boolean
Called when the plugin is registered in the system. The result of this hook determines whether the plugin is enabled.
Parameters
- context: unknown
  The context provided to the plugin.
Returns boolean
Whether the plugin should be enabled.
Implementation of AssetRendererPlugin.hookRegister
Inherited from Mix(DisposableManaged, Evented<Events>(), Stateful(assetActiveCategoryRendererPluginStore)).hookRegister
- Defined in renderer-plugin/src/lib/RendererPlugin.ts:9

hookTeardown

hookTeardown(context: unknown): void
Called when the plugin system is manually torn down. This should be used to clean up resources.
Parameters
- context: unknown
  The context provided to the plugin.
Returns void
Implementation of AssetRendererPlugin.hookTeardown
Inherited from Mix(DisposableManaged, Evented<Events>(), Stateful(assetActiveCategoryRendererPluginStore)).hookTeardown
- Defined in renderer-plugin/src/lib/RendererPlugin.ts:23

isTornDown

isTornDown(): boolean
Checks if the plugin has been torn down.

Returns boolean
true if the plugin has been torn down, otherwise false.
Inherited from Mix(DisposableManaged, Evented<Events>(), Stateful(assetActiveCategoryRendererPluginStore)).isTornDown
- Defined in renderer-plugin/src/lib/mixins/DisposableManaged.ts:28

setInteractionMode

setInteractionMode(interactionMode: InteractionMode): void
Parameters
- interactionMode: InteractionMode
Returns void
See
InteractionMode
- Defined in asset/category-select/src/lib/plugin/AssetActiveCategoryRendererPlugin.ts:86

setMultiSelect

setMultiSelect(value: boolean): void
Parameters
- value: boolean
Returns void
- Defined in asset/category-select/src/lib/plugin/AssetActiveCategoryRendererPlugin.ts:67

Class AssetActiveCategoryRendererPluginInternal

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns AssetActiveCategoryRendererPlugin

Methods

activateCategory

Parameters

Returns void

addDisposable

Parameters

Returns void

addEventListener

Type Parameters

Parameters

Returns EventHandle

deactivateCategory

Parameters

Returns void

dispatchEvent

Type Parameters

Parameters

Returns void

getActiveAndAvailableCategories

Returns ActivatableCategory[]

getActiveCategories

Returns ActivatableCategory[]

getCategoryStatus

Parameters

Returns undefined | CategoryStatus

getInteractionMode

Returns InteractionMode

See

getStore

Returns Write

Deprecated

hookInitialize

Parameters

Returns void

Inherit Doc

OptionalhookRegister

Parameters

Returns boolean

hookTeardown

Parameters

Returns void

isTornDown

Returns boolean

setInteractionMode

Parameters

Returns void

See

setMultiSelect

Parameters

Returns void

Settings

On This Page

Class AssetActiveCategoryRendererPlugin`Internal`

`Optional`hookRegister