Interface ICamera<E, ET>

interface ICamera<
    E extends ICameraEvent = ICameraEvent,
    ET extends ICameraEventTypes = ICameraEventTypes,
> {
    _currentGeometry?: null | IGeometry;
    _currentMaterial?: null | IMaterial | IMaterial[];
    _onGeometryUpdate?: (e: IGeometryEvent<"geometryUpdate">) => void;
    aspect: number;
    assetType: "camera";
    autoAspect: boolean;
    autoNearFar: boolean;
    cameraObject: ICamera<E, ET>;
    canUserInteract: boolean;
    children: IObject3D[];
    controls: undefined | ICameraControls;
    controlsMode?: string;
    far: number;
    fov?: number;
    geometry?: IGeometry;
    interactionsEnabled: boolean;
    isActiveCamera: boolean;
    isCamera: true;
    isLight?: boolean;
    isLine?: boolean;
    isLineSegments?: boolean;
    isMainCamera: boolean;
    isMesh?: boolean;
    isOrthographicCamera?: boolean;
    isPerspectiveCamera?: boolean;
    isScene?: boolean;
    isWidget?: boolean;
    material?: IMaterial | IMaterial[];
    materials?: IMaterial[];
    maxFarPlane: number;
    minNearPlane: number;
    modelObject: ICamera<E, ET>;
    morphTargetDictionary?: Record<string, number>;
    morphTargetInfluences?: number[];
    near: number;
    objectProcessor?: IObjectProcessor;
    parent: null | IObject3D;
    parentRoot?: null | IObject3D;
    position: Vector3;
    target: Vector3;
    uiConfig?: UiObjectConfig;
    userData: ICameraUserData;
    zoom: number;
    activateMain(
        options?: Partial<ICameraEvent>,
        _internal?: boolean,
        _refresh?: boolean,
    ): void;
    add(...object: IObject3D[]): this;
    autoCenter(setDirty?: boolean, undo?: boolean): this;
    autoScale(
        autoScaleRadius?: number,
        isCentered?: boolean,
        setDirty?: boolean,
        undo?: boolean,
    ): this;
    clone(recursive?: boolean): this;
    copy(
        source: this,
        recursive?: boolean,
        distanceFromTarget?: number,
        worldSpace?: boolean,
        ...args: any[],
    ): this;
    deactivateMain(
        options?: Partial<ICameraEvent>,
        _internal?: boolean,
        _refresh?: boolean,
    ): void;
    dispose(removeFromParent?: boolean): void;
    getObjectById<T extends IObject3D = IObject3D>(id: number): undefined | T;
    getObjectByName<T extends IObject3D = IObject3D>(
        name: string,
    ): undefined | T;
    getObjectByProperty<T extends IObject3D = IObject3D>(
        name: string,
        value: string,
    ): undefined | T;
    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;
    refreshTarget(): void;
    refreshUi(): void;
    remove(...object: IObject3D[]): this;
    removeControlsCtor(key: string): void;
    setControlsCtor(key: string, ctor: TControlsCtor, replace?: boolean): void;
    setDirty(options?: IObjectSetDirtyOptions): void;
    setInteractions(enabled: boolean, by: string): void;
    setView(view: ICameraView): void;
    setViewFromCamera(
        camera: Camera | ICamera,
        distanceFromTarget?: number,
        worldSpace?: boolean,
    ): void;
    setViewToMain(eventOptions: Partial<ICameraEvent>): void;
    traverse(callback: (object: IObject3D) => void): void;
    traverseAncestors(callback: (object: IObject3D) => void): void;
    traverseVisible(callback: (object: IObject3D) => void): void;
    updateMorphTargets(): void;
    updateProjectionMatrix(): void;
    updateShaderProperties(
        material: {
            defines: Record<string, undefined | string | number>;
            uniforms: { [name: string]: IUniform };
        },
    ): this;
}

Type Parameters

Hierarchy (View Summary)

Implemented by

Properties

_currentGeometry? _currentMaterial? _onGeometryUpdate? aspect assetType autoAspect autoNearFar cameraObject canUserInteract children controls controlsMode? far fov? geometry? interactionsEnabled isActiveCamera isCamera isLight? isLine? isLineSegments? isMainCamera isMesh? isOrthographicCamera? isPerspectiveCamera? isScene? isWidget? material? materials? maxFarPlane minNearPlane modelObject morphTargetDictionary? morphTargetInfluences? near objectProcessor? parent parentRoot? position target uiConfig? userData zoom

Methods

activateMain add autoCenter? autoScale? clone copy deactivateMain dispose getObjectById getObjectByName getObjectByProperty getView pivotToBoundsCenter? pivotToPoint? refreshAspect refreshCameraControls refreshTarget refreshUi remove removeControlsCtor setControlsCtor setDirty setInteractions setView setViewFromCamera setViewToMain traverse traverseAncestors traverseVisible updateMorphTargets? updateProjectionMatrix updateShaderProperties

Properties

Optional_currentGeometry

_currentGeometry?: null | IGeometry

Optional_currentMaterial

_currentMaterial?: null | IMaterial | IMaterial[]

Optional_onGeometryUpdate

_onGeometryUpdate?: (e: IGeometryEvent<"geometryUpdate">) => void

aspect

aspect: number

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

Default

1

assetType

assetType: "camera"

autoAspect

autoAspect: boolean

Automatically manage aspect ratio based on window/canvas size.

autoNearFar

autoNearFar: boolean

cameraObject

cameraObject: ICamera<E, ET>

Deprecated

use this instead

