@thatopen/components 1.5.0 → 2.0.0-alpha.1

package/dist/core/Clipper/index.d.ts

@@ -0,0 +1,104 @@
+import * as THREE from "three";
+import { Component, Createable, Disposable, Event, Hideable, World } from "../Types";
+import { SimplePlane } from "./src";
+import { Components } from "../Components";
+export * from "./src";
+/**
+ * A lightweight component to easily create and handle
+ * [clipping planes](https://threejs.org/docs/#api/en/materials/Material.clippingPlanes).
+ *
+ * @param components - the instance of {@link Components} used.
+ * @param planeType - the type of plane to be used by the clipper.
+ * E.g. {@link SimplePlane}.
+ */
+export declare class Clipper<T extends SimplePlane> extends Component implements Createable, Disposable, Hideable {
+    static readonly uuid: "66290bc5-18c4-4cd1-9379-2e17a0617611";
+    /** {@link Createable.onAfterCreate} */
+    readonly onAfterCreate: Event<T>;
+    /** {@link Createable.onAfterDelete} */
+    readonly onAfterDelete: Event<T>;
+    /** Event that fires when the user starts dragging a clipping plane. */
+    readonly onBeforeDrag: Event<void>;
+    /** Event that fires when the user stops dragging a clipping plane. */
+    readonly onAfterDrag: Event<void>;
+    readonly onBeforeCreate: Event<unknown>;
+    readonly onBeforeCancel: Event<unknown>;
+    readonly onAfterCancel: Event<unknown>;
+    readonly onBeforeDelete: Event<unknown>;
+    /** {@link Disposable.onDisposed} */
+    readonly onDisposed: Event<string>;
+    /**
+     * Whether to force the clipping plane to be orthogonal in the Y direction
+     * (up). This is desirable when clipping a building horizontally and a
+     * clipping plane is created in its roof, which might have a slight
+     * slope for draining purposes.
+     */
+    orthogonalY: boolean;
+    /**
+     * The tolerance that determines whether an almost-horizontal clipping plane
+     * will be forced to be orthogonal to the Y direction. {@link orthogonalY}
+     * has to be `true` for this to apply.
+     */
+    toleranceOrthogonalY: number;
+    list: T[];
+    protected PlaneType: new (...args: any) => SimplePlane | T;
+    /** The material used in all the clipping planes. */
+    protected _material: THREE.Material;
+    private _size;
+    private _enabled;
+    private _visible;
+    /** {@link Component.enabled} */
+    get enabled(): boolean;
+    /** {@link Component.enabled} */
+    set enabled(state: boolean);
+    /** {@link Hideable.visible } */
+    get visible(): boolean;
+    /** {@link Hideable.visible } */
+    set visible(state: boolean);
+    /** The material of the clipping plane representation. */
+    get material(): THREE.Material;
+    /** The material of the clipping plane representation. */
+    set material(material: THREE.Material);
+    /** The size of the geometric representation of the clippings planes. */
+    get size(): number;
+    /** The size of the geometric representation of the clippings planes. */
+    set size(size: number);
+    constructor(components: Components);
+    endCreation(): void;
+    cancelCreation(): void;
+    /** {@link Disposable.dispose} */
+    dispose(): void;
+    /** {@link Createable.create} */
+    create(world: World): void;
+    /**
+     * Creates a plane in a certain place and with a certain orientation,
+     * without the need of the mouse.
+     *
+     * @param world - the world where this plane should be created.
+     * @param normal - the orientation of the clipping plane.
+     * @param point - the position of the clipping plane.
+     * navigation.
+     */
+    createFromNormalAndCoplanarPoint(world: World, normal: THREE.Vector3, point: THREE.Vector3): T;
+    /**
+     * {@link Createable.delete}
+     *
+     * @param world - the world where the plane to delete is.
+     * @param plane - the plane to delete. If undefined, the first plane
+     * found under the cursor will be deleted.
+     */
+    delete(world: World, plane?: T): void;
+    /** Deletes all the existing clipping planes. */
+    deleteAll(): void;
+    private deletePlane;
+    private pickPlane;
+    private getAllPlaneMeshes;
+    private createPlaneFromIntersection;
+    private getWorldNormal;
+    private normalizePlaneDirectionY;
+    private newPlane;
+    protected newPlaneInstance(world: World, point: THREE.Vector3, normal: THREE.Vector3): T;
+    private updateMaterialsAndPlanes;
+    private _onStartDragging;
+    private _onEndDragging;
+}

