Class: BaseGroundPlugin<TMesh, TEvent>
Plugins.BaseGroundPlugin
Type parameters
Name | Type |
---|---|
TMesh | extends Mesh <BufferGeometry , MeshStandardMaterial > | Reflector2 = Mesh <BufferGeometry , MeshStandardMaterial > | Reflector2 |
TEvent | extends string = "" |
Hierarchy
AViewerPlugin
<TEvent
>↳
BaseGroundPlugin
↳↳
GroundPlugin
Implements
Accessors
dirty
• get
dirty(): boolean
Returns
boolean
Implementation of
Inherited from
AViewerPlugin.dirty
Defined in
webgi/src/core/AViewerPlugin.ts:16
• set
dirty(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Implementation of
Inherited from
AViewerPlugin.dirty
Defined in
webgi/src/core/AViewerPlugin.ts:20
enabled
• get
enabled(): boolean
Returns
boolean
Overrides
AViewerPlugin.enabled
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:30
• set
enabled(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Overrides
AViewerPlugin.enabled
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:34
material
• get
material(): undefined
| MeshStandardMaterial2
Returns
undefined
| MeshStandardMaterial2
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:38
mesh
• get
mesh(): undefined
| IModel
<TMesh
>
Returns
undefined
| IModel
<TMesh
>
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:42
autoAdjustTransform
• get
autoAdjustTransform(): boolean
Returns
boolean
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:102
• set
autoAdjustTransform(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:105
uiConfig
• get
uiConfig(): UiObjectConfig
<any
, string
>
Returns
UiObjectConfig
<any
, string
>
Implementation of
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:350
Methods
toJSON
▸ toJSON(meta?
): any
Parameters
Name | Type |
---|---|
meta? | any |
Returns
any
Implementation of
IViewerPlugin.toJSON
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:45
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
Implementation of
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
>
Implementation of
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:84
onAdded
▸ onAdded(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Implementation of
Overrides
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:114
onDispose
▸ onDispose(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Implementation of
Overrides
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:156
onRemove
▸ onRemove(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Implementation of
Overrides
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:164
refreshTransform
▸ refreshTransform(): void
Returns
void
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:194
refreshOptions
▸ refreshOptions(): void
Returns
void
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:204
setOptions
▸ setOptions(options
): void
Parameters
Name | Type |
---|---|
options | Partial <GroundOptions > |
Returns
void
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:321
fromJSON
▸ fromJSON(data
, meta?
): null
| BaseGroundPlugin
<TMesh
, TEvent
>
Parameters
Name | Type |
---|---|
data | any |
meta? | any |
Returns
null
| BaseGroundPlugin
<TMesh
, TEvent
>
Implementation of
IViewerPlugin.fromJSON
Overrides
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:334
_storeKey
▸ Protected
_storeKey(prefix?
): string
Parameters
Name | Type |
---|---|
prefix? | string |
Returns
string
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:60
_createMesh
▸ Protected
_createMesh(): Mesh
<BufferGeometry
<NormalBufferAttributes
, Event
, string
>, Material
<Event
, string
> | Material
<Event
, string
>[]>
Returns
Mesh
<BufferGeometry
<NormalBufferAttributes
, Event
, string
>, Material
<Event
, string
> | Material
<Event
, string
>[]>
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:109
_postFrame
▸ Protected
_postFrame(): void
Returns
void
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:146
_preRender
▸ Protected
_preRender(): void
Returns
void
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:152
_removeMaterial
▸ Protected
_removeMaterial(): void
Returns
void
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:175
_onSceneUpdate
▸ Protected
_onSceneUpdate(event?
): void
Parameters
Name | Type |
---|---|
event? | IEvent <string > |
Returns
void
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:183
_refreshTransform
▸ Protected
_refreshTransform(): void
Returns
void
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:231
_refreshMaterial
▸ Protected
_refreshMaterial(): boolean
Returns
boolean
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:266
_extraUiConfig
▸ Protected
_extraUiConfig(): (UiObjectConfig
<any
, string
> | () => UiObjectConfig
<any
, string
> | UiObjectConfig
<any
, string
>[])[]
Returns
(UiObjectConfig
<any
, string
> | () => UiObjectConfig
<any
, string
> | UiObjectConfig
<any
, string
>[])[]
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:344
Properties
dependencies
• dependencies: Class
<IViewerPlugin
<IViewerApp
, boolean
>>[]
Implementation of
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:60
visible
• visible: boolean
= true
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:85
size
• size: number
= 8
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:88
yOffset
• yOffset: number
= 0
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:91
renderToDepth
• renderToDepth: boolean
= true
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:94
tonemapGround
• tonemapGround: boolean
= true
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:97
limitCameraAboveGround
• limitCameraAboveGround: boolean
= false
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:100
enableRefreshTransform
• enableRefreshTransform: boolean
= true
Extra flag for plugins to disable transform refresh like when animating or dragging
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:192
_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
_geometry
• Protected
_geometry: BufferGeometry
<NormalBufferAttributes
, Event
, string
>
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:49
_material
• Protected
Optional
_material: MeshStandardMaterial2
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:52
_mesh
• Protected
Optional
_mesh: TMesh
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:55
_options
• Protected
_options: GroundOptions
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:56
_manager
• Protected
Optional
_manager: AssetManagerPlugin
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:57
_uiConfig
• Protected
Optional
_uiConfig: UiObjectConfig
<any
, string
>
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:342
Constructors
constructor
• new BaseGroundPlugin<TMesh
, TEvent
>(options?
)
Type parameters
Name | Type |
---|---|
TMesh | extends Mesh <BufferGeometry <NormalBufferAttributes , Event , string >, MeshStandardMaterial <Event , string >> | Reflector2 = Mesh <BufferGeometry <NormalBufferAttributes , Event , string >, MeshStandardMaterial <Event , string >> | Reflector2 |
TEvent | extends string = "" |
Parameters
Name | Type |
---|---|
options | Partial <GroundOptions > |