Interface ICamera<TE>

interface ICamera<TE extends ICameraEventMap = ICameraEventMap> {
    __exportState?: {
        fomMap: Map<
            IObject3D<
                IObject3DEventMap,
                undefined
                | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,

                    | undefined
                    | IMaterial<IMaterialEventMap>
                    | IMaterial<IMaterialEventMap>[],
            >,
            undefined | Material<MaterialEventMap> | Material<MaterialEventMap>[],
        >;
        geomMap: Map<
            IObject3D<
                IObject3DEventMap,
                undefined
                | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,

                    | undefined
                    | IMaterial<IMaterialEventMap>
                    | IMaterial<IMaterialEventMap>[],
            >,
            undefined | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        >;
        matCloneMap: Map<
            IMaterial<IMaterialEventMap>,
            IMaterial<IMaterialEventMap>,
        >;
        meshLines: Map<
            IObject3D<
                IObject3DEventMap,
                undefined
                | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,

                    | undefined
                    | IMaterial<IMaterialEventMap>
                    | IMaterial<IMaterialEventMap>[],
            >,
            IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        >;
        objectList: Set<
            IObject3D<
                IObject3DEventMap,
                undefined
                | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,

                    | undefined
                    | IMaterial<IMaterialEventMap>
                    | IMaterial<IMaterialEventMap>[],
            >,
        >;
        savedTextures: Map<
            | IMaterial<IMaterialEventMap>
            | IObject3D<
                IObject3DEventMap,
                undefined
                | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,

                    | undefined
                    | IMaterial<IMaterialEventMap>
                    | IMaterial<IMaterialEventMap>[],
            >,
            Record<string, ITexture<TextureEventMap>>,
        >;
    };
    __meshSetup?: boolean;
    __objectSetup?: boolean;
    __objExtUiConfigs?: Record<
        string,
        | undefined
        | (
            | UiObjectConfig<any, string, any>
            | Fof<ValOrArrOp<UiObjectConfig<any, string, any>>>
        )[],
    >;
    _canvas?: HTMLCanvasElement;
    _currentGeometry?:
        | null
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>;
    _currentMaterial?:
        | null
        | IMaterial<IMaterialEventMap>
        | IMaterial<IMaterialEventMap>[];
    _customDepthMaterial?: Material<MaterialEventMap>;
    _customGBufferMaterial?: Material<MaterialEventMap>;
    _customNormalMaterial?: Material<MaterialEventMap>;
    _loadingPromise?: Promise<any>;
    _onGeometryUpdate?: EventListener2<
        "geometryUpdate",
        BufferGeometryEventMap,
        IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
    >;
    _positionWorld: Vector3;
    _rootPathRefreshed?: boolean;
    _rootPathRefreshing?: boolean;
    _sChildren?: Object3D<Object3DEventMap>[];
    acceptChildEvents?: boolean;
    aspect: number;
    assetType: "camera";
    autoAspect: boolean;
    autoNearFar: boolean;
    autoUpgradeChildren?: boolean;
    boundingBox?: null | Box3;
    boundingSphere?: null | Sphere;
    cameraObject: ICamera;
    canUserInteract: boolean;
    children: IObject3D<
        IObject3DEventMap,
        undefined
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    >[];
    controls: undefined | ICameraControls<ICameraControlsEventMap>;
    controlsCtors: Map<string, TControlsCtor>;
    controlsMode?: string;
    currentMaterial?:
        | null
        | IMaterial<IMaterialEventMap>
        | IMaterial<IMaterialEventMap>[];
    customGBufferMaterial?: Material<MaterialEventMap>;
    customNormalMaterial?: Material<MaterialEventMap>;
    far: number;
    forcedOverrideGeometry?: IGeometry<
        NormalBufferAttributes,
        BufferGeometryEventMap,
    >;
    forcedOverrideMaterial?: | Material<MaterialEventMap>
    | Material<MaterialEventMap>[];
    fov?: number;
    geometry?: undefined;
    interactionsEnabled: boolean;
    isActiveCamera: boolean;
    isAmbientLight?: boolean;
    isCamera: true;
    isDirectionalLight?: boolean;
    isHemisphereLight?: boolean;
    isInstancedMesh?: boolean;
    isLight?: boolean;
    isLine?: boolean;
    isLine2?: boolean;
    isLineSegments?: boolean;
    isLineSegments2?: boolean;
    isMainCamera: boolean;
    isMesh?: boolean;
    isMeshLine?: boolean;
    isOrthographicCamera?: boolean;
    isPerspectiveCamera?: boolean;
    isPointLight?: boolean;
    isPoints?: boolean;
    isRectAreaLight?: boolean;
    isScene?: boolean;
    isSkinnedMesh?: boolean;
    isSpotLight?: boolean;
    isWidget?: boolean;
    isWireframe?: boolean;
    material?: undefined;
    materials?: IMaterial<IMaterialEventMap>[];
    maxFarPlane?: number;
    minNearPlane?: number;
    morphTargetDictionary?: Record<string, number>;
    morphTargetInfluences?: number[];
    near: number;
    objectExtensions?: IObjectExtension[];
    objectProcessor?: IObjectProcessor;
    parent:
        | null
        | IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >;
    parentRoot?:
        | null
        | IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >;
    position: Vector3;
    target: Vector3;
    uiConfig?: UiObjectConfig<any, string, any>;
    userData: ICameraUserData;
    zoom: number;
    activateMain(
        options?: Omit<
            {
                bubbleToParent: boolean;
                camera?: null
                | ICamera<ICameraEventMap>;
                ui?: boolean;
            },
            "bubbleToParent",
        >,
        _internal?: boolean,
        _refresh?: boolean,
    ): void;
    add(
        ...object: IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >[],
    ): this;
    autoCenter(setDirty?: boolean, undo?: boolean): void;
    autoScale(
        autoScaleRadius?: number,
        isCentered?: boolean,
        setDirty?: boolean,
        undo?: boolean,
    ): void;
    clone(recursive?: boolean): this;
    computeBoundingBox(): void;
    computeBoundingSphere(): void;
    computeLineDistances(): void;
    copy(
        source:
            | IObject3D<
                IObject3DEventMap,
                undefined
                | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,

                    | undefined
                    | IMaterial<IMaterialEventMap>
                    | IMaterial<IMaterialEventMap>[],
            >
            | ICamera<ICameraEventMap>
            | Camera<Object3DEventMap>,
        recursive?: boolean,
        distanceFromTarget?: number,
        worldSpace?: boolean,
        ...args: any[],
    ): this;
    deactivateMain(
        options?: Omit<
            {
                bubbleToParent: boolean;
                camera?: null
                | ICamera<ICameraEventMap>;
                ui?: boolean;
            },
            "bubbleToParent",
        >,
        _internal?: boolean,
        _refresh?: boolean,
    ): void;
    dispose(removeFromParent?: boolean): any;
    getObjectById(
        id: number,
    ):
        | undefined
        | IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >;
    getObjectByName(
        name: string,
    ):
        | undefined
        | IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >;
    getObjectByProperty(
        name: string,
        value: string,
    ):
        | undefined
        | IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >;
    getView<T extends ICameraView = CameraView>(
        worldSpace?: boolean,
        cameraView?: T,
    ): T;
    pivotToBoundsCenter(setDirty?: boolean): () => void;
    pivotToPoint(point: Vector3, setDirty?: boolean): this;
    refreshAspect(setDirty?: boolean): void;
    refreshCameraControls(setDirty?: boolean): void;
    refreshFrustum(setDirty?: boolean): void;
    refreshTarget(): void;
    refreshUi(): void;
    remove(
        ...object: IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >[],
    ): this;
    removeControlsCtor(key: string): void;
    setCanvas(canvas: undefined | HTMLCanvasElement, refresh?: boolean): void;
    setControlsCtor(key: string, ctor: TControlsCtor, replace?: boolean): void;
    setDirty(options?: ICameraSetDirtyOptions): void;
    setInteractions(enabled: boolean, by: string, setDirty?: boolean): void;
    setView(view: ICameraView): void;
    setViewFromCamera(
        camera: ICamera<ICameraEventMap> | Camera<Object3DEventMap>,
        distanceFromTarget?: number,
        worldSpace?: boolean,
    ): void;
    setViewToMain(eventOptions: Pick<ICameraEventMap["setView"], "ui">): void;
    traverse(callback: (object: IObject3D) => void): void;
    traverseAncestors(callback: (object: IObject3D) => void): void;
    traverseModels(
        callback: (object: IObject3D) => boolean | void,
        options: { visible: boolean; widgets: boolean; [key: string]: any },
    ): void;
    traverseVisible(callback: (object: IObject3D) => void): void;
    updateMorphTargets(): void;
    updateProjectionMatrix(): void;
    updateShaderProperties(
        material: {
            defines: Record<string, string | number | undefined>;
            uniforms: { [name: string]: IUniform<any> };
        },
    ): this;
}

