Class BaseGroundPlugin<TEvent>

Base Class for Sync Viewer Plugins

Type Parameters

  • TEvent extends string = ""

Hierarchy (view full)



_cameraLastMaxPolarAngle: number = Math.PI
_cameraLimitsSet: boolean = false
_dirty: boolean = false
_material?: PhysicalMaterial
_transformNeedRefresh: boolean = true
_viewer?: ThreeViewer
_viewerListeners: PartialRecord<"update" | "dispose" | "preRender" | "postRender" | "preFrame" | "postFrame" | "*" | "addPlugin" | "renderEnabled" | "renderDisabled", ((e) => void)> = {}

Type declaration

autoAdjustTransform: boolean = true
constructor: typeof AViewerPluginSync & typeof AViewerPlugin
enableRefreshTransform: boolean = true

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

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: boolean = true
size: number = 8
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.

uiConfig?: UiObjectConfig<any, string, any> = undefined
visible: boolean = true
yOffset: number = 0
PluginType: string = 'BaseGroundPlugin'



Generated using TypeDoc