Class: ContactShadowGroundPlugin<TMesh>
Plugins.ContactShadowGroundPlugin
Type parameters
Name | Type |
---|---|
TMesh | extends Mesh <BufferGeometry , MeshStandardMaterial > | Reflector2 = Mesh <BufferGeometry , MeshStandardMaterial > | Reflector2 |
Hierarchy
BaseGroundPlugin
<TMesh
>↳
ContactShadowGroundPlugin
Implements
Properties
PluginType
▪ Static
Readonly
PluginType: "ContactShadowGroundPlugin"
Defined in
webgi/src/plugins/ContactShadowGroundPlugin.ts:39
dependencies
• dependencies: Class
<IViewerPlugin
<IViewerApp
>>[]
Implementation of
Inherited from
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:50
visible
• visible: boolean
= true
Inherited from
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:75
size
• size: number
= 8
Inherited from
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:78
yOffset
• yOffset: number
= 0
Inherited from
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:81
renderToDepth
• renderToDepth: boolean
= true
Inherited from
BaseGroundPlugin.renderToDepth
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:84
tonemapGround
• tonemapGround: boolean
= true
Inherited from
BaseGroundPlugin.tonemapGround
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:87
limitCameraAboveGround
• limitCameraAboveGround: boolean
= false
Inherited from
BaseGroundPlugin.limitCameraAboveGround
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:90
contactShadows
• contactShadows: boolean
= true
Defined in
webgi/src/plugins/ContactShadowGroundPlugin.ts:42
blurAmount
• blurAmount: number
= 1
Defined in
webgi/src/plugins/ContactShadowGroundPlugin.ts:46
shadowScale
• shadowScale: number
= 1
Defined in
webgi/src/plugins/ContactShadowGroundPlugin.ts:49
shadowHeight
• shadowHeight: number
= 5
Defined in
webgi/src/plugins/ContactShadowGroundPlugin.ts:52
shadowCamera
• shadowCamera: OrthographicCamera
Defined in
webgi/src/plugins/ContactShadowGroundPlugin.ts:56
_dirty
• Protected
_dirty: boolean
= false
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:25
_viewer
• Protected
Optional
_viewer: ViewerApp
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:29
_geometry
• Protected
_geometry: BufferGeometry
Inherited from
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:39
_material
• Protected
Optional
_material: MeshStandardMaterial2
Inherited from
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:42
_mesh
• Protected
Optional
_mesh: TMesh
Inherited from
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:45
_options
• Protected
_options: GroundOptions
Inherited from
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:46
_manager
• Protected
Optional
_manager: AssetManagerPlugin
Inherited from
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:47
_uiConfig
• Protected
Optional
_uiConfig: UiObjectConfig
<any
, string
>
Inherited from
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:315
Accessors
dirty
• get
dirty(): boolean
Returns
boolean
Implementation of
Inherited from
BaseGroundPlugin.dirty
Defined in
webgi/src/core/AViewerPlugin.ts:18
• set
dirty(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Implementation of
Inherited from
BaseGroundPlugin.dirty
Defined in
webgi/src/core/AViewerPlugin.ts:22
enabled
• get
enabled(): boolean
Returns
boolean
Inherited from
BaseGroundPlugin.enabled
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:20
• set
enabled(value
): void
Parameters
Name | Type |
---|---|
value | boolean |
Returns
void
Inherited from
BaseGroundPlugin.enabled
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:24
material
• get
material(): undefined
| MeshStandardMaterial2
Returns
undefined
| MeshStandardMaterial2
Inherited from
BaseGroundPlugin.material
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:28
mesh
• get
mesh(): undefined
| IModel
<TMesh
>
Returns
undefined
| IModel
<TMesh
>
Inherited from
BaseGroundPlugin.mesh
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:32
uiConfig
• get
uiConfig(): UiObjectConfig
<any
, string
>
Returns
UiObjectConfig
<any
, string
>
Implementation of
Inherited from
BaseGroundPlugin.uiConfig
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:323
Methods
toJSON
▸ toJSON(meta?
): any
Parameters
Name | Type |
---|---|
meta? | any |
Returns
any
Implementation of
Inherited from
Defined in
webgi/src/core/AViewerPlugin.ts:47
addEventListener
▸ addEventListener(type
, listener
): void
Adds a listener to an event type.
Parameters
Name | Type |
---|---|
type | "" | "serialize" | "deserialize" |
listener | (event : IEvent <"" | "serialize" | "deserialize" >) => void |
Returns
void
Implementation of
IViewerPlugin.addEventListener
Inherited from
BaseGroundPlugin.addEventListener
Defined in
webgi/src/helpers/EventDispatcher.ts:48
hasEventListener
▸ hasEventListener(type
, listener
): boolean
Checks if listener is added to an event type.
Parameters
Name | Type |
---|---|
type | "" | "serialize" | "deserialize" |
listener | (event : IEvent <"" | "serialize" | "deserialize" >) => void |
Returns
boolean
Implementation of
IViewerPlugin.hasEventListener
Inherited from
BaseGroundPlugin.hasEventListener
Defined in
webgi/src/helpers/EventDispatcher.ts:56
removeEventListener
▸ removeEventListener(type
, listener
): void
Removes a listener from an event type.
Parameters
Name | Type |
---|---|
type | "" | "serialize" | "deserialize" |
listener | (event : IEvent <"" | "serialize" | "deserialize" >) => void |
Returns
void
Implementation of
IViewerPlugin.removeEventListener
Inherited from
BaseGroundPlugin.removeEventListener
Defined in
webgi/src/helpers/EventDispatcher.ts:63
dispatchEvent
▸ dispatchEvent(event
): void
Fire an event type.
Parameters
Name | Type |
---|---|
event | IEvent <"" | "serialize" | "deserialize" > |
Returns
void
Implementation of
Inherited from
BaseGroundPlugin.dispatchEvent
Defined in
webgi/src/helpers/EventDispatcher.ts:74
refreshTransform
▸ refreshTransform(): void
Returns
void
Inherited from
BaseGroundPlugin.refreshTransform
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:171
setOptions
▸ setOptions(options
): void
Parameters
Name | Type |
---|---|
options | Partial <GroundOptions > |
Returns
void
Inherited from
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:294
fromJSON
▸ fromJSON(data
, meta?
): null
| ContactShadowGroundPlugin
<TMesh
>
Parameters
Name | Type |
---|---|
data | any |
meta? | any |
Returns
null
| ContactShadowGroundPlugin
<TMesh
>
Implementation of
Inherited from
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:307
onAdded
▸ onAdded(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Implementation of
Overrides
Defined in
webgi/src/plugins/ContactShadowGroundPlugin.ts:69
onDispose
▸ onDispose(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Implementation of
Overrides
Defined in
webgi/src/plugins/ContactShadowGroundPlugin.ts:158
onRemove
▸ onRemove(viewer
): Promise
<void
>
Parameters
Name | Type |
---|---|
viewer | ViewerApp |
Returns
Promise
<void
>
Implementation of
Overrides
Defined in
webgi/src/plugins/ContactShadowGroundPlugin.ts:162
refreshOptions
▸ refreshOptions(): void
Returns
void
Overrides
BaseGroundPlugin.refreshOptions
Defined in
webgi/src/plugins/ContactShadowGroundPlugin.ts:200
_createMesh
▸ Protected
_createMesh(): Mesh
<BufferGeometry
, Material
| Material
[]>
Returns
Mesh
<BufferGeometry
, Material
| Material
[]>
Inherited from
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:92
_onSceneUpdate
▸ Protected
_onSceneUpdate(event
): void
Parameters
Name | Type |
---|---|
event | IEvent <string > |
Returns
void
Inherited from
BaseGroundPlugin._onSceneUpdate
Defined in
webgi/src/plugins/BaseGroundPlugin.ts:165
_postFrame
▸ Protected
_postFrame(): void
Returns
void
Overrides
Defined in
webgi/src/plugins/ContactShadowGroundPlugin.ts:108
_preRender
▸ Protected
_preRender(): void
Returns
void
Overrides
Defined in
webgi/src/plugins/ContactShadowGroundPlugin.ts:114
_refreshTransform
▸ Protected
_refreshTransform(): void
Returns
void
Overrides
BaseGroundPlugin._refreshTransform
Defined in
webgi/src/plugins/ContactShadowGroundPlugin.ts:166
_removeMaterial
▸ Protected
_removeMaterial(): void
Returns
void
Overrides
BaseGroundPlugin._removeMaterial
Defined in
webgi/src/plugins/ContactShadowGroundPlugin.ts:193
_refreshMaterial
▸ Protected
_refreshMaterial(): boolean
Returns
boolean
Overrides
BaseGroundPlugin._refreshMaterial
Defined in
webgi/src/plugins/ContactShadowGroundPlugin.ts:206
_extraUiConfig
▸ Protected
_extraUiConfig(): (UiObjectConfig
<any
, string
> | () => UiObjectConfig
<any
, string
> | UiObjectConfig
<any
, string
>[])[]
Returns
(UiObjectConfig
<any
, string
> | () => UiObjectConfig
<any
, string
> | UiObjectConfig
<any
, string
>[])[]
Overrides
BaseGroundPlugin._extraUiConfig
Defined in
webgi/src/plugins/ContactShadowGroundPlugin.ts:228
Constructors
constructor
• new ContactShadowGroundPlugin<TMesh
>(options?
, showDebug?
)
Type parameters
Name | Type |
---|---|
TMesh | extends Mesh <BufferGeometry , MeshStandardMaterial > | Reflector2 = Mesh <BufferGeometry , MeshStandardMaterial > | Reflector2 |
Parameters
Name | Type | Default value |
---|---|---|
options | Partial <GroundOptions > | {} |
showDebug | boolean | false |