Interface ICamera<E, ET>

interface ICamera<E, ET> {
    _currentGeometry?: null | IGeometry<NormalBufferAttributes>;
    _currentMaterial?: null | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes> | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>[];
    _onGeometryUpdate?: ((e) => void);
    aspect: number;
    assetType: "camera";
    autoAspect: boolean;
    autoNearFar: boolean;
    cameraObject: ICamera<E, ET>;
    canUserInteract: boolean;
    children: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>[];
    controls: undefined | ICameraControls<string>;
    controlsMode?: string;
    far: number;
    fov?: number;
    geometry?: IGeometry<NormalBufferAttributes>;
    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<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes> | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>[];
    materials?: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>[];
    maxFarPlane: number;
    minNearPlane: number;
    modelObject: ICamera<E, ET>;
    morphTargetDictionary?: Record<string, number>;
    morphTargetInfluences?: number[];
    near: number;
    objectProcessor?: IObjectProcessor;
    parent: null | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>;
    parentRoot?: null | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>;
    position: Vector3;
    target: Vector3;
    uiConfig?: UiObjectConfig<any, string, any>;
    userData: ICameraUserData;
    zoom: number;
    activateMain(options?, _internal?, _refresh?): void;
    add(...object): this;
    autoCenter?(setDirty?): this;
    autoScale?(autoScaleRadius?, isCentered?, setDirty?): this;
    clone(recursive?): this;
    copy(source, recursive?, distanceFromTarget?, worldSpace?, ...args): this;
    deactivateMain(options?, _internal?, _refresh?): void;
    dispose(removeFromParent?): void;
    getObjectById<T>(id): undefined | T;
    getObjectByName<T>(name): undefined | T;
    getObjectByProperty<T>(name, value): undefined | T;
    getView<T>(worldSpace?, cameraView?): T;
    refreshAspect(setDirty?): void;
    refreshCameraControls(setDirty?): void;
    refreshTarget(): void;
    refreshUi(): void;
    remove(...object): this;
    removeControlsCtor(key): void;
    setControlsCtor(key, ctor, replace?): void;
    setDirty(options?): void;
    setInteractions(enabled, by): void;
    setView(view): void;
    setViewFromCamera(camera, distanceFromTarget?, worldSpace?): void;
    setViewToMain(eventOptions): void;
    traverse(callback): void;
    traverseAncestors(callback): void;
    traverseVisible(callback): void;
    updateMorphTargets?(): void;
    updateProjectionMatrix(): void;
    updateShaderProperties(material): this;
}

Type Parameters

E extends ICameraEvent = ICameraEvent
ET extends ICameraEventTypes = ICameraEventTypes

Hierarchy (view full)

Implemented by

PerspectiveCamera2

Index

Properties

`Optional` _currentGeometry

_currentGeometry?: null | IGeometry<NormalBufferAttributes>

`Optional` _currentMaterial

_currentMaterial?: null | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes> | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>[]

`Optional` _onGeometryUpdate

_onGeometryUpdate?: ((e) => void)

Type declaration

- (e): void
- Parameters
  - e: IGeometryEvent<"geometryUpdate">
  Returns void

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

cameraObject

cameraObject: ICamera<E, ET>

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<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>[]

`Readonly` controls

controls: undefined | ICameraControls<string>

`Optional` controlsMode

controlsMode?: string

far

far: number

Automatically managed when autoNearFar is true. See also maxFarPlane

`Optional` fov

fov?: number

`Optional` geometry

geometry?: IGeometry<NormalBufferAttributes>

`Readonly` interactionsEnabled

interactionsEnabled: boolean

isActiveCamera

isActiveCamera: boolean

Deprecated

use isMainCamera instead

`Readonly` isCamera

isCamera: true

`Optional` isLight

isLight?: boolean

`Optional` isLine

isLine?: boolean

`Optional` isLineSegments

isLineSegments?: boolean

`Readonly` isMainCamera

isMainCamera: boolean

`Optional` isMesh

isMesh?: boolean

`Optional` `Readonly` isOrthographicCamera

