Class: XAtlasPlugin

Plugins.XAtlasPlugin

Hierarchy

• AViewerPlugin<"">

  ↳ XAtlasPlugin

Properties

PluginType

▪ Static Readonly PluginType: "XAtlasPlugin"

---

LIBRARY_PATH

▪ Static LIBRARY_PATH: string = 'https://cdn.jsdelivr.net/npm/[email protected]/dist/'

---

enabled

• enabled: boolean = true

Overrides

AViewerPlugin.enabled

---

useNormals

• useNormals: boolean = true

---

chartOptions

• chartOptions: UChartOptions

---

packOptions

• packOptions: UPackOptions

---

_dirty

• Protected _dirty: boolean = false

Inherited from

AViewerPlugin._dirty

---

_viewer

• Protected Optional _viewer: ViewerApp

Inherited from

AViewerPlugin._viewer

Accessors

dirty

• get dirty(): boolean

Returns

boolean

Inherited from

AViewerPlugin.dirty

• set dirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

AViewerPlugin.dirty

---

viewer

• get viewer(): undefined | ViewerApp

Returns

undefined | ViewerApp

Inherited from

AViewerPlugin.viewer

Methods

onAdded

▸ onAdded(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onAdded

---

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onDispose

---

onRemove

▸ onRemove(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

AViewerPlugin.onRemove

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

Inherited from

AViewerPlugin.toJSON

---

fromJSON

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

Parameters

Name	Type
data	any
meta?	any

Returns

null | XAtlasPlugin | Promise<null | XAtlasPlugin>

Inherited from

AViewerPlugin.fromJSON

---

exportState

▸ exportState(): any

Returns

any

Inherited from

AViewerPlugin.exportState

---

importState

▸ importState(state): Promise<void>

Parameters

Name	Type
state	any

Returns

Promise<void>

Inherited from

AViewerPlugin.importState

---

storeState

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

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

Inherited from

AViewerPlugin.storeState

---

loadState

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

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Inherited from

AViewerPlugin.loadState

---

loadLibrary

▸ loadLibrary(): Promise<void>

Returns

Promise<void>

---

unwrapGeometry

▸ unwrapGeometry(geometry, outputUv?, inputUv?): Promise<void>

Parameters

Name	Type	Default value
geometry	BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>	undefined
outputUv	"uv2" | "uv"	'uv'
inputUv	"uv2" | "uv"	'uv'

Returns

Promise<void>

---

packAtlas

▸ packAtlas(root, traverseChildren?, outputUv?, inputUv?): Promise<void>

Parameters

Name	Type	Default value
root	Object3D<Object3DEventMap> | Object3D<Object3DEventMap>[]	undefined
traverseChildren	boolean	true
outputUv	"uv2" | "uv"	'uv2'
inputUv	"uv2" | "uv"	'uv'

Returns

Promise<void>

---

unwrapSelected

▸ unwrapSelected(): Promise<void>

Returns

Promise<void>

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

AViewerPlugin._storeKey

Constructors

constructor

• new XAtlasPlugin(preload?)

Parameters

Name	Type	Default value
preload	boolean	false

Overrides

AViewerPlugin.constructor