package/dist/core/Clipper/src/index.d.ts

@@ -0,0 +1 @@
+export * from "./simple-plane";

package/dist/core/Clipper/src/simple-plane.d.ts

@@ -0,0 +1,61 @@
+import * as THREE from "three";
+import { Hideable, Disposable, Event, World } from "../../Types";
+import { Components } from "../../Components";
+/**
+ * Each of the planes created by {@link SimpleClipper}.
+ */
+export declare class SimplePlane implements Disposable, Hideable {
+    /** Event that fires when the user starts dragging a clipping plane. */
+    readonly onDraggingStarted: Event<unknown>;
+    /** Event that fires when the user stops dragging a clipping plane. */
+    readonly onDraggingEnded: Event<unknown>;
+    /** {@link Disposable.onDisposed} */
+    readonly onDisposed: Event<unknown>;
+    readonly normal: THREE.Vector3;
+    readonly origin: THREE.Vector3;
+    readonly three: THREE.Plane;
+    protected readonly _helper: THREE.Object3D;
+    protected _visible: boolean;
+    protected _enabled: boolean;
+    components: Components;
+    world: World;
+    private _controlsActive;
+    private readonly _arrowBoundBox;
+    private readonly _planeMesh;
+    private readonly _controls;
+    private readonly _hiddenMaterial;
+    get enabled(): boolean;
+    /** {@link Component.enabled} */
+    set enabled(state: boolean);
+    /** {@link Hideable.visible } */
+    get visible(): boolean;
+    /** {@link Hideable.visible } */
+    set visible(state: boolean);
+    /** The meshes used for raycasting */
+    get meshes(): THREE.Mesh[];
+    /** The material of the clipping plane representation. */
+    get planeMaterial(): THREE.Material | THREE.Material[];
+    /** The material of the clipping plane representation. */
+    set planeMaterial(material: THREE.Material | THREE.Material[]);
+    /** The size of the clipping plane representation. */
+    get size(): number;
+    /** Sets the size of the clipping plane representation. */
+    set size(size: number);
+    get helper(): THREE.Object3D<THREE.Object3DEventMap>;
+    constructor(components: Components, world: World, origin: THREE.Vector3, normal: THREE.Vector3, material: THREE.Material, size?: number, activateControls?: boolean);
+    setFromNormalAndCoplanarPoint(normal: THREE.Vector3, point: THREE.Vector3): Promise<void>;
+    /** {@link Updateable.update} */
+    update: () => Promise<void>;
+    /** {@link Disposable.dispose} */
+    dispose(): void;
+    private reset;
+    protected toggleControls(state: boolean): void;
+    private newTransformControls;
+    private initializeControls;
+    private createArrowBoundingBox;
+    private changeDrag;
+    private notifyDraggingChanged;
+    private preventCameraMovement;
+    private newHelper;
+    private static newPlaneMesh;
+}

package/dist/core/Components/index.d.ts

