WebGi Rendering Plugins
    Preparing search index...

    Class AdvancedGroundPlugin

    Hierarchy

    • BaseGroundPlugin
      • AdvancedGroundPlugin
    Index

    Constructors

    Properties

    _defaultMaterial: IMaterial
    _dirty: boolean = false
    _material?: IMaterial<IMaterialEventMap>
    _mesh: Reflector2<
        IGeometry<NormalBufferAttributes, BufferGeometryEventMap> & PlaneGeometry,
    >
    _viewer?: ThreeViewer
    _viewerListeners: PartialRecord<IViewerEventTypes, (e: IViewerEvent) => void> = {}
    autoAdjustTransform: boolean = true
    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: boolean = true
    bakedShadows: boolean = true
    constructor: typeof AViewerPluginSync & typeof AViewerPlugin
    enableRefreshTransform: boolean = true

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

    groundReflection: boolean = false
    isViewerPluginSync: true = ...
    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.

    physicalReflections: boolean = false
    planarReflections: boolean
    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
    useModelBounds: boolean = true
    visible: boolean = true
    yOffset: number = 0
    OldPluginType: string = 'Ground'
    PluginType: string = 'AdvancedGroundPlugin'

    Accessors

    Methods

    • Parameters

      • Optionalmaterial: PhysicalMaterial<IMaterialEventMap>

      Returns PhysicalMaterial

    • Parameters

      • event: (
            | {
                geometryChanged?: boolean;
                object: IObject3D;
                options?: AddObjectOptions;
                updateGround?: boolean;
            }
            | {
                bubbleToParent?: boolean;
                change?: string;
                geometry?: | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>
                | null;
                hierarchyChanged?: boolean;
                object?: IObject3D<
                    IObject3DEventMap,
                    IGeometry<NormalBufferAttributes, BufferGeometryEventMap>
                    | undefined,
                    IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[] | undefined,
                >;
                oldGeometry?:
                    | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>
                    | null;
                refreshScene?: boolean;
                sceneUpdate?: boolean;
            } & ISceneSetDirtyOptions
        ) & Event<"addSceneObject" | "sceneUpdate", IScene<ISceneEventMap>>

      Returns void

    • Parameters

      • e: IViewerEvent

      Returns IViewerEvent

    • Parameters

      • Optionalprefix: string

      Returns string

    • Parameters

      • key: any
      • setDirty: boolean = true

      Returns void

    • Parameters

      • key: any
      • setDirty: boolean = true

      Returns void

    • Returns ISerializedConfig | Record<string, never>

    • Parameters

      • state: any

      Returns Promise<void>

    • Parameters

      • Optionalmeta: SerializationMetaType

      Returns ISerializedConfig