ThreePipe
    Preparing search index...

    Class ContactShadowGroundPlugin

    Base Class for Sync Viewer Plugins

    Hierarchy (View Summary)

    Index

    Constructors

    Properties

    _defaultMaterial: IMaterial
    _dirty: boolean = false
    _viewer?: ThreeViewer
    _viewerListeners: PartialRecord<IViewerEventTypes, (e: IViewerEvent) => void> = {}
    autoAdjustTransform: boolean = true
    blurAmount: number = 1
    constructor: typeof AViewerPluginSync & typeof AViewerPlugin
    contactShadows: boolean = true
    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
    shadowHeight: number = 5
    shadowScale: number = 1
    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
    useModelBounds: boolean = true
    visible: boolean = true
    yOffset: number = 0
    OldPluginType: string = 'Ground'
    PluginType: "ContactShadowGroundPlugin" = 'ContactShadowGroundPlugin'

    Accessors

    Methods

    • Parameters

      • Optionalevent: (({ hierarchyChanged?: boolean | undefined; refreshScene?: boolean | undefined; object?: IObject3D<IObject3DEventMap, IGeometry<NormalBufferAttributes, BufferGeometryEventMap> | undefined, IMaterial<...> | ... 1 more ... | undefined> | undefined; ... 4 more ...; sceneUpdate?: boolean | undefined; } & ISceneSetDirtyO...

      Returns void