@@ -0,0 +1,52 @@
+import { Component, Disposable, Event } from "../Types";
+/**
+ * The entry point of the Components library.
+ * It can:
+ * - Create and access all the components of the library.
+ * - Update all the updatable components automatically.
+ * - Dispose all the components, preventing memory leaks.
+ */
+export declare class Components implements Disposable {
+    static readonly release = "1.4.21";
+    /** {@link Disposable.onDisposed} */
+    readonly onDisposed: Event<void>;
+    /** The list of components created in this app. */
+    readonly list: Map<string, Component>;
+    /** If disabled, the animation loop will be stopped. */
+    enabled: boolean;
+    private _clock;
+    add(uuid: string, instance: Component): void;
+    /**
+     * Retrieves a component. If it already exists in this app, it returns the instance of the component. If it
+     * doesn't exist, it will instance it automatically.
+     *
+     * @param Component - The component to get or create.
+     */
+    get<U extends Component>(Component: new (components: Components) => U): U;
+    constructor();
+    /**
+     * Initializes the library. It should be called at the start of the app after
+     * initializing the scene, the renderer and the
+     * camera. Additionally, if any component that need a raycaster is
+     * used, the {@link raycaster} will need to be initialized.
+     */
+    init(): void;
+    /**
+     * Disposes the memory of all the components and tools of this instance of
+     * the library. A memory leak will be created if:
+     *
+     * - An instance of the library ends up out of scope and this function isn't
+     * called. This is especially relevant in Single Page Applications (React,
+     * Angular, Vue, etc).
+     *
+     * - Any of the objects of this instance (meshes, geometries, etc) is
+     * referenced by a reference type (object or array).
+     *
+     * You can learn more about how Three.js handles memory leaks
+     * [here](https://threejs.org/docs/#manual/en/introduction/How-to-dispose-of-objects).
+     *
+     */
+    dispose(): void;
+    private update;
+    private static setupBVH;
+}

package/dist/core/Cullers/index.d.ts

@@ -0,0 +1,23 @@
+import { Components } from "../Components";
+import { MeshCullerRenderer, CullerRendererSettings } from "./src";
+import { Component, Event, Disposable, World } from "../Types";
+export * from "./src";
+/**
+ * A tool to handle big scenes efficiently by automatically hiding the objects
+ * that are not visible to the camera.
+ */
+export declare class Cullers extends Component implements Disposable {
+    static readonly uuid: "69f2a50d-c266-44fc-b1bd-fa4d34be89e6";
+    private _enabled;
+    list: Map<string, MeshCullerRenderer>;
+    /** {@link Disposable.onDisposed} */
+    readonly onDisposed: Event<unknown>;
+    /** {@link Component.enabled} */
+    get enabled(): boolean;
+    set enabled(value: boolean);
+    constructor(components: Components);
+    create(world: World, config?: Partial<CullerRendererSettings>): MeshCullerRenderer;
+    delete(world: World): void;
+    /** {@link Disposable.dispose} */
+    dispose(): void;
+}

package/dist/core/Cullers/src/culler-renderer.d.ts

@@ -0,0 +1,66 @@
+import * as THREE from "three";
+import { Components } from "../../Components";
+import { Event, World } from "../../Types";
+export interface CullerRendererSettings {
+    updateInterval?: number;
+    width?: number;
+    height?: number;
+    autoUpdate?: boolean;
+}
+/**
+ * A base renderer to determine visibility on screen
+ */
+export declare class CullerRenderer {
+    /** {@link Disposable.onDisposed} */
+    readonly onDisposed: Event<string>;
+    /**
+     * Fires after making the visibility check to the meshes. It lists the
+     * meshes that are currently visible, and the ones that were visible
+     * just before but not anymore.
+     */
+    readonly onViewUpdated: Event<any>;
+    /** {@link Component.enabled} */
+    enabled: boolean;
+    /**
+     * Needs to check whether there are objects that need to be hidden or shown.
+     * You can bind this to the camera movement, to a certain interval, etc.
+     */
+    needsUpdate: boolean;
+    /**
+     * Render the internal scene used to determine the object visibility. Used
+     * for debugging purposes.
+     */
+    renderDebugFrame: boolean;
+    components: Components;
+    readonly world: World;
+    readonly renderer: THREE.WebGLRenderer;
+    protected autoUpdate: boolean;
+    protected updateInterval: number;
+    protected readonly worker: Worker;
+    protected readonly scene: THREE.Scene;
+    private _width;
+    private _height;
+    private _availableColor;
+    private readonly renderTarget;
+    private readonly bufferSize;
+    private readonly _buffer;
+    constructor(components: Components, world: World, settings?: CullerRendererSettings);
+    /** {@link Disposable.dispose} */
+    dispose(): void;
+    /**
+     * The function that the culler uses to reprocess the scene. Generally it's
+     * better to call needsUpdate, but you can also call this to force it.
+     * @param force if true, it will refresh the scene even if needsUpdate is
+     * not true.
+     */
+    updateVisibility: (force?: boolean) => Promise<void>;
+    protected getAvailableColor(): {
+        r: number;
+        g: number;
+        b: number;
+        code: string;
+    };
+    protected increaseColor(): void;
+    protected decreaseColor(): void;
+    private applySettings;
+}

package/dist/core/Cullers/src/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./culler-renderer";
+export * from "./mesh-culler-renderer";
+export * from "./screen-culler-helper";

package/dist/core/Cullers/src/mesh-culler-renderer.d.ts

@@ -0,0 +1,27 @@
+import * as THREE from "three";
+import { CullerRenderer, CullerRendererSettings } from "./culler-renderer";
+import { Components } from "../../Components";
+import { Event, World } from "../../Types";
+/**
+ * A renderer to determine a mesh visibility on screen
+ */
+export declare class MeshCullerRenderer extends CullerRenderer {
+    threshold: number;
+    readonly onViewUpdated: Event<{
+        seen: Set<THREE.Mesh>;
+        unseen: Set<THREE.Mesh>;
+    }>;
+    colorMeshes: Map<string, THREE.InstancedMesh<THREE.BufferGeometry<THREE.NormalBufferAttributes>, THREE.Material | THREE.Material[]>>;
+    isProcessing: boolean;
+    private _colorCodeMeshMap;
+    private _meshIDColorCodeMap;
+    private _currentVisibleMeshes;
+    private _recentlyHiddenMeshes;
+    private readonly _transparentMat;
+    constructor(components: Components, world: World, settings?: CullerRendererSettings);
+    dispose(): void;
+    add(mesh: THREE.Mesh | THREE.InstancedMesh): void;
+    remove(mesh: THREE.Mesh | THREE.InstancedMesh): void;
+    private handleWorkerMessage;
+    private getAvailableMaterial;
+}

package/dist/core/Cullers/src/screen-culler-helper.d.ts

@@ -0,0 +1 @@
+export declare function readPixelsAsync(gl: WebGL2RenderingContext, x: number, y: number, w: number, h: number, format: any, type: any, dest: ArrayBufferView): Promise<ArrayBufferView>;

package/dist/core/Disposer/index.d.ts

@@ -0,0 +1,43 @@
+import * as THREE from "three";
+import { Components } from "../Components";
+import { Component } from "../Types";
+/**
+ * A tool to safely remove meshes and geometries from memory to
+ * [prevent memory leaks](https://threejs.org/docs/#manual/en/introduction/How-to-dispose-of-objects).
+ */
+export declare class Disposer extends Component {
+    private _disposedComponents;
+    /** {@link Component.enabled} */
+    enabled: boolean;
+    static readonly uuid: "76e9cd8e-ad8f-4753-9ef6-cbc60f7247fe";
+    constructor(components: Components);
+    /**
+     * {@link Component.uuid}.
+     * @return the list of UUIDs of deleted components.
+     */
+    get(): Set<string>;
+    /**
+     * Removes a mesh, its geometry and its materials from memory. If you are
+     * using any of these in other parts of the application, make sure that you
+     * remove them from the mesh before disposing it.
+     *
+     * @param object - the [object](https://threejs.org/docs/#api/en/core/Object3D)
+     * to remove.
+     *
+     * @param materials - whether to dispose the materials of the mesh.
+     *
+     * @param recursive - whether to recursively dispose the children of the mesh.
+     */
+    destroy(object: THREE.Object3D, materials?: boolean, recursive?: boolean): void;
+    /**
+     * Disposes a geometry from memory.
+     *
+     * @param geometry - the
+     * [geometry](https://threejs.org/docs/#api/en/core/BufferGeometry)
+     * to remove.
+     */
+    disposeGeometry(geometry: THREE.BufferGeometry): void;
+    private disposeGeometryAndMaterials;
+    private disposeChildren;
+    private static disposeMaterial;
+}

package/dist/core/Grids/index.d.ts

@@ -0,0 +1,13 @@
+import { Component, Disposable, World, Event } from "../Types";
+import { GridConfig, SimpleGrid } from "./src";
+export declare class Grids extends Component implements Disposable {
+    static readonly uuid: "d1e814d5-b81c-4452-87a2-f039375e0489";
+    list: Map<string, SimpleGrid>;
+    onDisposed: Event<unknown>;
+    config: Required<GridConfig>;
+    /** {@link Component.enabled} */
+    enabled: boolean;
+    create(world: World): void;
+    delete(world: World): void;
+    dispose(): void;
+}

package/dist/core/Grids/src/index.d.ts

@@ -0,0 +1 @@
+export * from "./simple-grid";

package/dist/core/Grids/src/simple-grid.d.ts

@@ -0,0 +1,48 @@
+/// <reference types="node" />
+import * as THREE from "three";
+import { Hideable, Event, World } from "../../Types";
+import { Components } from "../../Components";
+export interface GridConfig {
+    color: THREE.Color;
+    size1: number;
+    size2: number;
+    distance: number;
+}
+/**
+ * An infinite grid. Created by
+ * [fyrestar](https://github.com/Fyrestar/THREE.InfiniteGridHelper)
+ * and translated to typescript by
+ * [dkaraush](https://github.com/dkaraush/THREE.InfiniteGridHelper/blob/master/InfiniteGridHelper.ts).
+ */
+export declare class SimpleGrid implements Hideable, Disposable {
+    /** {@link Disposable.onDisposed} */
+    readonly onDisposed: Event<unknown>;
+    world: World;
+    components: Components;
+    /** {@link Hideable.visible} */
+    get visible(): boolean;
+    /** {@link Hideable.visible} */
+    set visible(visible: boolean);
+    /** The material of the grid. */
+    get material(): THREE.ShaderMaterial;
+    /**
+     * Whether the grid should fade away with distance. Recommended to be true for
+     * perspective cameras and false for orthographic cameras.
+     */
+    get fade(): boolean;
+    /**
+     * Whether the grid should fade away with distance. Recommended to be true for
+     * perspective cameras and false for orthographic cameras.
+     */
+    set fade(active: boolean);
+    private readonly _grid;
+    private _fade;
+    constructor(components: Components, world: World, config: GridConfig);
+    [Symbol.dispose](): void;
+    /** {@link Component.get} */
+    get(): THREE.Mesh<THREE.BufferGeometry<THREE.NormalBufferAttributes>, THREE.Material | THREE.Material[], THREE.Object3DEventMap>;
+    /** {@link Disposable.dispose} */
+    dispose(): void;
+    private setupEvents;
+    private updateZoom;
+}

package/dist/core/Materials/index.d.ts

