Class BaseGroundPlugin<TEvent>

Base Class for Sync Viewer Plugins

Type Parameters

TEvent extends string = ""

Hierarchy (view full)

AViewerPluginSync<TEvent>
- BaseGroundPlugin
  - ContactShadowGroundPlugin

Constructors

constructor

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

Properties

`Private` _cameraLastMaxPolarAngle

_cameraLastMaxPolarAngle: number = Math.PI

`Private` _cameraLimitsSet

_cameraLimitsSet: boolean = false

`Protected` _dirty

_dirty: boolean = false

`Private` _transformNeedRefresh

_transformNeedRefresh: boolean = true

`Protected` `Optional` _viewer

_viewer?: ThreeViewer

`Protected` _viewerListeners

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

Type declaration

- (e): void
- Parameters
  - e: IViewerEvent
  Returns 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<any, string, any> = undefined

visible

visible: boolean = true

yOffset

yOffset: number = 0

`Static` `Readonly` PluginType

PluginType: string = 'BaseGroundPlugin'

Accessors

dirty

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

enabled

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

material

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

mesh

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

Methods

`Protected` _createMaterial

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

`Protected` _createMesh

_createMesh(mesh?): Mesh2<IGeometry<NormalBufferAttributes> & PlaneGeometry, IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>>
Parameters
- Optional mesh: Mesh2<IGeometry<NormalBufferAttributes> & PlaneGeometry, IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>>
Returns Mesh2<IGeometry<NormalBufferAttributes> & PlaneGeometry, IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>>
- Defined in src/plugins/base/BaseGroundPlugin.ts:218

`Protected` _onSceneUpdate

_onSceneUpdate(event?): void
Parameters
- Optional event: ISceneEvent<ISceneEventTypes>
Returns void
- Defined in src/plugins/base/BaseGroundPlugin.ts:130

`Protected` _onViewerEvent

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

`Protected` _postFrame

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

`Protected` _preRender

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

`Private` _refresh2

_refresh2(): void
Returns void
- Defined in src/plugins/base/BaseGroundPlugin.ts:154

`Private` _refreshCameraLimits

_refreshCameraLimits(): void
Returns void
- Defined in src/plugins/base/BaseGroundPlugin.ts:161

`Protected` _refreshMaterial

_refreshMaterial(): boolean
Returns boolean
- Defined in src/plugins/base/BaseGroundPlugin.ts:240

`Protected` _refreshTransform

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

`Protected` _removeMaterial

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

`Protected` _storeKey

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

disable

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

dispose

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

enable

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

exportState

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

fromJSON

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

importState

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

isDisabled

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

onAdded

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

onRemove

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

refresh

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

refreshTransform

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

`Optional` setDirty

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

toJSON

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

Class BaseGroundPlugin<TEvent>

Type Parameters

TEvent extends string = ""

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

TEvent extends string = ""

Returns BaseGroundPlugin<TEvent>

Properties

Private _cameraLastMaxPolarAngle

Private _cameraLimitsSet

Protected _dirty

Protected _geometry

Protected Optional _material

Protected _mesh

Private _transformNeedRefresh

Protected Optional _viewer

Protected _viewerListeners

Type declaration

Parameters

e: IViewerEvent

Returns void

autoAdjustTransform

constructor

enableRefreshTransform

limitCameraAboveGround

renderToDepth

size

tonemapGround

Optional uiConfig

visible

yOffset

Static Readonly PluginType

Accessors

dirty

Returns boolean

Parameters

value: boolean

Returns void

enabled

Returns boolean

Parameters

value: boolean

Returns void

material

Returns undefined | PhysicalMaterial

mesh

Returns Mesh2<IGeometry<NormalBufferAttributes> & PlaneGeometry, IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>>

Methods

Protected _createMaterial

Parameters

Optional material: PhysicalMaterial

Returns PhysicalMaterial

Protected _createMesh

Parameters

Optional mesh: Mesh2<IGeometry<NormalBufferAttributes> & PlaneGeometry, IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>>

Returns Mesh2<IGeometry<NormalBufferAttributes> & PlaneGeometry, IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>>

Protected _onSceneUpdate

Parameters

Optional event: ISceneEvent<ISceneEventTypes>

Returns void

Protected _onViewerEvent

Parameters

e: IViewerEvent

Returns IViewerEvent

Protected _postFrame

Returns void

Protected _preRender

Returns void

Private _refresh2

Returns void

Private _refreshCameraLimits

Returns void

Protected _refreshMaterial

`Private` _cameraLastMaxPolarAngle

`Private` _cameraLimitsSet

`Protected` _dirty

`Protected` _geometry

`Protected` `Optional` _material

`Protected` _mesh

`Private` _transformNeedRefresh

`Protected` `Optional` _viewer

`Protected` _viewerListeners

`Optional` uiConfig

`Static` `Readonly` PluginType

`Protected` _createMaterial

`Optional` material: PhysicalMaterial

`Protected` _createMesh

`Optional` mesh: Mesh2<IGeometry<NormalBufferAttributes> & PlaneGeometry, IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>>

`Protected` _onSceneUpdate

`Optional` event: ISceneEvent<ISceneEventTypes>

`Protected` _onViewerEvent

`Protected` _postFrame

`Protected` _preRender

`Private` _refresh2

`Private` _refreshCameraLimits

`Protected` _refreshMaterial

`Protected` _refreshTransform

`Protected` _removeMaterial

`Protected` _storeKey

`Optional` prefix: string

`Optional` meta: any

`Optional` setDirty

`Rest` ...args: any[]

`Optional` meta: SerializationMetaType