Skip to main content

Class: SimpleTextPlugin

Plugins.SimpleTextPlugin

Hierarchy

Properties

PluginType

Static Readonly PluginType: "SimpleTextPlugin"

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:106


enabled

enabled: boolean = true

Overrides

AViewerPlugin.enabled

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:107


options

options: TextSVGOptions

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:118


applyToMap

applyToMap: boolean = true

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:122


applyToBumpMap

applyToBumpMap: boolean = false

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:125


applyToAlphaMap

applyToAlphaMap: boolean = true

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:128


inverseAlphaMap

inverseAlphaMap: boolean = false

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:131


fonts

fonts: Record<string, string>

List of font names and paths to font files.

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:248


_dirty

Protected _dirty: boolean = false

Inherited from

AViewerPlugin._dirty

Defined in

webgi/src/core/AViewerPlugin.ts:23


_viewer

Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

Defined in

webgi/src/core/AViewerPlugin.ts:27

Accessors

dirty

get dirty(): boolean

Returns

boolean

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:16

set dirty(value): void

Parameters

NameType
valueboolean

Returns

void

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:20

Methods

onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose

Defined in

webgi/src/core/AViewerPlugin.ts:36


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onRemove

Defined in

webgi/src/core/AViewerPlugin.ts:40


toJSON

toJSON(meta?): any

Parameters

NameType
meta?any

Returns

any

Inherited from

AViewerPlugin.toJSON

Defined in

webgi/src/core/AViewerPlugin.ts:45


fromJSON

fromJSON(data, meta?): null | SimpleTextPlugin | Promise<null | SimpleTextPlugin>

Parameters

NameType
dataany
meta?any

Returns

null | SimpleTextPlugin | Promise<null | SimpleTextPlugin>

Inherited from

AViewerPlugin.fromJSON

Defined in

webgi/src/core/AViewerPlugin.ts:52


exportState

exportState(): any

Returns

any

Inherited from

AViewerPlugin.exportState

Defined in

webgi/src/core/AViewerPlugin.ts:64


importState

importState(state): Promise<void>

Parameters

NameType
stateany

Returns

Promise<void>

Inherited from

AViewerPlugin.importState

Defined in

webgi/src/core/AViewerPlugin.ts:67


storeState

storeState(prefix?, storage?, data?): void

Parameters

NameType
prefix?string
storage?Storage
data?any

Returns

void

Inherited from

AViewerPlugin.storeState

Defined in

webgi/src/core/AViewerPlugin.ts:74


loadState

loadState(prefix?, storage?): Promise<void>

Parameters

NameType
prefix?string
storage?Storage

Returns

Promise<void>

Inherited from

AViewerPlugin.loadState

Defined in

webgi/src/core/AViewerPlugin.ts:84


getSelected

getSelected<T>(): undefined | T

Type parameters

NameType
Textends Object3D<Event, string, T>

Returns

undefined | T

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:108


onAdded

onAdded(v): Promise<void>

Parameters

NameType
vViewerApp

Returns

Promise<void>

Overrides

AViewerPlugin.onAdded

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:110


addTextToSelected

addTextToSelected(): Promise<void>

Returns

Promise<void>

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:176


addText

addText(obj, data?): Promise<void>

Parameters

NameType
objMesh<BufferGeometry<NormalBufferAttributes, Event, string>, Material<Event, string> | Material<Event, string>[]>
data?ITextSVGOptions

Returns

Promise<void>

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:196


updateText

updateText(obj, data): Promise<void>

Parameters

NameType
objMesh<BufferGeometry<NormalBufferAttributes, Event, string>, Material<Event, string> | Material<Event, string>[]>
dataITextSVGOptions

Returns

Promise<void>

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:199


makeTextSvg

makeTextSvg(options): Promise<undefined | Texture>

Parameters

NameType
optionsITextSVGOptions

Returns

Promise<undefined | Texture>

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:252


_storeKey

Protected _storeKey(prefix?): string

Parameters

NameType
prefix?string

Returns

string

Inherited from

AViewerPlugin._storeKey

Defined in

webgi/src/core/AViewerPlugin.ts:60


_getAssetData

Protected _getAssetData(path): Promise<string>

Parameters

NameType
pathstring

Returns

Promise<string>

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:280

Constructors

constructor

new SimpleTextPlugin()

Overrides

AViewerPlugin.constructor

Defined in

webgi/src/plugins/SimpleTextPlugin.ts:133