Type Parameters

TE extends ICameraEventMap = ICameraEventMap

Hierarchy (View Summary)

Camera<TE>
IObject3D<TE, undefined, undefined>
IShaderPropertiesUpdater
- ICamera

Implemented by

Index

Properties

__exportState? __meshSetup? __objectSetup? __objExtUiConfigs? _canvas? _currentGeometry? _currentMaterial? _customDepthMaterial? _customGBufferMaterial? _customNormalMaterial? _loadingPromise? _onGeometryUpdate? _positionWorld _rootPathRefreshed? _rootPathRefreshing? _sChildren? acceptChildEvents? aspect assetType autoAspect autoNearFar autoUpgradeChildren? boundingBox? boundingSphere? cameraObject canUserInteract children controls controlsCtors controlsMode? currentMaterial? customGBufferMaterial? customNormalMaterial? far forcedOverrideGeometry? forcedOverrideMaterial? fov? geometry? interactionsEnabled isActiveCamera isAmbientLight? isCamera isDirectionalLight? isHemisphereLight? isInstancedMesh? isLight? isLine? isLine2? isLineSegments? isLineSegments2? isMainCamera isMesh? isMeshLine? isOrthographicCamera? isPerspectiveCamera? isPointLight? isPoints? isRectAreaLight? isScene? isSkinnedMesh? isSpotLight? isWidget? isWireframe? material? materials? maxFarPlane? minNearPlane? morphTargetDictionary? morphTargetInfluences? near objectExtensions? objectProcessor? parent parentRoot? position target uiConfig? userData zoom