isOrthographicCamera?: boolean

`Optional` `Readonly` isPerspectiveCamera

isPerspectiveCamera?: boolean

`Optional` isScene

isScene?: boolean

`Optional` isWidget

isWidget?: boolean

`Optional` material

material?: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes> | IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>[]

`Optional` `Readonly` materials

materials?: IMaterial<IMaterialEvent<IMaterialEventTypes>, IMaterialEventTypes>[]

Same as material but always returns an array.

maxFarPlane

maxFarPlane: number

minNearPlane

minNearPlane: number

modelObject

modelObject: ICamera<E, ET>

Deprecated

use object directly

`Optional` morphTargetDictionary

morphTargetDictionary?: Record<string, number>

`Optional` morphTargetInfluences

morphTargetInfluences?: number[]

near

near: number

Automatically managed when autoNearFar is true. See also minNearPlane

`Optional` objectProcessor

objectProcessor?: IObjectProcessor

parent

parent: null | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

`Optional` parentRoot

parentRoot?: null | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

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

zoom

zoom: number

Methods

activateMain

activateMain(options?, _internal?, _refresh?): void
Parameters
- Optional options: Partial<ICameraEvent>
- Optional _internal: boolean
- Optional _refresh: boolean
Returns void
- Defined in src/core/ICamera.ts:59

add

add(...object): this
Parameters
- Rest ...object: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>[]
Returns this
Overrides IObject3D.add
- Defined in src/core/ICamera.ts:163

`Optional` autoCenter

autoCenter(setDirty?): this
Parameters
- Optional setDirty: boolean
  calls setDirty
Returns this
Default
```
true
```
Inherited from IObject3D.autoCenter
- Defined in src/core/IObject.ts:216

`Optional` autoScale

autoScale(autoScaleRadius?, isCentered?, setDirty?): this
Parameters
- Optional autoScaleRadius: number
  optional (taken from userData.autoScaleRadius by default)
- Optional isCentered: boolean
  optional (taken from userData.isCentered by default)
- Optional setDirty: boolean
  true by default
Returns this
Inherited from IObject3D.autoScale
- Defined in src/core/IObject.ts:210

clone

clone(recursive?): this
Parameters
- Optional recursive: boolean
Returns this
Overrides IObject3D.clone
- Defined in src/core/ICamera.ts:162

copy

copy(source, recursive?, distanceFromTarget?, worldSpace?, ...args): this
Parameters
- source: this
- Optional recursive: boolean
- Optional distanceFromTarget: number
- Optional worldSpace: boolean
- Rest ...args: any[]
Returns this
Overrides IObject3D.copy
- Defined in src/core/ICamera.ts:161

deactivateMain

deactivateMain(options?, _internal?, _refresh?): void
Parameters
- Optional options: Partial<ICameraEvent>
- Optional _internal: boolean
- Optional _refresh: boolean
Returns void
- Defined in src/core/ICamera.ts:60

dispose

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

getView

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

refreshAspect

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

refreshCameraControls

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

refreshTarget

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

refreshUi

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

remove

remove(...object): this
Parameters
- Rest ...object: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>[]
Returns this
Overrides IObject3D.remove
- Defined in src/core/ICamera.ts:164

removeControlsCtor

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

setControlsCtor

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

setDirty

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

setInteractions

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

setView

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

setViewFromCamera

setViewFromCamera(camera, distanceFromTarget?, worldSpace?): void
Set camera view from another camera.
Parameters
- camera: Camera<Event, string> | ICamera<ICameraEvent, ICameraEventTypes>
- Optional distanceFromTarget: number
  default = 4
- Optional worldSpace: boolean
  default = true
Returns void
- Defined in src/core/ICamera.ts:145

setViewToMain

setViewToMain(eventOptions): void
Dispatches the setView event which triggers the main camera to set its view to this camera's view.
Parameters
- eventOptions: Partial<ICameraEvent>
Returns void
- Defined in src/core/ICamera.ts:151

traverse

traverse(callback): void
Parameters
- callback: ((object) => void)
  - - (object): void
    - Parameters
      object: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
      Returns void
Returns void
Overrides IObject3D.traverse
- Defined in src/core/ICamera.ts:155

traverseAncestors

traverseAncestors(callback): void
Parameters
- callback: ((object) => void)
  - - (object): void
    - Parameters
      object: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
      Returns void
Returns void
Overrides IObject3D.traverseAncestors
- Defined in src/core/ICamera.ts:157

traverseVisible

traverseVisible(callback): void
Parameters
- callback: ((object) => void)
  - - (object): void
    - Parameters
      object: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
      Returns void
Returns void
Overrides IObject3D.traverseVisible
- Defined in src/core/ICamera.ts:156

`Optional` updateMorphTargets

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

updateProjectionMatrix

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

updateShaderProperties

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

Interface ICamera<E, ET>

Type Parameters

E extends ICameraEvent = ICameraEvent

ET extends ICameraEventTypes = ICameraEventTypes

Hierarchy (view full)

Implemented by

Index

Properties

Methods

Properties

Optional _currentGeometry

Optional _currentMaterial

Optional _onGeometryUpdate

Type declaration

Parameters

e: IGeometryEvent<"geometryUpdate">

Returns void

aspect

Default

assetType

autoAspect

autoNearFar

cameraObject

Deprecated

Readonly canUserInteract

children

Readonly controls

Optional controlsMode

far

Optional fov

Optional geometry

Readonly interactionsEnabled

isActiveCamera

Deprecated

Readonly isCamera

Optional isLight

Optional isLine

Optional isLineSegments

Readonly isMainCamera

Optional isMesh

Optional Readonly isOrthographicCamera

Optional Readonly isPerspectiveCamera

Optional isScene

Optional isWidget

Optional material

Optional Readonly materials

maxFarPlane

minNearPlane

modelObject

Deprecated

Optional morphTargetDictionary

Optional morphTargetInfluences

near

Optional objectProcessor

parent

Optional parentRoot

position

target

Optional uiConfig

userData

zoom

Methods

activateMain

Parameters

Optional options: Partial<ICameraEvent>

Optional _internal: boolean

Optional _refresh: boolean

Returns void

add

Parameters

Rest ...object: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>[]

Returns this

Optional autoCenter

Parameters

Optional setDirty: boolean

Returns this

Default

Optional autoScale

Parameters

Optional autoScaleRadius: number

`Optional` _currentGeometry

`Optional` _currentMaterial

`Optional` _onGeometryUpdate

`Readonly` canUserInteract

`Readonly` controls

`Optional` controlsMode

`Optional` fov

`Optional` geometry

`Readonly` interactionsEnabled

`Readonly` isCamera

`Optional` isLight

`Optional` isLine

`Optional` isLineSegments

`Readonly` isMainCamera

`Optional` isMesh

`Optional` `Readonly` isOrthographicCamera

`Optional` `Readonly` isPerspectiveCamera

`Optional` isScene

`Optional` isWidget

`Optional` material

`Optional` `Readonly` materials

`Optional` morphTargetDictionary

`Optional` morphTargetInfluences

`Optional` objectProcessor

`Optional` parentRoot

`Optional` uiConfig

`Optional` options: Partial<ICameraEvent>

`Optional` _internal: boolean

`Optional` _refresh: boolean

`Rest` ...object: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>[]

`Optional` autoCenter

`Optional` setDirty: boolean

`Optional` autoScale

`Optional` autoScaleRadius: number

`Optional` isCentered: boolean

`Optional` setDirty: boolean

`Optional` recursive: boolean

`Optional` recursive: boolean

`Optional` distanceFromTarget: number

`Optional` worldSpace: boolean

`Rest` ...args: any[]

`Optional` options: Partial<ICameraEvent>

`Optional` _internal: boolean

`Optional` _refresh: boolean

`Optional` removeFromParent: boolean

`Optional` worldSpace: boolean

`Optional` cameraView: T

`Optional` setDirty: boolean

`Optional` setDirty: boolean

`Rest` ...object: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>[]