Class: DiamondPlugin
Plugins.DiamondPlugin
Hierarchy
AViewerPlugin
<""
>↳
DiamondPlugin
Properties
PluginType
▪ Static
Readonly
PluginType: "Diamond"
Defined in
webgi/src/extras/ijewel/diamondPlugin.ts:26
DIAMOND_GLTF_EXTENSION
▪ Static
Readonly
DIAMOND_GLTF_EXTENSION: "WEBGI_materials_diamond"
Defined in
webgi/src/extras/ijewel/diamondPlugin.ts:108
offsetCache
• offsetCache: Record
<string
, IDiamondGeometryOffsets
> = {}
Defined in
webgi/src/extras/ijewel/diamondPlugin.ts:27
enabled
• enabled: boolean
= true
Overrides
Defined in
webgi/src/extras/ijewel/diamondPlugin.ts:30
envMap
• envMap: null
| ITexture
<any
> = null
Defined in
webgi/src/extras/ijewel/diamondPlugin.ts:34
envMap2
• envMap2: null
| ITexture
<any
> = null
Defined in
webgi/src/extras/ijewel/diamondPlugin.ts:38
envMap3
• envMap3: null
| ITexture
<any
> = null
Defined in
webgi/src/extras/ijewel/diamondPlugin.ts:42
forceSceneEnvMap
• forceSceneEnvMap: boolean
= false
Defined in
webgi/src/extras/ijewel/diamondPlugin.ts:46
uiConfig
• uiConfig: UiObjectConfig
<any
, string
>
Defined in
webgi/src/extras/ijewel/diamondPlugin.ts:397
_dirty
• Protected
_dirty: boolean
= false
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:23
_viewer
• Protected
Optional
_viewer: ViewerApp
Inherited from
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
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
AViewerPlugin.dirty
Defined in
webgi/src/core/AViewerPlugin.ts:20
envMapRotation
• get
envMapRotation(): number
Returns
number
Defined in
webgi/src/extras/ijewel/diamondPlugin.ts:48
• set
envMapRotation(value
): void
Parameters
Name | Type |
---|---|
value | number |
Returns
void
Defined in
webgi/src/extras/ijewel/diamondPlugin.ts:51
Methods
onDispose
▸ onDispose(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:36
toJSON
▸ toJSON(meta?
): any
Parameters
Name | Type |
---|---|
meta? | any |
Returns
any
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:45
fromJSON
▸ fromJSON(data
, meta?
): null
| DiamondPlugin
| Promise
<null
| DiamondPlugin
>
Parameters
Name | Type |
---|---|
data | any |
meta? | any |
Returns
null
| DiamondPlugin
| Promise
<null
| DiamondPlugin
>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:52
exportState
▸ exportState(): any
Returns
any
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:64
importState
▸ importState(state
): Promise
<void
>
Parameters
Name | Type |
---|---|
state | any |
Returns
Promise
<void
>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:67
storeState
▸ storeState(prefix?
, storage?
, data?
): void
Parameters
Name | Type |
---|---|
prefix? | string |
storage? | Storage |
data? | any |
Returns
void
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:74
loadState
▸ loadState(prefix?
, storage?
): Promise
<void
>
Parameters
Name | Type |
---|---|
prefix? | string |
storage? | Storage |
Returns
Promise
<void
>
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:84
getEnvMaps
▸ getEnvMaps(): (null
| ITexture
<any
>)[]
Returns
(null
| ITexture
<any
>)[]
Defined in
webgi/src/extras/ijewel/diamondPlugin.ts:64
refreshEnvMaps
▸ refreshEnvMaps(): void
Returns
void
Defined in
webgi/src/extras/ijewel/diamondPlugin.ts:72
refreshUi
▸ refreshUi(): void
Returns
void
Defined in
webgi/src/extras/ijewel/diamondPlugin.ts:152
onAdded
▸ onAdded(v
): Promise
<void
>
Parameters
Name | Type |
---|---|
v | ViewerApp |
Returns
Promise
<void
>
Overrides
Defined in
webgi/src/extras/ijewel/diamondPlugin.ts:157
onRemove
▸ onRemove(v
): Promise
<void
>
Parameters
Name | Type |
---|---|
v | ViewerApp |
Returns
Promise
<void
>
Overrides
Defined in
webgi/src/extras/ijewel/diamondPlugin.ts:225
prepareDiamondMesh
▸ prepareDiamondMesh(mesh
, __namedParameters
): void
Parameters
Name | Type |
---|---|
mesh | Mesh <BufferGeometry <NormalBufferAttributes , Event , string >, Material <Event , string > | Material <Event , string >[]> |
__namedParameters | DiamondGeometryParameters |
Returns
void
Defined in
webgi/src/extras/ijewel/diamondPlugin.ts:237
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 > |
geometryParams | DiamondGeometryParameters |
materialParams | DiamondMaterialParameters & { isDiamond? : true } |
Returns
void
Defined in
webgi/src/extras/ijewel/diamondPlugin.ts:281
makeDiamondMesh
▸ makeDiamondMesh(mesh
, geometryParams
, materialParams
): void
Assigns a new material to the mesh
Parameters
Name | Type |
---|---|
mesh | IModel <Mesh <BufferGeometry <NormalBufferAttributes , Event , string >, Material <Event , string > | Material <Event , string >[]>> |
geometryParams | DiamondGeometryParameters |
materialParams | DiamondMaterialParameters & { isDiamond? : true } |
Returns
void
Defined in
webgi/src/extras/ijewel/diamondPlugin.ts:300
disposeCacheMap
▸ disposeCacheMap(cacheKey
): void
Parameters
Name | Type |
---|---|
cacheKey | string |
Returns
void
Defined in
webgi/src/extras/ijewel/diamondPlugin.ts:388
disposeAllCacheMaps
▸ disposeAllCacheMaps(): void
Returns
void
Defined in
webgi/src/extras/ijewel/diamondPlugin.ts:392
_storeKey
▸ Protected
_storeKey(prefix?
): string
Parameters
Name | Type |
---|---|
prefix? | string |
Returns
string
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:60
Constructors
constructor
• new DiamondPlugin()