Class AdvancedGroundPlugin

Hierarchy

BaseGroundPlugin
- AdvancedGroundPlugin

Constructors

constructor

new AdvancedGroundPlugin(): AdvancedGroundPlugin
Returns AdvancedGroundPlugin
Overrides BaseGroundPlugin.constructor

Properties

_mesh

_mesh: Reflector2<
IGeometry<NormalBufferAttributes, BufferGeometryEventMap> & PlaneGeometry,
>

autoBakeShadows

autoBakeShadows: boolean = true

autoBakeShadows - when true, shadows are baked automatically on scene update(whenever any object in the scene changes), set it to false to trigger baking manually with {@see bakeShadows()}

autoFrustumSize

autoFrustumSize: boolean = true

bakedShadows

bakedShadows: boolean = true

groundReflection

groundReflection: boolean = false

physicalReflections

physicalReflections: boolean = false

planarReflections

planarReflections: boolean

uiConfig

uiConfig: UiObjectConfig

`Static` `Readonly`PluginType

PluginType: string = 'AdvancedGroundPlugin'

Accessors

shadowBaker

get shadowBaker(): undefined | ShadowMapBaker
Returns undefined | ShadowMapBaker

Methods

`Protected`_createMesh

_createMesh(
    mesh?: Mesh2<
        IGeometry<NormalBufferAttributes, BufferGeometryEventMap> & PlaneGeometry,
        IMaterial<IMaterialEventMap>,
        IObject3DEventMap,
    >,
): Reflector2<
    IGeometry<NormalBufferAttributes, BufferGeometryEventMap> & PlaneGeometry,
>
Parameters
- Optionalmesh: Mesh2<
      IGeometry<NormalBufferAttributes, BufferGeometryEventMap> & PlaneGeometry,
      IMaterial<IMaterialEventMap>,
      IObject3DEventMap,
  >
Returns Reflector2<
IGeometry<NormalBufferAttributes, BufferGeometryEventMap> & PlaneGeometry,
>
Overrides BaseGroundPlugin._createMesh

`Protected`_extraUiConfig

_extraUiConfig(): (
    | UiObjectConfig<any, string, any>
    | () => | UiObjectConfig<any, string, any>
    | UiObjectConfig<any, string, any>[]
)[]
Returns (
    | UiObjectConfig<any, string, any>
    | () => | UiObjectConfig<any, string, any>
    | UiObjectConfig<any, string, any>[]
)[]

`Protected`_onSceneUpdate

_onSceneUpdate(
    event: ({} | {} & ISceneSetDirtyOptions) & Event<
        "addSceneObject"
        | "sceneUpdate",
        IScene<ISceneEventMap>,
    >,
): void
Parameters
- event: ({} | {} & ISceneSetDirtyOptions) & Event<
      "addSceneObject"
      | "sceneUpdate",
      IScene<ISceneEventMap>,
  >
Returns void
Overrides BaseGroundPlugin._onSceneUpdate

`Protected`_postFrame

_postFrame(): void
Returns void
Overrides BaseGroundPlugin._postFrame

`Protected`_preRender

_preRender(): void
Returns void
Overrides BaseGroundPlugin._preRender

`Protected`_refreshMaterial

_refreshMaterial(): undefined | false
Returns undefined | false
Overrides BaseGroundPlugin._refreshMaterial

`Protected`_refreshTransform

_refreshTransform(): boolean
Returns boolean
Overrides BaseGroundPlugin._refreshTransform

`Protected`_removeMaterial

_removeMaterial(): void
Returns void
Overrides BaseGroundPlugin._removeMaterial

autoResetShadows

autoResetShadows(): void
Returns void

bakeShadows

bakeShadows(): void
bake shadows manually, to be used with {@see autoBakeShadows} set to false

Returns void

fromJSON

fromJSON(data: any, meta?: any): null | AdvancedGroundPlugin
Parameters
- data: any
- Optionalmeta: any
Returns null | AdvancedGroundPlugin
Overrides BaseGroundPlugin.fromJSON

onAdded

onAdded(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides BaseGroundPlugin.onAdded

onRemove

onRemove(viewer: ThreeViewer): void
Parameters
- viewer: ThreeViewer
Returns void
Overrides BaseGroundPlugin.onRemove

refresh

refresh(): void
Returns void
Overrides BaseGroundPlugin.refresh

Class AdvancedGroundPlugin

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns AdvancedGroundPlugin

Properties

_mesh

autoBakeShadows

autoFrustumSize

bakedShadows

groundReflection

physicalReflections

planarReflections

uiConfig

Static ReadonlyPluginType

Accessors

shadowBaker

Returns undefined | ShadowMapBaker

Methods

Protected_createMesh

Parameters

Returns Reflector2< IGeometry<NormalBufferAttributes, BufferGeometryEventMap> & PlaneGeometry,>

Protected_extraUiConfig

Returns ( | UiObjectConfig<any, string, any> | () => | UiObjectConfig<any, string, any> | UiObjectConfig<any, string, any>[])[]

Protected_onSceneUpdate

Parameters

Returns void

Protected_postFrame

Returns void

Protected_preRender

Returns void

Protected_refreshMaterial

Returns undefined | false

Protected_refreshTransform

Returns boolean

Protected_removeMaterial

Returns void

autoResetShadows

Returns void

bakeShadows

Returns void

fromJSON

Parameters

Returns null | AdvancedGroundPlugin

onAdded

Parameters

Returns void

onRemove

Parameters

Returns void

refresh

Returns void

Settings

On This Page

`Static` `Readonly`PluginType

`Protected`_createMesh

Returns Reflector2<
IGeometry<NormalBufferAttributes, BufferGeometryEventMap> & PlaneGeometry,
>

`Protected`_extraUiConfig

Returns (
| UiObjectConfig<any, string, any>
| () => | UiObjectConfig<any, string, any>
| UiObjectConfig<any, string, any>[]
)[]

`Protected`_onSceneUpdate

`Protected`_postFrame

`Protected`_preRender

`Protected`_refreshMaterial

`Protected`_refreshTransform

`Protected`_removeMaterial