Properties

`Optional`__exportState

__exportState?: {
    fomMap: Map<
        IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >,
        undefined | Material<MaterialEventMap> | Material<MaterialEventMap>[],
    >;
    geomMap: Map<
        IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >,
        undefined | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
    >;
    matCloneMap: Map<
        IMaterial<IMaterialEventMap>,
        IMaterial<IMaterialEventMap>,
    >;
    meshLines: Map<
        IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >,
        IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
    >;
    objectList: Set<
        IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >,
    >;
    savedTextures: Map<
        | IMaterial<IMaterialEventMap>
        | IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >,
        Record<string, ITexture<TextureEventMap>>,
    >;
}

`Optional` `Internal`__meshSetup

__meshSetup?: boolean

If a mesh has been converted to IObject3D using upgradeObject3D, this flag is set to true.

`Optional` `Internal`__objectSetup

__objectSetup?: boolean

If an object has been converted to IObject3D using upgradeObject3D, this flag is set to true.

`Optional`__objExtUiConfigs

__objExtUiConfigs?: Record<
    string,
    | undefined
    | (
        | UiObjectConfig<any, string, any>
        | Fof<ValOrArrOp<UiObjectConfig<any, string, any>>>
    )[],
>

`Optional` `Internal`_canvas

_canvas?: HTMLCanvasElement

reference to the canvas element used for rendering. (for aspect ratio, etc.)

`Optional`_currentGeometry

_currentGeometry?:
| null
| IGeometry<NormalBufferAttributes, BufferGeometryEventMap>

`Optional` `Internal`_currentMaterial

_currentMaterial?:
    | null
    | IMaterial<IMaterialEventMap>
    | IMaterial<IMaterialEventMap>[]

store for the actual material. see also currentMaterial

`Optional` `Internal`_customDepthMaterial

_customDepthMaterial?: Material<MaterialEventMap>

store for the actual customDepthMaterial

`Optional` `Internal`_customGBufferMaterial

_customGBufferMaterial?: Material<MaterialEventMap>

store for the actual customGBufferMaterial

`Optional` `Internal`_customNormalMaterial

_customNormalMaterial?: Material<MaterialEventMap>

store for the actual customNormalMaterial

`Optional`_loadingPromise

_loadingPromise?: Promise<any>

A promise can be set by the object to indicate that the object is loading. This can be used by the scene, viewer, plugins to defer actions until the object is loaded.

`Optional` `Internal`_onGeometryUpdate

_onGeometryUpdate?: EventListener2<
    "geometryUpdate",
    BufferGeometryEventMap,
    IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
>

for embedded objects

`Internal`_positionWorld

_positionWorld: Vector3

world position cache for shader updates and other purposes

`Optional` `Internal`_rootPathRefreshed

_rootPathRefreshed?: boolean

for embedded objects

`Optional` `Internal`_rootPathRefreshing

_rootPathRefreshing?: boolean

when embedded objects are loading

`Optional` `Internal`_sChildren

_sChildren?: Object3D<Object3DEventMap>[]

If this is present, only the objects in this array will be saved in the glb/gltf files, and the object.children array will be ignored. The other properties are expected to be loaded/filled at runtime by default values or from an external asset loaded from IImportResultUserData.rootPath.

for embedded objects.

`Optional`acceptChildEvents

acceptChildEvents?: boolean

Set to false to disable propagation of any events from its children.

aspect

aspect: number

Camera frustum aspect ratio, window width divided by window height. It can be managed internally if autoAspect is true.

Default

assetType

assetType: "camera"

autoAspect

autoAspect: boolean

Automatically manage aspect ratio based on window/canvas size.

autoNearFar

autoNearFar: boolean

`Optional`autoUpgradeChildren

autoUpgradeChildren?: boolean

Set to false to disable automatic call of upgradeObject3D when a child is added.

`Optional`boundingBox

boundingBox?: null | Box3