@@ -0,0 +1,61 @@
+import * as THREE from "three";
+import { Component, Disposable, Event, World } from "../Types";
+import { Components } from "../Components";
+/**
+ * A tool to easily handle the materials of massive amounts of
+ * objects and scene background easily.
+ */
+export declare class Materials extends Component implements Disposable {
+    static readonly uuid: "24989d27-fa2f-4797-8b08-35918f74e502";
+    /** {@link Component.enabled} */
+    enabled: boolean;
+    private _originalBackground;
+    /** {@link Disposable.onDisposed} */
+    readonly onDisposed: Event<string>;
+    list: {
+        [id: string]: {
+            material: THREE.Material;
+            meshes: Set<THREE.Mesh | THREE.InstancedMesh>;
+        };
+    };
+    private _originals;
+    constructor(components: Components);
+    /**
+     * Turns the specified material styles on or off.
+     *
+     * @param active whether to turn it on or off.
+     * @param ids the ids of the style to turn on or off.
+     */
+    set(active: boolean, ids?: string[]): void;
+    /** {@link Disposable.dispose} */
+    dispose(): void;
+    /**
+     * Sets the color of the background of the scene.
+     *
+     * @param color: the color to apply.
+     */
+    setBackgroundColor(color: THREE.Color, world: World): void;
+    /**
+     * Resets the scene background to the color that was being used
+     * before applying the material manager.
+     */
+    resetBackgroundColor(world: World): void;
+    /**
+     * Creates a new material style.
+     * @param id the identifier of the style to create.
+     * @param material the material of the style.
+     */
+    addMaterial(id: string, material: THREE.Material): void;
+    /**
+     * Assign meshes to a certain style.
+     * @param id the identifier of the style.
+     * @param meshes the meshes to assign to the style.
+     */
+    addMeshes(id: string, meshes: THREE.Mesh[]): void;
+    /**
+     * Remove meshes from a certain style.
+     * @param id the identifier of the style.
+     * @param meshes the meshes to assign to the style.
+     */
+    removeMeshes(id: string, meshes: THREE.Mesh[]): void;
+}

package/dist/core/Raycasters/index.d.ts

@@ -0,0 +1,13 @@
+import { Component, Disposable, World, Event } from "../Types";
+import { SimpleRaycaster } from "./src";
+import { Components } from "../Components";
+export declare class Raycasters extends Component implements Disposable {
+    static readonly uuid: "d5d8bdf0-db25-4952-b951-b643af207ace";
+    enabled: boolean;
+    list: Map<string, SimpleRaycaster>;
+    onDisposed: Event<unknown>;
+    constructor(components: Components);
+    get(world: World): SimpleRaycaster;
+    delete(world: World): void;
+    dispose(): void;
+}

package/dist/core/Raycasters/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./mouse";
+export * from "./simple-raycaster";

package/dist/core/Raycasters/src/mouse.d.ts

@@ -0,0 +1,26 @@
+import * as THREE from "three";
+import { Disposable, Event } from "../../Types";
+/**
+ * A helper to easily get the real position of the mouse in the Three.js canvas
+ * to work with tools like the
+ * [raycaster](https://threejs.org/docs/#api/en/core/Raycaster), even if it has
+ * been transformed through CSS or doesn't occupy the whole screen.
+ */
+export declare class Mouse implements Disposable {
+    dom: HTMLCanvasElement;
+    private _event?;
+    private _position;
+    /** {@link Disposable.onDisposed} */
+    readonly onDisposed: Event<unknown>;
+    constructor(dom: HTMLCanvasElement);
+    /**
+     * The real position of the mouse of the Three.js canvas.
+     */
+    get position(): THREE.Vector2;
+    /** {@link Disposable.dispose} */
+    dispose(): void;
+    private getPositionY;
+    private getPositionX;
+    private updateMouseInfo;
+    private setupEvents;
+}

package/dist/core/Raycasters/src/simple-raycaster.d.ts

