ThreePipe
    Preparing search index...

    Class BaseGroundPlugin<TE>

    Base Class for Sync Viewer Plugins

    Type Parameters

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    _defaultMaterial _dirty _geometry _material? _mesh _viewer? _viewerListeners autoAdjustTransform constructor enableRefreshTransform isViewerPluginSync limitCameraAboveGround renderToDepth size tonemapGround uiConfig? useModelBounds visible yOffset OldPluginType PluginType

    Accessors

    dirty enabled material mesh

    Methods

    _createMaterial _createMesh _onSceneUpdate _onViewerEvent _postFrame _preRender _refreshMaterial _refreshTransform _removeMaterial _storeKey disable dispose enable exportState fromJSON importState isDisabled onAdded onRemove refresh refreshTransform setDirty? setGeometry toJSON

    Constructors

    Properties

    Protected_defaultMaterial

    _defaultMaterial: IMaterial

    Protected_dirty

    _dirty: boolean = false

    Protected_geometry

    _geometry: IGeometry<NormalBufferAttributes, BufferGeometryEventMap> & PlaneGeometry

    Protected Optional_material

    _material?: IMaterial<IMaterialEventMap>

    Protected_mesh

    _mesh: Mesh2<
        IGeometry<NormalBufferAttributes, BufferGeometryEventMap> & PlaneGeometry,
        IMaterial<IMaterialEventMap>,
    >

    Protected Optional_viewer

    _viewer?: ThreeViewer

    Protected_viewerListeners

    _viewerListeners: PartialRecord<IViewerEventTypes, (e: IViewerEvent) => void> = {}
    autoAdjustTransform: boolean = true
    constructor: typeof AViewerPluginSync & typeof AViewerPlugin
    enableRefreshTransform: boolean = true

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

    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.

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

    Accessors

    Methods

    Protected_createMaterial

    Protected_createMesh

    Protected_onSceneUpdate

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

      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

    Protected_onViewerEvent

    Protected_postFrame

    Protected_preRender

    Protected_refreshMaterial

    Protected_refreshTransform

    Protected_removeMaterial

    Protected_storeKey

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods