Skip to main content

Class: BaseGroundPlugin<TMesh, TEvent>

Plugins.BaseGroundPlugin

Type parameters

NameType
TMeshextends Mesh<BufferGeometry, MeshStandardMaterial> | Reflector2 = Mesh<BufferGeometry, MeshStandardMaterial> | Reflector2
TEventextends string = ""

Hierarchy

Implements

Accessors

dirty

get dirty(): boolean

Returns

boolean

Implementation of

IViewerPlugin.dirty

Inherited from

AViewerPlugin.dirty

Defined in

webgi/src/core/AViewerPlugin.ts:16

set dirty(value): void

Parameters

NameType
valueboolean

Returns

void

Implementation of

IViewerPlugin.dirty

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:22

set enabled(value): void

Parameters

NameType
valueboolean

Returns

void

Overrides

AViewerPlugin.enabled

Defined in

webgi/src/plugins/BaseGroundPlugin.ts:26


material

get material(): undefined | MeshStandardMaterial2

Returns

undefined | MeshStandardMaterial2

Defined in

webgi/src/plugins/BaseGroundPlugin.ts:30


mesh

get mesh(): undefined | IModel<TMesh>

Returns

undefined | IModel<TMesh>

Defined in

webgi/src/plugins/BaseGroundPlugin.ts:34


autoAdjustTransform

get autoAdjustTransform(): boolean

Returns

boolean

Defined in

webgi/src/plugins/BaseGroundPlugin.ts:94

set autoAdjustTransform(value): void

Parameters

NameType
valueboolean

Returns

void

Defined in

webgi/src/plugins/BaseGroundPlugin.ts:97


uiConfig

get uiConfig(): UiObjectConfig<any, string>

Returns

UiObjectConfig<any, string>

Implementation of

IViewerPlugin.uiConfig

Defined in

webgi/src/plugins/BaseGroundPlugin.ts:341

Methods

toJSON

toJSON(meta?): any

Parameters

NameType
meta?any

Returns

any

Implementation of

IViewerPlugin.toJSON

Inherited from

AViewerPlugin.toJSON

Defined in

webgi/src/core/AViewerPlugin.ts:45


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

Implementation of

IViewerPlugin.storeState

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>

Implementation of

IViewerPlugin.loadState

Inherited from

AViewerPlugin.loadState

Defined in

webgi/src/core/AViewerPlugin.ts:84


onAdded

onAdded(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onAdded

Overrides

AViewerPlugin.onAdded

Defined in

webgi/src/plugins/BaseGroundPlugin.ts:106


onDispose

onDispose(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onDispose

Overrides

AViewerPlugin.onDispose

Defined in

webgi/src/plugins/BaseGroundPlugin.ts:148


onRemove

onRemove(viewer): Promise<void>

Parameters

NameType
viewerViewerApp

Returns

Promise<void>

Implementation of

IViewerPlugin.onRemove

Overrides

AViewerPlugin.onRemove

Defined in

webgi/src/plugins/BaseGroundPlugin.ts:156


refreshTransform

refreshTransform(): void

Returns

void

Defined in

webgi/src/plugins/BaseGroundPlugin.ts:186


refreshOptions

refreshOptions(): void

Returns

void

Defined in

webgi/src/plugins/BaseGroundPlugin.ts:196


setOptions

setOptions(options): void

Parameters

NameType
optionsPartial<GroundOptions>

Returns

void

Defined in

webgi/src/plugins/BaseGroundPlugin.ts:312


fromJSON

fromJSON(data, meta?): null | BaseGroundPlugin<TMesh, TEvent>

Parameters

NameType
dataany
meta?any

Returns

null | BaseGroundPlugin<TMesh, TEvent>

Implementation of

IViewerPlugin.fromJSON

Overrides

AViewerPlugin.fromJSON

Defined in

webgi/src/plugins/BaseGroundPlugin.ts:325


_storeKey

Protected _storeKey(prefix?): string

Parameters

NameType
prefix?string

Returns

string

Inherited from

AViewerPlugin._storeKey

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:101


_postFrame

Protected _postFrame(): void

Returns

void

Defined in

webgi/src/plugins/BaseGroundPlugin.ts:138


_preRender

Protected _preRender(): void

Returns

void

Defined in

webgi/src/plugins/BaseGroundPlugin.ts:144


_removeMaterial

Protected _removeMaterial(): void

Returns

void

Defined in

webgi/src/plugins/BaseGroundPlugin.ts:167


_onSceneUpdate

Protected _onSceneUpdate(event?): void

Parameters

NameType
event?IEvent<string>

Returns

void

Defined in

webgi/src/plugins/BaseGroundPlugin.ts:175


_refreshTransform

Protected _refreshTransform(): void

Returns

void

Defined in

webgi/src/plugins/BaseGroundPlugin.ts:223


_refreshMaterial

Protected _refreshMaterial(): boolean

Returns

boolean

Defined in

webgi/src/plugins/BaseGroundPlugin.ts:258


_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:335

Properties

dependencies

dependencies: Class<IViewerPlugin<IViewerApp, boolean>>[]

Implementation of

IViewerPlugin.dependencies

Defined in

webgi/src/plugins/BaseGroundPlugin.ts:52


visible

visible: boolean = true

Defined in

webgi/src/plugins/BaseGroundPlugin.ts:77


size

size: number = 8

Defined in

webgi/src/plugins/BaseGroundPlugin.ts:80


yOffset

yOffset: number = 0

Defined in

webgi/src/plugins/BaseGroundPlugin.ts:83


renderToDepth

renderToDepth: boolean = true

Defined in

webgi/src/plugins/BaseGroundPlugin.ts:86


tonemapGround

tonemapGround: boolean = true

Defined in

webgi/src/plugins/BaseGroundPlugin.ts:89


limitCameraAboveGround

limitCameraAboveGround: boolean = false

Defined in

webgi/src/plugins/BaseGroundPlugin.ts:92


enableRefreshTransform

enableRefreshTransform: boolean = true

Extra flag for plugins to disable transform refresh like when animating or dragging

Defined in

webgi/src/plugins/BaseGroundPlugin.ts:184


_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


_geometry

Protected _geometry: BufferGeometry<NormalBufferAttributes, Event, string>

Defined in

webgi/src/plugins/BaseGroundPlugin.ts:41


_material

Protected Optional _material: MeshStandardMaterial2

Defined in

webgi/src/plugins/BaseGroundPlugin.ts:44


_mesh

Protected Optional _mesh: TMesh

Defined in

webgi/src/plugins/BaseGroundPlugin.ts:47


_options

Protected _options: GroundOptions

Defined in

webgi/src/plugins/BaseGroundPlugin.ts:48


_manager

Protected Optional _manager: AssetManagerPlugin

Defined in

webgi/src/plugins/BaseGroundPlugin.ts:49


_uiConfig

Protected Optional _uiConfig: UiObjectConfig<any, string>

Defined in

webgi/src/plugins/BaseGroundPlugin.ts:333

Constructors

constructor

new BaseGroundPlugin<TMesh, TEvent>(options?)

Type parameters

NameType
TMeshextends Mesh<BufferGeometry<NormalBufferAttributes, Event, string>, MeshStandardMaterial<Event, "">> | Reflector2 = Mesh<BufferGeometry<NormalBufferAttributes, Event, string>, MeshStandardMaterial<Event, "">> | Reflector2
TEventextends string = ""

Parameters

NameType
optionsPartial<GroundOptions>

Overrides

AViewerPlugin.constructor

Defined in

webgi/src/plugins/BaseGroundPlugin.ts:54