ReadonlycanUserInteract

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[]

Array with object's children.

See

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

Default Value

[]

Readonlycontrols

controls: undefined | ICameraControls

OptionalcontrolsMode

controlsMode?: string

far

far: number

Automatically managed when autoNearFar is true. See also maxFarPlane

Optionalfov

fov?: number

Optionalgeometry

geometry?: IGeometry

ReadonlyinteractionsEnabled

interactionsEnabled: boolean

isActiveCamera

isActiveCamera: boolean

Deprecated

use isMainCamera instead

ReadonlyisCamera

isCamera: true

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

Remarks

This is a constant value

Default Value

true

OptionalisLight

isLight?: boolean

OptionalisLine

isLine?: boolean

OptionalisLineSegments

isLineSegments?: boolean

ReadonlyisMainCamera

isMainCamera: boolean

OptionalisMesh

isMesh?: boolean

Optional ReadonlyisOrthographicCamera

isOrthographicCamera?: boolean

Optional ReadonlyisPerspectiveCamera

isPerspectiveCamera?: boolean

OptionalisScene

isScene?: boolean

OptionalisWidget

isWidget?: boolean

Optionalmaterial

material?: IMaterial | IMaterial[]

Optional Readonlymaterials

materials?: IMaterial[]

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

maxFarPlane

maxFarPlane: number

minNearPlane

minNearPlane: number

modelObject

modelObject: ICamera<E, ET>

Deprecated

use object directly

OptionalmorphTargetDictionary

morphTargetDictionary?: Record<string, number>

OptionalmorphTargetInfluences

morphTargetInfluences?: number[]

near

near: number

Automatically managed when autoNearFar is true. See also minNearPlane

OptionalobjectProcessor

objectProcessor?: IObjectProcessor

parent

parent: null | IObject3D

Object's parent in the scene graph.

Remarks

An object can have at most one parent.

Default Value

null

OptionalparentRoot

parentRoot?: null | IObject3D

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.

OptionaluiConfig

uiConfig?: UiObjectConfig

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?: Partial<ICameraEvent>,
        _internal?: boolean,
        _refresh?: boolean,
    ): void

  • Parameters

    • Optionaloptions: Partial<ICameraEvent>
    • Optional_internal: boolean
    • Optional_refresh: boolean

    Returns void

add

OptionalautoCenter

  • autoCenter(setDirty?: boolean, undo?: boolean): this

  • 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 this

    Default

    true

OptionalautoScale

  • autoScale(
        autoScaleRadius?: number,
        isCentered?: boolean,
        setDirty?: boolean,
        undo?: boolean,
    ): this

  • 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 this

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

copy

  • copy(
        source: this,
        recursive?: boolean,
        distanceFromTarget?: number,
        worldSpace?: boolean,
        ...args: any[],
    ): this

  • Copy the given object into this object

    Parameters

    • source: this
    • 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.

deactivateMain

  • deactivateMain(
        options?: Partial<ICameraEvent>,
        _internal?: boolean,
        _refresh?: boolean,
    ): void

  • Parameters

    • Optionaloptions: Partial<ICameraEvent>
    • Optional_internal: boolean
    • Optional_refresh: boolean

    Returns void

dispose

  • dispose(removeFromParent?: boolean): void

  • Parameters

    • OptionalremoveFromParent: boolean

      remove from parent. Default true

    Returns void

getObjectById

  • getObjectById<T extends IObject3D = IObject3D>(id: number): undefined | T

  • Searches through an object and its children, starting with the object itself, and returns the first with a matching id.

    Type Parameters

    Parameters

    • id: number

      Unique number of the object instance. Expects a Integer

    Returns undefined | T

    Remarks

    Note that ids are assigned in chronological order: 1, 2, 3, ..., incrementing by one for each new object.

    See

    id

getObjectByName

getObjectByProperty

  • getObjectByProperty<T extends IObject3D = IObject3D>(
        name: string,
        value: string,
    ): undefined | T

  • Searches through an object and its children, starting with the object itself, and returns the first with a property that matches the value given.

    Type Parameters

    Parameters

    • name: string

      the property name to search for.

    • value: string

      value of the given property.

    Returns undefined | T

getView

OptionalpivotToBoundsCenter

  • 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

OptionalpivotToPoint

  • 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

refreshAspect

  • refreshAspect(setDirty?: boolean): void

  • Parameters

    • OptionalsetDirty: boolean

    Returns void

refreshCameraControls

  • refreshCameraControls(setDirty?: boolean): void

  • Parameters

    • OptionalsetDirty: boolean

    Returns void

refreshTarget

refreshUi

remove

removeControlsCtor

setControlsCtor

setDirty

setInteractions

  • setInteractions(enabled: boolean, by: string): void

  • Parameters

    • enabled: boolean
    • by: string

    Returns void

setView

setViewFromCamera

  • setViewFromCamera(
        camera: Camera | ICamera,
        distanceFromTarget?: number,
        worldSpace?: boolean,
    ): void

  • Set camera view from another camera.

    Parameters

    • camera: Camera | ICamera
    • OptionaldistanceFromTarget: number

      default = 4

    • OptionalworldSpace: boolean

      default = true

    Returns void

setViewToMain

  • setViewToMain(eventOptions: Partial<ICameraEvent>): void

  • Dispatches the setView event which triggers the main camera to set its view to this camera's view.

    Parameters

    Returns void

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.

traverseAncestors

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.

OptionalupdateMorphTargets

updateProjectionMatrix

updateShaderProperties

Settings

Member Visibility

On This Page

Properties
Methods