Class BaseGroundPlugin<TEvent>

Base Class for Sync Viewer Plugins

Type Parameters

TEvent extends string = ""

Hierarchy (View Summary)

AViewerPluginSync<TEvent>
- BaseGroundPlugin
  - ContactShadowGroundPlugin

Constructors

constructor

new BaseGroundPlugin<TEvent extends string = "">(): BaseGroundPlugin<TEvent>
Type Parameters
- TEvent extends string = ""
Returns BaseGroundPlugin<TEvent>
Overrides AViewerPluginSync.constructor
- Defined in src/plugins/base/BaseGroundPlugin.ts:26

Properties

`Protected`_dirty

_dirty: boolean = false

`Protected`_viewerListeners

_viewerListeners: PartialRecord<
    | "dispose"
    | "*"
    | "update"
    | "preRender"
    | "postRender"
    | "preFrame"
    | "postFrame"
    | "addPlugin"
    | "removePlugin"
    | "renderEnabled"
    | "renderDisabled",
    (e: IViewerEvent) => void,
> = {}

autoAdjustTransform

autoAdjustTransform: boolean = true

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

enableRefreshTransform

enableRefreshTransform: boolean = true

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

limitCameraAboveGround

limitCameraAboveGround: boolean = false

If true, the camera will be limited to not go below the ground. note: this will only work when OrbitControls3 or three.js OrbitControls are being used.

renderToDepth

renderToDepth: boolean = true

size

size: number = 8

tonemapGround

tonemapGround: boolean = true

If false, the ground will not be tonemapped in post processing. note: this will only work when GBufferPlugin is being used. Also needs renderToDepth to be true.

`Optional`uiConfig

uiConfig?: UiObjectConfig = undefined

useModelBounds

useModelBounds: boolean = false

visible

visible: boolean = true

yOffset

yOffset: number = 0

`Static` `Readonly`OldPluginType

OldPluginType: string = 'Ground'

`Static` `Readonly`PluginType

PluginType: string = 'BaseGroundPlugin'

Accessors

dirty

get dirty(): boolean
Returns boolean
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:107
set dirty(value: boolean): void
Parameters
- value: boolean
Returns void
Inherited from AViewerPluginSync.dirty
- Defined in src/viewer/AViewerPlugin.ts:111

enabled

get enabled(): boolean
Returns boolean
Overrides AViewerPluginSync.enabled
- Defined in src/plugins/base/BaseGroundPlugin.ts:13
set enabled(value: boolean): void
Parameters
- value: boolean
Returns void
Overrides AViewerPluginSync.enabled
- Defined in src/plugins/base/BaseGroundPlugin.ts:17

material

get material(): undefined | PhysicalMaterial
Returns undefined | PhysicalMaterial
- Defined in src/plugins/base/BaseGroundPlugin.ts:305

mesh

get mesh(): Mesh2<IGeometry & PlaneGeometry, IMaterial>
Returns Mesh2<IGeometry & PlaneGeometry, IMaterial>
- Defined in src/plugins/base/BaseGroundPlugin.ts:309

Methods

`Protected`_createMaterial

_createMaterial(material?: PhysicalMaterial): PhysicalMaterial
Parameters
- Optionalmaterial: PhysicalMaterial
Returns PhysicalMaterial
- Defined in src/plugins/base/BaseGroundPlugin.ts:253

`Protected`_createMesh

_createMesh(
mesh?: Mesh2<IGeometry & PlaneGeometry, IMaterial>,
): Mesh2<IGeometry & PlaneGeometry, IMaterial>
Parameters
- Optionalmesh: Mesh2<IGeometry & PlaneGeometry, IMaterial>
Returns Mesh2<IGeometry & PlaneGeometry, IMaterial>
- Defined in src/plugins/base/BaseGroundPlugin.ts:227

`Protected`_onSceneUpdate

_onSceneUpdate(event?: ISceneEvent): void
Parameters
- Optionalevent: ISceneEvent
Returns void
- Defined in src/plugins/base/BaseGroundPlugin.ts:132

`Protected`_onViewerEvent

_onViewerEvent(e: IViewerEvent): IViewerEvent
Parameters
- e: IViewerEvent
Returns IViewerEvent
Inherited from AViewerPluginSync._onViewerEvent
- Defined in src/viewer/AViewerPlugin.ts:63

`Protected`_postFrame

_postFrame(): void
Returns void
- Defined in src/plugins/base/BaseGroundPlugin.ts:106

`Protected`_preRender

_preRender(): void
Returns void
- Defined in src/plugins/base/BaseGroundPlugin.ts:111

`Protected`_refreshMaterial

_refreshMaterial(): void
Returns void
- Defined in src/plugins/base/BaseGroundPlugin.ts:264

`Protected`_refreshTransform

_refreshTransform(): void
Returns void
- Defined in src/plugins/base/BaseGroundPlugin.ts:184

`Protected`_removeMaterial

