Interface Renderer

Controller for the three.js scene

interface Renderer {
    config: ParsedViewerConfig;
    state: ViewerState;
    viewer: Viewer;
    get panoramaPose(): Euler;
    get sphereCorrection(): Euler;
    addObject(object: Object3D): void;
    getIntersections(
        viewerPoint: Point,
    ): Intersection<
        Mesh<
            BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            Material | Material[],
            Object3DEventMap,
        >,
    >[];
    hide(): void;
    isObjectVisible(value: Vector3 | Object3D<Object3DEventMap>): boolean;
    removeObject(object: Object3D): void;
    setCustomRenderer(
        factory: (renderer: WebGLRenderer) => CustomRenderer,
    ): void;
    show(): void;
}

Hierarchy

AbstractService
- Renderer

Index

Properties

`Protected` `Readonly`config

config: ParsedViewerConfig

`Protected` `Readonly`state

state: ViewerState

`Protected` `Readonly`viewer

viewer: Viewer

Accessors

panoramaPose

get panoramaPose(): Euler
Returns Euler
- Defined in packages/core/src/services/Renderer.ts:78

sphereCorrection

get sphereCorrection(): Euler
Returns Euler
- Defined in packages/core/src/services/Renderer.ts:82

Methods

addObject

addObject(object: Object3D): void
Adds an object to the THREE scene
Parameters
- object: Object3D
Returns void
- Defined in packages/core/src/services/Renderer.ts:497

getIntersections

getIntersections(
    viewerPoint: Point,
): Intersection<
    Mesh<
        BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        Material | Material[],
        Object3DEventMap,
    >,
>[]
Returns intersections with objects in the scene
Parameters
- viewerPoint: Point
Returns Intersection<
    Mesh<
        BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        Material | Material[],
        Object3DEventMap,
    >,
>[]
- Defined in packages/core/src/services/Renderer.ts:444

hide

hide(): void
Hides the viewer

Returns void
- Defined in packages/core/src/services/Renderer.ts:184

isObjectVisible

isObjectVisible(value: Vector3 | Object3D<Object3DEventMap>): boolean
Checks if an object/point is currently visible
Parameters
- value: Vector3 | Object3D<Object3DEventMap>
Returns boolean
- Defined in packages/core/src/services/Renderer.ts:465

removeObject

removeObject(object: Object3D): void
Removes an object from the THREE scene
Parameters
- object: Object3D
Returns void
- Defined in packages/core/src/services/Renderer.ts:504

setCustomRenderer

setCustomRenderer(factory: (renderer: WebGLRenderer) => CustomRenderer): void
Resets or replaces the THREE renderer by a custom one
Parameters
- factory: (renderer: WebGLRenderer) => CustomRenderer
Returns void
- Defined in packages/core/src/services/Renderer.ts:198

show

show(): void
Shows the viewer

Returns void
- Defined in packages/core/src/services/Renderer.ts:191

Interface Renderer

Hierarchy

Index

Properties

Accessors

Methods

Properties

`Protected` `Readonly`config

`Protected` `Readonly`state

`Protected` `Readonly`viewer

Accessors

panoramaPose

Returns Euler

sphereCorrection

Returns Euler

Methods

addObject

Parameters

Returns void

getIntersections

Parameters

Returns Intersection<
    Mesh<
        BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        Material | Material[],
        Object3DEventMap,
    >,
>[]

hide

Returns void

isObjectVisible

Parameters

Returns boolean

removeObject

Parameters

Returns void

setCustomRenderer

Parameters

Returns void

show

Returns void

Settings

On This Page

Interface Renderer

Hierarchy

Index

Properties

Accessors

Methods

Properties

Protected Readonlyconfig

Protected Readonlystate

Protected Readonlyviewer

Accessors

panoramaPose

Returns Euler

sphereCorrection

Returns Euler

Methods

addObject

Parameters

Returns void

getIntersections

Parameters

Returns Intersection< Mesh< BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>, Material | Material[], Object3DEventMap, >,>[]

hide

Returns void

isObjectVisible

Parameters

Returns boolean

removeObject

Parameters

Returns void

setCustomRenderer

Parameters

Returns void

show

Returns void

Settings

On This Page

`Protected` `Readonly`config

`Protected` `Readonly`state

`Protected` `Readonly`viewer

Returns Intersection<
Mesh<
BufferGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
Material | Material[],
Object3DEventMap,
>,
>[]