For InstancedMesh, SkinnedMesh etc

`Optional`boundingSphere

boundingSphere?: null | Sphere

For InstancedMesh, SkinnedMesh etc

cameraObject

cameraObject: ICamera

Deprecated

use this instead

`Readonly`canUserInteract

canUserInteract: boolean

Check whether user can interact with this camera. Interactions can be enabled/disabled in a variety of ways, like setInteractions, controlsMode, isMainCamera property

children

children: IObject3D<
    IObject3DEventMap,
    undefined
    | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
    undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
>[]

Array with object's children.

See

THREE.Object3DGroup | Group for info on manually grouping objects.

Default Value

[]

`Readonly`controls

controls: undefined | ICameraControls<ICameraControlsEventMap>

`Readonly`controlsCtors

controlsCtors: Map<string, TControlsCtor>

`Optional`controlsMode

controlsMode?: string

`Optional`currentMaterial

currentMaterial?:
    | null
    | IMaterial<IMaterialEventMap>
    | IMaterial<IMaterialEventMap>[]

`Optional`customGBufferMaterial

customGBufferMaterial?: Material<MaterialEventMap>

Required for plugins like GBufferPlugin

`Optional`customNormalMaterial

customNormalMaterial?: Material<MaterialEventMap>

Required for plugins like NormalBufferPlugin

far

far: number

Automatically managed when autoNearFar is true. See also maxFarPlane

`Optional`forcedOverrideGeometry

forcedOverrideGeometry?: IGeometry<
NormalBufferAttributes,
BufferGeometryEventMap,
>

If this is set, it will be returned when accessing geometry property.

`Optional`forcedOverrideMaterial

forcedOverrideMaterial?:
| Material<MaterialEventMap>
| Material<MaterialEventMap>[]

If this is set, it will be returned when accessing material property. see GBufferRenderPass for sample usage

`Optional`fov

fov?: number

`Optional`geometry

geometry?: undefined

`Readonly`interactionsEnabled

interactionsEnabled: boolean

If interactions are enabled for this camera. It can be disabled by some code or plugin. see also setInteractions

Deprecated

use canUserInteract to check if the user can interact with this camera

isActiveCamera

isActiveCamera: boolean

Deprecated

use isMainCamera instead

`Optional`isAmbientLight

isAmbientLight?: boolean

`Readonly`isCamera

isCamera: true

Read-only flag to check if a given object is of type Camera.

Remarks

This is a constant value

Default Value

true

`Optional`isDirectionalLight

isDirectionalLight?: boolean

`Optional`isHemisphereLight

isHemisphereLight?: boolean

`Optional`isInstancedMesh

isInstancedMesh?: boolean

`Optional`isLight

isLight?: boolean

`Optional`isLine

isLine?: boolean

`Optional`isLine2

isLine2?: boolean

`Optional`isLineSegments

isLineSegments?: boolean

`Optional`isLineSegments2

isLineSegments2?: boolean

`Readonly`isMainCamera

isMainCamera: boolean

`Optional`isMesh

isMesh?: boolean

`Optional`isMeshLine

isMeshLine?: boolean

`Optional` `Readonly`isOrthographicCamera

isOrthographicCamera?: boolean

`Optional` `Readonly`isPerspectiveCamera

isPerspectiveCamera?: boolean

`Optional`isPointLight

isPointLight?: boolean

`Optional`isPoints

isPoints?: boolean

`Optional`isRectAreaLight

isRectAreaLight?: boolean

`Optional`isScene

isScene?: boolean

`Optional`isSkinnedMesh

isSkinnedMesh?: boolean

`Optional`isSpotLight

isSpotLight?: boolean

`Optional`isWidget

isWidget?: boolean

`Optional`isWireframe

isWireframe?: boolean

`Optional`material

material?: undefined

`Optional` `Readonly`materials

materials?: IMaterial<IMaterialEventMap>[]

Same as material but always returns an array. To set, just set material property

`Optional`maxFarPlane

maxFarPlane?: number

`Optional`minNearPlane

minNearPlane?: number

`Optional`morphTargetDictionary

morphTargetDictionary?: Record<string, number>

`Optional`morphTargetInfluences

morphTargetInfluences?: number[]

near

near: number

Automatically managed when autoNearFar is true. See also minNearPlane

`Optional`objectExtensions

objectExtensions?: IObjectExtension[]

`Optional`objectProcessor

objectProcessor?: IObjectProcessor

parent

Object's parent in the scene graph.

Remarks

An object can have at most one parent.

Default Value

null

`Optional`parentRoot

Parent/Ancestor of this object to bubble events to. This is set internally by setupObject3D.

position

position: Vector3

Local position of camera.

target

target: Vector3

Target of camera, in world(global) coordinates.

`Optional`uiConfig

uiConfig?: UiObjectConfig<any, string, any>

userData

userData: ICameraUserData

An object that can be used to store custom data about the Object3D.

Remarks

It should not hold references to functions as these will not be cloned.

Default

{}

zoom

zoom: number

Methods

activateMain

activateMain(
    options?: Omit<
        {
            bubbleToParent: boolean;
            camera?: null
            | ICamera<ICameraEventMap>;
            ui?: boolean;
        },
        "bubbleToParent",
    >,
    _internal?: boolean,
    _refresh?: boolean,
): void
Parameters
- Optionaloptions: Omit<
      {
          bubbleToParent: boolean;
          camera?: null
          | ICamera<ICameraEventMap>;
          ui?: boolean;
      },
      "bubbleToParent",
  >
- Optional_internal: boolean
- Optional_refresh: boolean
Returns void
- Defined in src/core/ICamera.ts:66

add

add(
    ...object: IObject3D<
        IObject3DEventMap,
        undefined
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    >[],
): this
Adds another Object3D as child of this Object3D.
Parameters
- ...object: IObject3D<
      IObject3DEventMap,
      undefined
      | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
      undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
  >[]
Returns this
Remarks
An arbitrary number of objects may be added Any current parent on an object passed in here will be removed, since an Object3D can have at most one parent.
See
- attach
- THREE.Group | Group for info on manually grouping objects.
Overrides Camera.add
- Defined in src/core/ICamera.ts:192

`Optional`autoCenter

autoCenter(setDirty?: boolean, undo?: boolean): void
Moves the bounding box center of the object to the center of the world
Parameters
- OptionalsetDirty: boolean
  calls setDirty
- Optionalundo: boolean
  undo any previous autoCenter operation
Returns void
Default
```
true
```
Inherited from IObject3D.autoCenter
- Defined in src/core/IObject.ts:429

`Optional`autoScale

autoScale(
    autoScaleRadius?: number,
    isCentered?: boolean,
    setDirty?: boolean,
    undo?: boolean,
): void
Scales the object to fit the given radius.
Parameters
- OptionalautoScaleRadius: number
  optional (taken from userData.autoScaleRadius by default)
- OptionalisCentered: boolean
  optional (taken from userData.isCentered by default)
- OptionalsetDirty: boolean
  true by default
- Optionalundo: boolean
  undo any previous autoScale operation
Returns void
Inherited from IObject3D.autoScale
- Defined in src/core/IObject.ts:421

clone

clone(recursive?: boolean): this
Returns a clone of this object and optionally all descendants.
Parameters
- Optionalrecursive: boolean
  If true, descendants of the object are also cloned. Default true
Returns this
Overrides Camera.clone
- Defined in src/core/ICamera.ts:191

`Optional`computeBoundingBox

computeBoundingBox(): void
For InstancedMesh, SkinnedMesh etc Computes bounding box, updating .boundingBox attribute.

Returns void
Remarks
Bounding boxes aren't computed by default. They need to be explicitly computed, otherwise they are null.
Inherited from IObject3D.computeBoundingBox
- Defined in src/core/IObject.ts:481

`Optional`computeBoundingSphere

computeBoundingSphere(): void
For InstancedMesh, SkinnedMesh etc Computes bounding sphere, updating .boundingSphere attribute.

Returns void
Remarks
bounding spheres aren't computed by default. They need to be explicitly computed, otherwise they are null.
Inherited from IObject3D.computeBoundingSphere
- Defined in src/core/IObject.ts:488

`Optional`computeLineDistances

computeLineDistances(): void
For LineSegments, Line2 etc

Returns void
Inherited from IObject3D.computeLineDistances
- Defined in src/core/IObject.ts:493

copy

copy(
    source:
        | IObject3D<
            IObject3DEventMap,
            undefined
            | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
            undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
        >
        | ICamera<ICameraEventMap>
        | Camera<Object3DEventMap>,
    recursive?: boolean,
    distanceFromTarget?: number,
    worldSpace?: boolean,
    ...args: any[],
): this
Copy the given object into this object
Parameters
- source:
      | IObject3D<
          IObject3DEventMap,
          undefined
          | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
          undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
      >
      | ICamera<ICameraEventMap>
      | Camera<Object3DEventMap>
- Optionalrecursive: boolean
  If true, descendants of the object are also copied. Default true
- OptionaldistanceFromTarget: number
- OptionalworldSpace: boolean
- ...args: any[]
Returns this
Remarks
Note: event listeners and user-defined callbacks (.onAfterRender and .onBeforeRender) are not copied.
Overrides Camera.copy
- Defined in src/core/ICamera.ts:190

deactivateMain

deactivateMain(
    options?: Omit<
        {
            bubbleToParent: boolean;
            camera?: null
            | ICamera<ICameraEventMap>;
            ui?: boolean;
        },
        "bubbleToParent",
    >,
    _internal?: boolean,
    _refresh?: boolean,
): void
Parameters
- Optionaloptions: Omit<
      {
          bubbleToParent: boolean;
          camera?: null
          | ICamera<ICameraEventMap>;
          ui?: boolean;
      },
      "bubbleToParent",
  >
- Optional_internal: boolean
- Optional_refresh: boolean
Returns void
- Defined in src/core/ICamera.ts:67

`Optional`dispose

dispose(removeFromParent?: boolean): any
Parameters
- OptionalremoveFromParent: boolean
  remove from parent. Default true
Returns any
Inherited from IObject3D.dispose
- Defined in src/core/IObject.ts:460

getObjectById

getObjectById(
    id: number,
):
    | undefined
    | IObject3D<
        IObject3DEventMap,
        undefined
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    >
Searches through an object and its children, starting with the object itself, and returns the first with a matching id.
Parameters
- id: number
  Unique number of the object instance. Expects a Integer
Returns
    | undefined
    | IObject3D<
        IObject3DEventMap,
        undefined
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    >
Remarks
Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

See
id
Overrides IObject3D.getObjectById
- Defined in src/core/ICamera.ts:187

getObjectByName

getObjectByName(
    name: string,
):
    | undefined
    | IObject3D<
        IObject3DEventMap,
        undefined
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    >
Searches through an object and its children, starting with the object itself, and returns the first with a matching name.
Parameters
- name: string
  String to match to the children's Object3D.name property.
Returns
    | undefined
    | IObject3D<
        IObject3DEventMap,
        undefined
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    >
Remarks
Note that for most objects the name is an empty string by default You will have to set it manually to make use of this method.
Overrides IObject3D.getObjectByName
- Defined in src/core/ICamera.ts:188

getObjectByProperty

getObjectByProperty(
    name: string,
    value: string,
):
    | undefined
    | IObject3D<
        IObject3DEventMap,
        undefined
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    >
Searches through an object and its children, starting with the object itself, and returns the first with a property that matches the value given.
Parameters
- name: string
  the property name to search for.
- value: string
  value of the given property.
Returns
    | undefined
    | IObject3D<
        IObject3DEventMap,
        undefined
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    >
Overrides IObject3D.getObjectByProperty
- Defined in src/core/ICamera.ts:189

getView

getView<T extends ICameraView = CameraView>(
worldSpace?: boolean,
cameraView?: T,
): T
Type Parameters
- T extends ICameraView = CameraView
Parameters
- OptionalworldSpace: boolean
- OptionalcameraView: T
Returns T
- Defined in src/core/ICamera.ts:156

`Optional`pivotToBoundsCenter

pivotToBoundsCenter(setDirty?: boolean): () => void
Moves the object pivot to the center of the bounding box.

The object will rotate around the new pivot.
Parameters
- OptionalsetDirty: boolean
  calls setDirty
Returns () => void
undo function
Default
```
true
```
Inherited from IObject3D.pivotToBoundsCenter
- Defined in src/core/IObject.ts:439

`Optional`pivotToPoint

pivotToPoint(point: Vector3, setDirty?: boolean): this
Moves the object pivot to the given point

The object will rotate around the new pivot.
Parameters
- point: Vector3
  point to move the pivot to
- OptionalsetDirty: boolean
  calls setDirty
Returns this
undo function
Default
```
true
```
Inherited from IObject3D.pivotToPoint
- Defined in src/core/IObject.ts:450

refreshAspect

refreshAspect(setDirty?: boolean): void
Parameters
- OptionalsetDirty: boolean
Returns void
- Defined in src/core/ICamera.ts:77

refreshCameraControls

refreshCameraControls(setDirty?: boolean): void
Parameters
- OptionalsetDirty: boolean
Returns void
- Defined in src/core/ICamera.ts:145

`Optional`refreshFrustum

refreshFrustum(setDirty?: boolean): void
Refresh the camera frustum planes from frustumSize. Only for orthographic cameras.
Parameters
- OptionalsetDirty: boolean
Returns void
- Defined in src/core/ICamera.ts:154

refreshTarget

refreshTarget(): void
Returns void
- Defined in src/core/ICamera.ts:76

`Optional`refreshUi

refreshUi(): void
Returns void
Inherited from IObject3D.refreshUi
- Defined in src/core/IObject.ts:408

remove

remove(
    ...object: IObject3D<
        IObject3DEventMap,
        undefined
        | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
        undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
    >[],
): this
Removes a Object3D as child of this Object3D.
Parameters
- ...object: IObject3D<
      IObject3DEventMap,
      undefined
      | IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
      undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
  >[]
Returns this
Remarks
An arbitrary number of objects may be removed.

See
THREE.Group | Group for info on manually grouping objects.
Overrides Camera.remove
- Defined in src/core/ICamera.ts:193

removeControlsCtor

