Class TroikaTextPlugin

Plugin that adds support for troika text objects. The plugin extends troika Text with uiconfig, g-buffer and serialization support. It also adds a generator to the Object3DGeneratorPlugin to create text objects from the UI.

Hierarchy

AViewerPluginSync<TroikaTextPluginEventMap>
- TroikaTextPlugin

Index

Constructors

constructor

new TroikaTextPlugin(useWorker?: boolean): TroikaTextPlugin
Parameters
- useWorker: boolean = true
Returns TroikaTextPlugin
Overrides AViewerPluginSync<TroikaTextPluginEventMap>.constructor
- Defined in plugins/troika-text/src/TroikaTextPlugin.ts:24

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected` `Optional`_viewer

_viewer?: ThreeViewer

`Protected`_viewerListeners

_viewerListeners: PartialRecord<IViewerEventTypes, (e: IViewerEvent) => void> = {}

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

dependencies

dependencies: typeof Object3DGeneratorPlugin[] = ...

enabled

enabled: boolean = true

isViewerPluginSync

isViewerPluginSync: true = ...

`Optional`uiConfig

uiConfig?: UiObjectConfig<any, string, any> = undefined

`Static` `Optional` `Readonly`OldPluginType

OldPluginType?: string

`Static` `Readonly`PluginType

PluginType: "TroikaTextPlugin" = 'TroikaTextPlugin'

Accessors

dirty

get dirty(): boolean
Returns boolean
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:113
set dirty(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:117

Methods

`Protected`_onViewerEvent

_onViewerEvent(e: IViewerEvent): IViewerEvent
Parameters
- e: IViewerEvent
Returns IViewerEvent
Inherited from AViewerPluginSync._onViewerEvent
- Defined in src/viewer/AViewerPlugin.ts:69

`Protected`_storeKey

_storeKey(prefix?: string): string
Parameters
- Optionalprefix: string
Returns string
Inherited from AViewerPluginSync._storeKey
- Defined in src/viewer/AViewerPlugin.ts:55

createText

createText(params?: any): Object3D2<IObject3DEventMap, undefined, undefined>
Parameters
- Optionalparams: any
Returns Object3D2<IObject3DEventMap, undefined, undefined>
- Defined in plugins/troika-text/src/TroikaTextPlugin.ts:37

createTextChild

createTextChild(
material?: IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
): any
Parameters
- Optionalmaterial: IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[]
Returns any
- Defined in plugins/troika-text/src/TroikaTextPlugin.ts:141

disable

disable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from AViewerPluginSync.disable
- Defined in src/viewer/AViewerPlugin.ts:76

dispose

dispose(): void
Returns void
Inherited from AViewerPluginSync.dispose
- Defined in src/viewer/AViewerPlugin.ts:35

enable

enable(key: any, setDirty?: boolean): void
Parameters
- key: any
- setDirty: boolean = true
Returns void
Inherited from AViewerPluginSync.enable
- Defined in src/viewer/AViewerPlugin.ts:81

exportState

exportState(): ISerializedConfig | Record<string, never>
Returns ISerializedConfig | Record<string, never>
Inherited from AViewerPluginSync.exportState
- Defined in src/viewer/AViewerPlugin.ts:60

fromJSON

fromJSON(
data: ISerializedConfig,
meta?: SerializationMetaType,
): null | TroikaTextPlugin | Promise<null | TroikaTextPlugin>
Parameters
- data: ISerializedConfig
- Optionalmeta: SerializationMetaType
Returns null | TroikaTextPlugin | Promise<null | TroikaTextPlugin>
Inherited from AViewerPluginSync.fromJSON
- Defined in src/viewer/AViewerPlugin.ts:47

importState

importState(state: any): Promise<void>
Parameters
- state: any
Returns Promise<void>
Inherited from AViewerPluginSync.importState
- Defined in src/viewer/AViewerPlugin.ts:63

isDisabled

isDisabled(): boolean
Returns boolean
Inherited from AViewerPluginSync.isDisabled
- Defined in src/viewer/AViewerPlugin.ts:86

onAdded

onAdded(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onAdded
- Defined in plugins/troika-text/src/TroikaTextPlugin.ts:52

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onRemove
- Defined in plugins/troika-text/src/TroikaTextPlugin.ts:68

`Optional`setDirty

setDirty(...args: any[]): any
Parameters
- ...args: any[]
Returns any
Inherited from AViewerPluginSync.setDirty
- Defined in src/viewer/AViewerPlugin.ts:90

setupTextWrapper

setupTextWrapper(
textWrapper: IObject3D,
material?: IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
): void
Parameters
- textWrapper: IObject3D
- Optionalmaterial: IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[]
Returns void
- Defined in plugins/troika-text/src/TroikaTextPlugin.ts:77

toJSON

toJSON(meta?: SerializationMetaType): ISerializedConfig
Parameters
- Optionalmeta: SerializationMetaType
Returns ISerializedConfig
Inherited from AViewerPluginSync.toJSON
- Defined in src/viewer/AViewerPlugin.ts:39

updateText

updateText(
    textWrapper: IObject3D,
    params?: any,
):
    | undefined
    | Object3D2<IObject3DEventMap, undefined, undefined>
    | IObject3D<
        IObject3DEventMap,
        undefined
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    >
Parameters
- textWrapper: IObject3D
- Optionalparams: any
Returns
    | undefined
    | Object3D2<IObject3DEventMap, undefined, undefined>
    | IObject3D<
        IObject3DEventMap,
        undefined
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    >
- Defined in plugins/troika-text/src/TroikaTextPlugin.ts:96

Class TroikaTextPlugin

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns TroikaTextPlugin

Properties

Protected_dirty

Protected Optional_viewer

Protected_viewerListeners

constructor

dependencies

enabled

isViewerPluginSync

OptionaluiConfig

Static Optional ReadonlyOldPluginType

Static ReadonlyPluginType

Accessors

dirty

Returns boolean

Parameters

Returns void

Methods

Protected_onViewerEvent

Parameters

Returns IViewerEvent

Protected_storeKey

Parameters

Returns string

createText

Parameters

Returns Object3D2<IObject3DEventMap, undefined, undefined>

createTextChild

Parameters

Returns any

disable

Parameters

Returns void

dispose

Returns void

enable

Parameters

Returns void

exportState

Returns ISerializedConfig | Record<string, never>

fromJSON

Parameters

Returns null | TroikaTextPlugin | Promise<null | TroikaTextPlugin>

importState

Parameters

Returns Promise<void>

isDisabled

Returns boolean

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

OptionalsetDirty

Parameters

Returns any

setupTextWrapper

Parameters

Returns void

toJSON

Parameters

Returns ISerializedConfig

updateText

Parameters

Returns | undefined | Object3D2<IObject3DEventMap, undefined, undefined> | IObject3D< IObject3DEventMap, undefined | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>, undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[], >

Settings

On This Page

`Protected`_dirty

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Optional`uiConfig

`Static` `Optional` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_onViewerEvent

`Protected`_storeKey

`Optional`setDirty

Returns
| undefined
| Object3D2<IObject3DEventMap, undefined, undefined>
| IObject3D<
IObject3DEventMap,
undefined
| IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
>