Class ContactShadowGroundPlugin

Base Class for Sync Viewer Plugins

Hierarchy (view full)

BaseGroundPlugin
- ContactShadowGroundPlugin

Constructors

constructor

new ContactShadowGroundPlugin(): ContactShadowGroundPlugin
Returns ContactShadowGroundPlugin
Overrides BaseGroundPlugin.constructor
- Defined in src/plugins/extras/ContactShadowGroundPlugin.ts:52

Properties

`Private` `Optional` _blurHelper

_blurHelper?: HVBlurHelper

`Private` `Optional` _depthPass

_depthPass?: GBufferRenderPass<"contactShadowGround", WebGLRenderTarget>

`Protected` _dirty

_dirty: boolean = false

`Protected` _viewerListeners

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

Type declaration

- (e): void
- Parameters
  - e: IViewerEvent
  Returns void

autoAdjustTransform

autoAdjustTransform: boolean = true

blurAmount

blurAmount: number = 1

constructor

constructor: typeof AViewerPluginSync & typeof AViewerPlugin

contactShadows

contactShadows: boolean = true

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

shadowCamera

shadowCamera: OrthographicCamera = ...

shadowHeight

shadowHeight: number = 5

shadowScale

shadowScale: number = 1

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` `Optional` `Readonly` OldPluginType

OldPluginType?: string

`Static` `Readonly` PluginType

PluginType: "ContactShadowGroundPlugin" = 'ContactShadowGroundPlugin'

Accessors

dirty

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

enabled

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

material

get material(): undefined | PhysicalMaterial
Returns undefined | PhysicalMaterial
Inherited from BaseGroundPlugin.material
- 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>>
Inherited from BaseGroundPlugin.mesh
- Defined in src/plugins/base/BaseGroundPlugin.ts:289

Methods

`Protected` _createMaterial

_createMaterial(material?): PhysicalMaterial
Parameters
- Optional material: PhysicalMaterial
Returns PhysicalMaterial
Inherited from BaseGroundPlugin._createMaterial
- 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>>
Inherited from BaseGroundPlugin._createMesh
- Defined in src/plugins/base/BaseGroundPlugin.ts:218

`Protected` _onSceneUpdate

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

`Protected` _onViewerEvent

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

`Protected` _postFrame

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

`Protected` _preRender

_preRender(): void
Returns void
Overrides BaseGroundPlugin._preRender
- Defined in src/plugins/extras/ContactShadowGroundPlugin.ts:110

`Protected` _refreshMaterial

_refreshMaterial(): boolean
Returns boolean
Overrides BaseGroundPlugin._refreshMaterial
- Defined in src/plugins/extras/ContactShadowGroundPlugin.ts:177

`Private` _refreshShadowCameraFrustum

_refreshShadowCameraFrustum(): void
Returns void
- Defined in src/plugins/extras/ContactShadowGroundPlugin.ts:151

`Protected` _refreshTransform

_refreshTransform(): void
Returns void
Overrides BaseGroundPlugin._refreshTransform
- Defined in src/plugins/extras/ContactShadowGroundPlugin.ts:137

`Protected` _removeMaterial

_removeMaterial(): void
Returns void
Overrides BaseGroundPlugin._removeMaterial
- Defined in src/plugins/extras/ContactShadowGroundPlugin.ts:165

`Private` _setDirty

_setDirty(): void
Returns void
- Defined in src/plugins/extras/ContactShadowGroundPlugin.ts:161

`Protected` _storeKey

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

disable

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

dispose

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

enable

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

exportState

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

fromJSON

fromJSON(data, meta?): null | ContactShadowGroundPlugin
Parameters
- data: any
- Optional meta: any
Returns null | ContactShadowGroundPlugin
Inherited from BaseGroundPlugin.fromJSON
- Defined in src/plugins/base/BaseGroundPlugin.ts:293

importState

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

isDisabled

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

onAdded

onAdded(viewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides BaseGroundPlugin.onAdded
- Defined in src/plugins/extras/ContactShadowGroundPlugin.ts:58

onRemove

onRemove(viewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides BaseGroundPlugin.onRemove
- Defined in src/plugins/extras/ContactShadowGroundPlugin.ts:93

refresh

refresh(): void
Returns void
Overrides BaseGroundPlugin.refresh
- Defined in src/plugins/extras/ContactShadowGroundPlugin.ts:171

refreshTransform

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

`Optional` setDirty

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

toJSON

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

Class ContactShadowGroundPlugin

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns ContactShadowGroundPlugin

Properties

Private Optional _blurHelper

Private Optional _depthPass

Protected _dirty

Protected _geometry

Protected Optional _material

Protected _mesh

Protected Optional _viewer

Protected _viewerListeners

Type declaration

Parameters

e: IViewerEvent

Returns void

autoAdjustTransform

blurAmount

constructor

contactShadows

enableRefreshTransform

limitCameraAboveGround

renderToDepth

shadowCamera

shadowHeight

shadowScale

size

tonemapGround

Optional uiConfig

visible

yOffset

Static Optional Readonly OldPluginType

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

Protected _refreshMaterial

Returns boolean

Private _refreshShadowCameraFrustum

Returns void

`Private` `Optional` _blurHelper

`Private` `Optional` _depthPass

`Protected` _dirty

`Protected` _geometry

`Protected` `Optional` _material

`Protected` _mesh

`Protected` `Optional` _viewer

`Protected` _viewerListeners

`Optional` uiConfig

`Static` `Optional` `Readonly` OldPluginType

`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

`Protected` _refreshMaterial

`Private` _refreshShadowCameraFrustum

`Protected` _refreshTransform

`Protected` _removeMaterial

`Private` _setDirty

`Protected` _storeKey

`Optional` prefix: string

`Optional` meta: any

`Optional` setDirty

`Rest` ...args: any[]

`Optional` meta: SerializationMetaType