Class: DiamondPlugin

Plugins.DiamondPlugin

Hierarchy

• BaseIJewel3DKeyPlugin<"">

  ↳ DiamondPlugin

Properties

PluginType

▪ Static Readonly PluginType: "Diamond"

---

DIAMOND_GLTF_EXTENSION

▪ Static Readonly DIAMOND_GLTF_EXTENSION: "WEBGI_materials_diamond"

---

offsetCache

• offsetCache: Record<string, IDiamondGeometryOffsets> = {}

---

enabled

• enabled: boolean = true

Overrides

BaseIJewel3DKeyPlugin.enabled

---

envMap

• envMap: null | ITexture<any> = null

---

envMap2

• envMap2: null | ITexture<any> = null

---

envMap3

• envMap3: null | ITexture<any> = null

---

forceSceneEnvMap

• forceSceneEnvMap: boolean = false

---

uiConfig

• uiConfig: UiObjectConfig<any, string>

---

_dirty

• Protected _dirty: boolean = false

Inherited from

BaseIJewel3DKeyPlugin._dirty

---

_viewer

• Protected Optional _viewer: ViewerApp

Inherited from

BaseIJewel3DKeyPlugin._viewer

Accessors

dirty

• get dirty(): boolean

Returns

boolean

Inherited from

BaseIJewel3DKeyPlugin.dirty

• set dirty(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

BaseIJewel3DKeyPlugin.dirty

---

viewer

• get viewer(): undefined | ViewerApp

Returns

undefined | ViewerApp

Inherited from

BaseIJewel3DKeyPlugin.viewer

---

envMapRotation

• get envMapRotation(): number

Returns

number

• set envMapRotation(value): void

Parameters

Name	Type
value	number

Returns

void

Methods

onDispose

▸ onDispose(viewer): Promise<void>

Parameters

Name	Type
viewer	ViewerApp

Returns

Promise<void>

Inherited from

BaseIJewel3DKeyPlugin.onDispose

---

toJSON

▸ toJSON(meta?): any

Parameters

Name	Type
meta?	any

Returns

any

Inherited from

BaseIJewel3DKeyPlugin.toJSON

---

fromJSON

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

Parameters

Name	Type
data	any
meta?	any

Returns

null | DiamondPlugin | Promise<null | DiamondPlugin>

Inherited from

BaseIJewel3DKeyPlugin.fromJSON

---

exportState

▸ exportState(): any

Returns

any

Inherited from

BaseIJewel3DKeyPlugin.exportState

---

importState

▸ importState(state): Promise<void>

Parameters

Name	Type
state	any

Returns

Promise<void>

Inherited from

BaseIJewel3DKeyPlugin.importState

---

storeState

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

Parameters

Name	Type
prefix?	string
storage?	Storage
data?	any

Returns

void

Inherited from

BaseIJewel3DKeyPlugin.storeState

---

loadState

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

Parameters

Name	Type
prefix?	string
storage?	Storage

Returns

Promise<void>

Inherited from

BaseIJewel3DKeyPlugin.loadState

---

getEnvMaps

▸ getEnvMaps(): (null | ITexture<any>)[] | (null | Texture<TextureEventMap>)[]

Returns

(null | ITexture<any>)[] | (null | Texture<TextureEventMap>)[]

---

refreshEnvMaps

▸ refreshEnvMaps(): void

Returns

void

---

refreshUi

▸ refreshUi(): void

Returns

void

---

onAdded

▸ onAdded(v): Promise<void>

Parameters

Name	Type
v	ViewerApp

Returns

Promise<void>

Overrides

BaseIJewel3DKeyPlugin.onAdded

---

onRemove

▸ onRemove(v): Promise<void>

Parameters

Name	Type
v	ViewerApp

Returns

Promise<void>

Overrides

BaseIJewel3DKeyPlugin.onRemove

---

unprepareDiamondMesh

▸ unprepareDiamondMesh(mesh): void

Parameters

Name	Type
mesh	Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material<MaterialEventMap> | Material<MaterialEventMap>[], Object3DEventMap>

Returns

void

---

prepareDiamondMesh

▸ prepareDiamondMesh(mesh, __namedParameters): void

Parameters

Name	Type
mesh	Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material<MaterialEventMap> | Material<MaterialEventMap>[], Object3DEventMap>
__namedParameters	DiamondGeometryParameters

Returns

void

---

makeDiamond

▸ makeDiamond(material, geometryParams, materialParams): void

Creates a new diamond material, prepare all the mesh assigned to the material, and set the new material on all the meshes.

Parameters

Name	Type
material	undefined | IMaterial<any, IMaterialEventMap>
geometryParams	DiamondGeometryParameters
materialParams	DiamondMaterialParameters & { isDiamond?: true }

Returns

void

---

makeDiamondMesh

▸ makeDiamondMesh(mesh, geometryParams, materialParams): void

Assigns a new material to the mesh

Parameters

Name	Type
mesh	IModel<Mesh<BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material<MaterialEventMap> | Material<MaterialEventMap>[], Object3DEventMap>, IObject3DEventMap>
geometryParams	DiamondGeometryParameters
materialParams	DiamondMaterialParameters & { isDiamond?: true }

Returns

void

---

getAllCacheMaps

▸ getAllCacheMaps(): unknown[]

Returns

unknown[]

---

disposeCacheMap

▸ disposeCacheMap(cacheKey): void

Parameters

Name	Type
cacheKey	string

Returns

void

---

disposeAllCacheMaps

▸ disposeAllCacheMaps(): void

Returns

void

---

setKey

▸ setKey(key): void

Parameters

Name	Type
key	string

Returns

void

Inherited from

BaseIJewel3DKeyPlugin.setKey

---

unuse

▸ unuse(): void

Returns

void

Inherited from

BaseIJewel3DKeyPlugin.unuse

---

_storeKey

▸ Protected _storeKey(prefix?): string

Parameters

Name	Type
prefix?	string

Returns

string

Inherited from

BaseIJewel3DKeyPlugin._storeKey

---

use

▸ Protected use(): void

Returns

void

Inherited from

BaseIJewel3DKeyPlugin.use

Constructors

constructor

• new DiamondPlugin()

Overrides

BaseIJewel3DKeyPlugin<''\>.constructor