_removeMaterial(): void
Returns void
- Defined in src/plugins/base/BaseGroundPlugin.ts:123

`Protected`_storeKey

_storeKey(prefix?: string): string
Parameters
- Optionalprefix: string
Returns string
Inherited from AViewerPluginSync._storeKey
- Defined in src/viewer/AViewerPlugin.ts:49

disable

disable(key: any): void
Parameters
- key: any
Returns void
Inherited from AViewerPluginSync.disable
- Defined in src/viewer/AViewerPlugin.ts:70

dispose

dispose(): void
Returns void
Overrides AViewerPluginSync.dispose
- Defined in src/plugins/base/BaseGroundPlugin.ts:115

enable

enable(key: any): void
Parameters
- key: any
Returns void
Inherited from AViewerPluginSync.enable
- Defined in src/viewer/AViewerPlugin.ts:75

exportState

exportState(): ISerializedConfig | Record<string, never>
Returns ISerializedConfig | Record<string, never>
Inherited from AViewerPluginSync.exportState
- Defined in src/viewer/AViewerPlugin.ts:54

fromJSON

fromJSON(data: any, meta?: any): null | BaseGroundPlugin<TEvent>
Parameters
- data: any
- Optionalmeta: any
Returns null | BaseGroundPlugin<TEvent>
Overrides AViewerPluginSync.fromJSON
- Defined in src/plugins/base/BaseGroundPlugin.ts:313

importState

importState(state: any): Promise<void>
Parameters
- state: any
Returns Promise<void>
Inherited from AViewerPluginSync.importState
- Defined in src/viewer/AViewerPlugin.ts:57

isDisabled

isDisabled(): boolean
Returns boolean
Inherited from AViewerPluginSync.isDisabled
- Defined in src/viewer/AViewerPlugin.ts:80

onAdded

onAdded(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onAdded
- Defined in src/plugins/base/BaseGroundPlugin.ts:84

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides AViewerPluginSync.onRemove
- Defined in src/plugins/base/BaseGroundPlugin.ts:96

refresh

refresh(): void
Returns void
- Defined in src/plugins/base/BaseGroundPlugin.ts:148

refreshTransform

refreshTransform(): void
Returns void
- Defined in src/plugins/base/BaseGroundPlugin.ts:143

`Optional`setDirty

setDirty(...args: any[]): any
Parameters
- ...args: any[]
Returns any
Inherited from AViewerPluginSync.setDirty
- Defined in src/viewer/AViewerPlugin.ts:84

setGeometry

setGeometry(g?: BufferGeometry): void
Parameters
- Optionalg: BufferGeometry
Returns void
- Defined in src/plugins/base/BaseGroundPlugin.ts:241

toJSON

toJSON(meta?: SerializationMetaType): ISerializedConfig
Parameters
- Optionalmeta: SerializationMetaType
Returns ISerializedConfig
Inherited from AViewerPluginSync.toJSON
- Defined in src/viewer/AViewerPlugin.ts:33

Class BaseGroundPlugin<TEvent>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Returns BaseGroundPlugin<TEvent>

Properties

Protected_dirty

Protected_geometry

Protected Optional_material

Protected_mesh

Protected Optional_viewer

Protected_viewerListeners

autoAdjustTransform

constructor

enableRefreshTransform

limitCameraAboveGround

renderToDepth

size

tonemapGround

OptionaluiConfig

useModelBounds

visible

yOffset

Static ReadonlyOldPluginType

Static ReadonlyPluginType

Accessors

dirty

Returns boolean

Parameters

Returns void

enabled

Returns boolean

Parameters

Returns void

material

Returns undefined | PhysicalMaterial

mesh

Returns Mesh2<IGeometry & PlaneGeometry, IMaterial>

Methods

Protected_createMaterial

Parameters

Returns PhysicalMaterial

Protected_createMesh

Parameters

Returns Mesh2<IGeometry & PlaneGeometry, IMaterial>

Protected_onSceneUpdate

Parameters

Returns void

Protected_onViewerEvent

Parameters

Returns IViewerEvent

Protected_postFrame

Returns void

Protected_preRender

Returns void

Protected_refreshMaterial

Returns void

Protected_refreshTransform

Returns void

Protected_removeMaterial

Returns void

Protected_storeKey

Parameters

Returns string

disable

Parameters

Returns void

dispose

Returns void

enable

Parameters

Returns void

exportState

`Protected`_dirty

`Protected`_geometry

`Protected` `Optional`_material

`Protected`_mesh

`Protected` `Optional`_viewer

`Protected`_viewerListeners

`Optional`uiConfig

`Static` `Readonly`OldPluginType

`Static` `Readonly`PluginType

`Protected`_createMaterial

`Protected`_createMesh

`Protected`_onSceneUpdate

`Protected`_onViewerEvent

`Protected`_postFrame

`Protected`_preRender

`Protected`_refreshMaterial

`Protected`_refreshTransform

`Protected`_removeMaterial

`Protected`_storeKey

`Optional`setDirty