removeControlsCtor(key: string): void
Parameters
- key: string
Returns void
- Defined in src/core/ICamera.ts:144

setCanvas

setCanvas(canvas: undefined | HTMLCanvasElement, refresh?: boolean): void
Set the canvas which is used as dom element in controls, etc. This is done by the viewer/scene when main camera is changed
Parameters
- canvas: undefined | HTMLCanvasElement
- Optionalrefresh: boolean
Returns void
- Defined in src/core/ICamera.ts:179

setControlsCtor

setControlsCtor(key: string, ctor: TControlsCtor, replace?: boolean): void
Parameters
- key: string
- ctor: TControlsCtor
- Optionalreplace: boolean
Returns void
- Defined in src/core/ICamera.ts:143

setDirty

setDirty(options?: ICameraSetDirtyOptions): void
Dispatches 'objectUpdate' event on object.
Parameters
- Optionaloptions: ICameraSetDirtyOptions
Returns void
Overrides IObject3D.setDirty
- Defined in src/core/ICamera.ts:60

setInteractions

setInteractions(enabled: boolean, by: string, setDirty?: boolean): void
Parameters
- enabled: boolean
- by: string
- OptionalsetDirty: boolean
Returns void
- Defined in src/core/ICamera.ts:95

setView

setView(view: ICameraView): void
Parameters
- view: ICameraView
Returns void
- Defined in src/core/ICamera.ts:157

setViewFromCamera

setViewFromCamera(
    camera: ICamera<ICameraEventMap> | Camera<Object3DEventMap>,
    distanceFromTarget?: number,
    worldSpace?: boolean,
): void
Set camera view from another camera.
Parameters
- camera: ICamera<ICameraEventMap> | Camera<Object3DEventMap>
- OptionaldistanceFromTarget: number
  default = 4
- OptionalworldSpace: boolean
  default = true
Returns void
- Defined in src/core/ICamera.ts:165

setViewToMain

setViewToMain(eventOptions: Pick<ICameraEventMap["setView"], "ui">): void
Dispatches the setView event which triggers the main camera to set its view to this camera's view.
Parameters
- eventOptions: Pick<ICameraEventMap["setView"], "ui">
Returns void
- Defined in src/core/ICamera.ts:171

traverse

traverse(callback: (object: IObject3D) => void): void
Executes the callback on this object and all descendants.
Parameters
- callback: (object: IObject3D) => void
  A function with as first argument an Object3D object.
Returns void
Remarks
Note: Modifying the scene graph inside the callback is discouraged.
Overrides IObject3D.traverse
- Defined in src/core/ICamera.ts:184

traverseAncestors

traverseAncestors(callback: (object: IObject3D) => void): void
Executes the callback on all ancestors.
Parameters
- callback: (object: IObject3D) => void
  A function with as first argument an Object3D object.
Returns void
Remarks
Note: Modifying the scene graph inside the callback is discouraged.
Overrides IObject3D.traverseAncestors
- Defined in src/core/ICamera.ts:186

`Optional`traverseModels

traverseModels(
callback: (object: IObject3D) => boolean | void,
options: { visible: boolean; widgets: boolean; [key: string]: any },
): void
Traverse only upgraded objects with extra options
Parameters
- callback: (object: IObject3D) => boolean | void
- options: { visible: boolean; widgets: boolean; [key: string]: any }
  visible: traverse only visible objects, widgets: traverse widgets also
Returns void
Inherited from IObject3D.traverseModels
- Defined in src/core/IObject.ts:537

traverseVisible

traverseVisible(callback: (object: IObject3D) => void): void
Like traverse, but the callback will only be executed for visible objects
Parameters
- callback: (object: IObject3D) => void
  A function with as first argument an Object3D object.
Returns void
Remarks
Descendants of invisible objects are not traversed. Note: Modifying the scene graph inside the callback is discouraged.
Overrides IObject3D.traverseVisible
- Defined in src/core/ICamera.ts:185

`Optional`updateMorphTargets

updateMorphTargets(): void
Returns void
Inherited from IObject3D.updateMorphTargets
- Defined in src/core/IObject.ts:391

updateProjectionMatrix

updateProjectionMatrix(): void
Returns void
- Defined in src/core/ICamera.ts:147

updateShaderProperties

updateShaderProperties(
    material: {
        defines: Record<string, string | number | undefined>;
        uniforms: { [name: string]: IUniform<any> };
    },
): this
Parameters
- material: {
  defines: Record<string, string | number | undefined>;
  uniforms: { [name: string]: IUniform<any> };
  }
Returns this
Inherited from IShaderPropertiesUpdater.updateShaderProperties
- Defined in src/materials/MaterialExtension.ts:143

Interface ICamera<TE>

Type Parameters

Hierarchy (View Summary)

Implemented by

Index

Properties

Methods