@@ -0,0 +1,36 @@
+import * as THREE from "three";
+import { Components } from "../../Components";
+import { Event, World, Disposable } from "../../Types";
+import { Mouse } from "./mouse";
+/**
+ * A simple [raycaster](https://threejs.org/docs/#api/en/core/Raycaster)
+ * that allows to easily get items from the scene using the mouse and touch
+ * events.
+ */
+export declare class SimpleRaycaster implements Disposable {
+    /** {@link Component.enabled} */
+    enabled: boolean;
+    components: Components;
+    /** {@link Disposable.onDisposed} */
+    readonly onDisposed: Event<unknown>;
+    /** The position of the mouse in the screen. */
+    readonly mouse: Mouse;
+    readonly three: THREE.Raycaster;
+    world: World;
+    constructor(components: Components, world: World);
+    /** {@link Disposable.dispose} */
+    dispose(): void;
+    /**
+     * Throws a ray from the camera to the mouse or touch event point and returns
+     * the first item found. This also takes into account the clipping planes
+     * used by the renderer.
+     *
+     * @param items - the [meshes](https://threejs.org/docs/#api/en/objects/Mesh)
+     * to query. If not provided, it will query all the meshes stored in
+     * {@link Components.meshes}.
+     */
+    castRay(items?: THREE.Mesh[]): THREE.Intersection | null;
+    castRayFromVector(origin: THREE.Vector3, direction: THREE.Vector3, items?: THREE.Mesh<THREE.BufferGeometry<THREE.NormalBufferAttributes>, THREE.Material | THREE.Material[], THREE.Object3DEventMap>[]): THREE.Intersection<THREE.Object3D<THREE.Object3DEventMap>> | null;
+    private intersect;
+    private filterClippingPlanes;
+}

package/dist/core/Types/index.d.ts

@@ -0,0 +1 @@
+export * from "./src";

package/dist/core/Types/src/base-camera.d.ts

@@ -0,0 +1,11 @@
+import * as THREE from "three";
+import CameraControls from "camera-controls";
+import { BaseWorldItem } from "./base-world-item";
+import { CameraControllable } from "./interfaces";
+export declare abstract class BaseCamera extends BaseWorldItem {
+    abstract enabled: boolean;
+    abstract three: THREE.Camera;
+    abstract controls?: CameraControls;
+    /** Whether is instance is {@link CameraControllable}. */
+    hasCameraControls: () => this is CameraControllable;
+}

package/dist/core/Types/src/base-renderer.d.ts

@@ -0,0 +1,40 @@
+import * as THREE from "three";
+import { Vector2 } from "three";
+import { Event } from "./event";
+import { BaseWorldItem } from "./base-world-item";
+import { Disposable, Resizeable, Updateable } from "./interfaces";
+export declare abstract class BaseRenderer extends BaseWorldItem implements Updateable, Disposable, Resizeable {
+    abstract three: THREE.WebGLRenderer;
+    /** {@link Updateable.onBeforeUpdate} */
+    onAfterUpdate: Event<unknown>;
+    /** {@link Updateable.onAfterUpdate} */
+    onBeforeUpdate: Event<unknown>;
+    /** {@link Disposable.onDisposed} */
+    readonly onDisposed: Event<undefined>;
+    readonly onResize: Event<THREE.Vector2>;
+    /**
+     * Event that fires when there has been a change to the list of clipping
+     * planes used by the active renderer.
+     */
+    readonly onClippingPlanesUpdated: Event<unknown>;
+    abstract update(delta?: number): void | Promise<void>;
+    abstract dispose(): void;
+    abstract getSize(): Vector2;
+    abstract resize(size: Vector2 | undefined): void;
+    /**
+     * The list of [clipping planes](https://threejs.org/docs/#api/en/renderers/WebGLRenderer.clippingPlanes) used by this
+     * instance of the renderer.
+     */
+    clippingPlanes: THREE.Plane[];
+    /**
+     * Forces the update of the clipping planes and all components that depend
+     * on them that are subscribed to `onClippingPlanesUpdated`.
+     */
+    updateClippingPlanes(): void;
+    /**
+     * Adds or removes a
+     * [clipping plane](https://threejs.org/docs/#api/en/renderers/WebGLRenderer.clippingPlanes)
+     * to the renderer.
+     */
+    setPlane(active: boolean, plane: THREE.Plane, isLocal?: boolean): void;
+}