Properties

Optional__exportState

Optional Internal__meshSetup

Optional Internal__objectSetup

Optional__objExtUiConfigs

Optional Internal_canvas

Optional_currentGeometry

Optional Internal_currentMaterial

Optional Internal_customDepthMaterial

Optional Internal_customGBufferMaterial

Optional Internal_customNormalMaterial

Optional_loadingPromise

Optional Internal_onGeometryUpdate

Internal_positionWorld

Optional Internal_rootPathRefreshed

Optional Internal_rootPathRefreshing

Optional Internal_sChildren

OptionalacceptChildEvents

aspect

Default

assetType

autoAspect

autoNearFar

OptionalautoUpgradeChildren

OptionalboundingBox

OptionalboundingSphere

cameraObject

Deprecated

ReadonlycanUserInteract

children

See

Default Value

Readonlycontrols

ReadonlycontrolsCtors

OptionalcontrolsMode

OptionalcurrentMaterial

OptionalcustomGBufferMaterial

OptionalcustomNormalMaterial

far

OptionalforcedOverrideGeometry

OptionalforcedOverrideMaterial

Optionalfov

Optionalgeometry

ReadonlyinteractionsEnabled

Deprecated

isActiveCamera

Deprecated

OptionalisAmbientLight

ReadonlyisCamera

Remarks

Default Value

OptionalisDirectionalLight

OptionalisHemisphereLight

OptionalisInstancedMesh

OptionalisLight

OptionalisLine

OptionalisLine2

OptionalisLineSegments

OptionalisLineSegments2

ReadonlyisMainCamera

OptionalisMesh

OptionalisMeshLine

Optional ReadonlyisOrthographicCamera

Optional ReadonlyisPerspectiveCamera

OptionalisPointLight

OptionalisPoints

OptionalisRectAreaLight

OptionalisScene

OptionalisSkinnedMesh

OptionalisSpotLight

OptionalisWidget

OptionalisWireframe

Optionalmaterial

`Optional`__exportState

`Optional` `Internal`__meshSetup

`Optional` `Internal`__objectSetup

`Optional`__objExtUiConfigs

`Optional` `Internal`_canvas

`Optional`_currentGeometry

`Optional` `Internal`_currentMaterial

`Optional` `Internal`_customDepthMaterial

`Optional` `Internal`_customGBufferMaterial

`Optional` `Internal`_customNormalMaterial

`Optional`_loadingPromise

`Optional` `Internal`_onGeometryUpdate

`Internal`_positionWorld

`Optional` `Internal`_rootPathRefreshed

`Optional` `Internal`_rootPathRefreshing

`Optional` `Internal`_sChildren

`Optional`acceptChildEvents

`Optional`autoUpgradeChildren

`Optional`boundingBox

`Optional`boundingSphere

`Readonly`canUserInteract

`Readonly`controls

`Readonly`controlsCtors

`Optional`controlsMode

`Optional`currentMaterial

`Optional`customGBufferMaterial

`Optional`customNormalMaterial

`Optional`forcedOverrideGeometry

`Optional`forcedOverrideMaterial

`Optional`fov

`Optional`geometry

`Readonly`interactionsEnabled

`Optional`isAmbientLight

`Readonly`isCamera

`Optional`isDirectionalLight

`Optional`isHemisphereLight

`Optional`isInstancedMesh

`Optional`isLight

`Optional`isLine

`Optional`isLine2

`Optional`isLineSegments

`Optional`isLineSegments2

`Readonly`isMainCamera

`Optional`isMesh

`Optional`isMeshLine

`Optional` `Readonly`isOrthographicCamera

`Optional` `Readonly`isPerspectiveCamera

`Optional`isPointLight

`Optional`isPoints

`Optional`isRectAreaLight

`Optional`isScene

`Optional`isSkinnedMesh

`Optional`isSpotLight

`Optional`isWidget

`Optional`isWireframe

`Optional`material

`Optional` `Readonly`materials

`Optional`maxFarPlane

`Optional`minNearPlane

`Optional`morphTargetDictionary

`Optional`morphTargetInfluences

`Optional`objectExtensions

`Optional`objectProcessor

`Optional`parentRoot

`Optional`uiConfig

`Optional`autoCenter

`Optional`autoScale

`Optional`computeBoundingBox

`Optional`computeBoundingSphere

`Optional`computeLineDistances

`Optional`dispose

Returns
| undefined
| IObject3D<
IObject3DEventMap,
undefined
| IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
>

Returns
| undefined
| IObject3D<
IObject3DEventMap,
undefined
| IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
>

Returns
| undefined
| IObject3D<
IObject3DEventMap,
undefined
| IGeometry<NormalBufferAttributes, BufferGeometryEventMap>,
undefined | IMaterial<IMaterialEventMap> | IMaterial<IMaterialEventMap>[],
>