Class PerspectiveCamera2

Hierarchy (view full)

PerspectiveCamera
- PerspectiveCamera2
  - PerspectiveCamera0

Implements

ICamera

Index

Constructors

constructor

Accessors

cameraObject canUserInteract controls interactionsEnabled isActiveCamera isMainCamera modelObject

Constructors

constructor

new PerspectiveCamera2(controlsMode?, domElement?, autoAspect?, fov?, aspect?): PerspectiveCamera2
Parameters
- Optional controlsMode: string
- Optional domElement: HTMLCanvasElement
- Optional autoAspect: boolean
- Optional fov: number
- Optional aspect: number
Returns PerspectiveCamera2
Overrides PerspectiveCamera.constructor
- Defined in src/core/camera/PerspectiveCamera2.ts:117

Properties

`Private` _camUi

_camUi: UiObjectConfig<any, string, any>[] = ...

`Private` `Optional` _canvas

_canvas?: HTMLCanvasElement

It should be the canvas actually

`Private` `Optional` _controls

_controls?: ICameraControls<string>

`Private` _controlsCtors

_controlsCtors: Map<string, TControlsCtor> = ...

`Private` _currentControlsMode

_currentControlsMode: string = ''

`Private` _interactionsDisabledBy

_interactionsDisabledBy: Set<string> = ...

`Private` _positionWorld

_positionWorld: Vector3 = ...

activateMain

activateMain: ((this, options?, _internal?, _refresh?) => void) = iCameraCommons.activateMain

Type declaration

- (this, options?, _internal?, _refresh?): void
- Parameters
  - this: ICamera<ICameraEvent, ICameraEventTypes>
  - options: Partial<ICameraEvent> = {}
  - _internal: boolean = false
  - _refresh: boolean = true
  Returns void

add

add: ((...object) => this)

Type declaration

- (...object): this
- Parameters
  - Rest ...object: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>[]
  Returns this

assetType

assetType: "camera" = ...

autoAspect

autoAspect: boolean

Automatically manage aspect ratio based on window/canvas size. Defaults to true if domElement(canvas) is set.

autoLookAtTarget

autoLookAtTarget: boolean = false

Automatically make the camera look at the target on setDirty call Defaults to false. Note that this must be set to true to make the camera look at the target without any controls

autoNearFar

autoNearFar: boolean = true

Automatically manage near and far clipping planes based on scene size.

children

children: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>[]

clone

clone: ((recursive?) => this)

Type declaration

- (recursive?): this
- Parameters
  - Optional recursive: boolean
  Returns this

controlsMode

controlsMode: string

copy

copy: ((source, recursive?, distanceFromTarget?, worldSpace?) => this)

Type declaration

- (source, recursive?, distanceFromTarget?, worldSpace?): this
- Parameters
  - source: Camera<Event, string> | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes> | ICamera<ICameraEvent, ICameraEventTypes>
  - Optional recursive: boolean
  - Optional distanceFromTarget: number
  - Optional worldSpace: boolean
  Returns this

deactivateMain

deactivateMain: ((this, options?, _internal?, _refresh?) => void) = iCameraCommons.deactivateMain

Type declaration

- (this, options?, _internal?, _refresh?): void
- Parameters
  - this: ICamera<ICameraEvent, ICameraEventTypes>
  - options: Partial<ICameraEvent> = {}
  - _internal: boolean = false
  - _refresh: boolean = true
  Returns void

dispatchEvent

dispatchEvent: ((event) => void)

Type declaration

- (event): void
- Parameters
  - event: ICameraEvent
  Returns void

far

far: number = 50

Far clipping plane. This is managed by RootScene for active cameras To change the maximum that's possible set maxFarPlane To use a fixed value set autoNearFar to false and set maxFarPlane

focus

focus: number

fov

fov: number

getObjectById

getObjectById: (<T>(id) => undefined | T)

Type declaration

- <T>(id): undefined | T
- Type Parameters
  - T extends IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes> = IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
  Parameters
  - id: number
  Returns undefined | T

getObjectByName

getObjectByName: (<T>(name) => undefined | T)

Type declaration

- <T>(name): undefined | T
- Type Parameters
  - T extends IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes> = IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
  Parameters
  - name: string
  Returns undefined | T

getObjectByProperty

getObjectByProperty: (<T>(name, value) => undefined | T)

Type declaration

- <T>(name, value): undefined | T
- Type Parameters
  - T extends IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes> = IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
  Parameters
  - name: string
  - value: string
  Returns undefined | T

maxFarPlane

maxFarPlane: number = 1000

Maximum far clipping plane allowed. (Distance from camera) Used in RootScene when autoNearFar is true.

minNearPlane

minNearPlane: number = 0.5

Minimum near clipping plane allowed. (Distance from camera) Used in RootScene when autoNearFar is true.

Default

0.2

name

name: string

near

near: number = 0.01

Near clipping plane. This is managed by RootScene for active cameras To change the minimum that's possible set minNearPlane To use a fixed value set autoNearFar to false and set minNearPlane

parent

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

`Readonly` position

position: Vector3

Local position of camera.

refreshTarget

refreshTarget: ((this, distanceFromTarget?, setDirty?) => void) = iCameraCommons.refreshTarget

Type declaration

- (this, distanceFromTarget?, setDirty?): void
- Parameters
  - this: ICamera<ICameraEvent, ICameraEventTypes>
  - distanceFromTarget: number = 4
  - setDirty: boolean = true
  Returns void

refreshUi

refreshUi: ((this) => void) = iCameraCommons.refreshUi

Type declaration

- (this): void
- Parameters
  - this: ICamera<ICameraEvent, ICameraEventTypes>
  Returns void

remove

remove: ((...object) => this)

Type declaration

- (...object): this
- Parameters
  - Rest ...object: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>[]
  Returns this

`Readonly` target

target: Vector3 = ...

The target position of the camera (where the camera looks at). Also syncs with the controls.target, so it's not required to set that separately. Note: this is always in world-space Note: autoLookAtTarget must be set to trye to make the camera look at the target when no controls are enabled

traverse

traverse: ((callback) => void)

Type declaration

- (callback): void
- Parameters
  - callback: ((object) => void)
    - (object): void
      Parameters
      object: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
      Returns void
  Returns void

traverseAncestors

traverseAncestors: ((callback) => void)

Type declaration

- (callback): void
- Parameters
  - callback: ((object) => void)
    - (object): void
      Parameters
      object: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
      Returns void
  Returns void

traverseVisible

traverseVisible: ((callback) => void)

Type declaration

- (callback): void
- Parameters
  - callback: ((object) => void)
    - (object): void
      Parameters
      object: IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
      Returns void
  Returns void

uiConfig

uiConfig: UiObjectConfig<any, string, any> = ...

userData

userData: ICameraUserData = {}

visible

visible: boolean

zoom

zoom: number

Accessors

cameraObject

get cameraObject(): this
Returns this
Deprecated
use this instead
Implementation of ICamera.cameraObject
- Defined in src/core/camera/PerspectiveCamera2.ts:506

canUserInteract

get 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

Returns boolean
Implementation of ICamera.canUserInteract
- Defined in src/core/camera/PerspectiveCamera2.ts:191

controls

get controls(): undefined | ICameraControls<string>
Returns undefined | ICameraControls<string>
Implementation of ICamera.controls
- Defined in src/core/camera/PerspectiveCamera2.ts:18

interactionsEnabled

get interactionsEnabled(): boolean
If interactions are enabled for this camera. It can be disabled by some code or plugin. see also setInteractions

Returns boolean
Deprecated
use canUserInteract to check if the user can interact with this camera
Implementation of ICamera.interactionsEnabled
- Defined in src/core/camera/PerspectiveCamera2.ts:177

isActiveCamera

get isActiveCamera(): boolean
Returns boolean
Deprecated
use isMainCamera instead
Implementation of ICamera.isActiveCamera
- Defined in src/core/camera/PerspectiveCamera2.ts:493

isMainCamera

get isMainCamera(): boolean
Returns boolean
Implementation of ICamera.isMainCamera
- Defined in src/core/camera/PerspectiveCamera2.ts:34

modelObject

get modelObject(): this
Returns this
Deprecated
use this instead
Implementation of ICamera.modelObject
- Defined in src/core/camera/PerspectiveCamera2.ts:513

Methods

`Private` _controlsChanged

_controlsChanged(): void
Returns void
- Defined in src/core/camera/PerspectiveCamera2.ts:262

`Private` _disposeCameraControls

_disposeCameraControls(): void
Returns void
- Defined in src/core/camera/PerspectiveCamera2.ts:276

`Private` _initCameraControls

_initCameraControls(): void
Returns void
- Defined in src/core/camera/PerspectiveCamera2.ts:266

`Protected` _nearFarChanged

_nearFarChanged(): void
Returns void
- Defined in src/core/camera/PerspectiveCamera2.ts:227

dispose

dispose(): void
Returns void
Implementation of ICamera.dispose
- Defined in src/core/camera/PerspectiveCamera2.ts:427

fromJSON

fromJSON(data, meta?): null | PerspectiveCamera2
Parameters
- data: any
- Optional meta: any
Returns null | PerspectiveCamera2
- Defined in src/core/camera/PerspectiveCamera2.ts:323

getControls

getControls<T>(): undefined | T
Type Parameters
- T extends ICameraControls<string>
Returns undefined | T
Deprecated
use <T>camera.controls instead
- Defined in src/core/camera/PerspectiveCamera2.ts:499

getView

getView<T>(worldSpace?, _view?): T
Type Parameters
- T extends ICameraView = CameraView
Parameters
- worldSpace: boolean = true
- Optional _view: T
Returns T
Implementation of ICamera.getView
- Defined in src/core/camera/PerspectiveCamera2.ts:358

refreshAspect

refreshAspect(setDirty?): void
when aspect ratio is set to auto it must be refreshed on resize, this is done by the viewer for the main camera.
Parameters
- setDirty: boolean = true
Returns void
Implementation of ICamera.refreshAspect
- Defined in src/core/camera/PerspectiveCamera2.ts:215

refreshCameraControls

refreshCameraControls(setDirty?): void
Parameters
- setDirty: boolean = true
Returns void
Implementation of ICamera.refreshCameraControls
- Defined in src/core/camera/PerspectiveCamera2.ts:286

removeControlsCtor

removeControlsCtor(key): void
Parameters
- key: string
Returns void
Implementation of ICamera.removeControlsCtor
- Defined in src/core/camera/PerspectiveCamera2.ts:258

setControlsCtor

setControlsCtor(key, ctor, replace?): void
Parameters
- key: string
- ctor: TControlsCtor
- replace: boolean = false
Returns void
Implementation of ICamera.setControlsCtor
- Defined in src/core/camera/PerspectiveCamera2.ts:251

setDirty

setDirty(options?): void
Dispatches 'objectUpdate' event on object.
Parameters
- Optional options: Event | IObjectSetDirtyOptions
Returns void
Implementation of ICamera.setDirty
- Defined in src/core/camera/PerspectiveCamera2.ts:199

setInteractions

setInteractions(enabled, by): void
Parameters
- enabled: boolean
- by: string
Returns void
Implementation of ICamera.setInteractions
- Defined in src/core/camera/PerspectiveCamera2.ts:181

setView

setView(view): void
Parameters
- view: ICameraView
Returns void
Implementation of ICamera.setView
- Defined in src/core/camera/PerspectiveCamera2.ts:390

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
- worldSpace: boolean = true
  default = true
Returns void
Implementation of ICamera.setViewFromCamera
- Defined in src/core/camera/PerspectiveCamera2.ts:399

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
Implementation of ICamera.setViewToMain
- Defined in src/core/camera/PerspectiveCamera2.ts:404

targetUpdated

targetUpdated(setDirty?): void
Parameters
- setDirty: boolean = true
Returns void
Deprecated
- use setDirty directly
- Defined in src/core/camera/PerspectiveCamera2.ts:521

toJSON

toJSON(meta?, baseOnly?): any
Serializes this camera with controls to JSON.
Parameters
- Optional meta: any
  metadata for serialization
- baseOnly: boolean = false
  Calls only super.toJSON, does internal three.js serialization. Set it to true only if you know what you are doing.
Returns any
Implementation of ICamera.toJSON
Overrides PerspectiveCamera.toJSON
- Defined in src/core/camera/PerspectiveCamera2.ts:317

updateShaderProperties

updateShaderProperties(material): this
See also cameraHelpers.glsl
Parameters
- material: {
      defines: Record<string, undefined | string | number>;
      uniforms: {
          [p: string]: IUniform;
      };
  }
  - defines: Record<string, undefined | string | number>
  - uniforms: {
    [p: string]: IUniform;
    }
    - [p: string]: IUniform
Returns this
Implementation of ICamera.updateShaderProperties
- Defined in src/core/camera/PerspectiveCamera2.ts:418

Class PerspectiveCamera2

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional controlsMode: string

Optional domElement: HTMLCanvasElement

Optional autoAspect: boolean

Optional fov: number

Optional aspect: number

Returns PerspectiveCamera2

Properties

Private _camUi

Private Optional _canvas

Private Optional _controls

Private _controlsCtors

Private _currentControlsMode

Private _interactionsDisabledBy

Private _positionWorld

activateMain

Type declaration

Parameters

this: ICamera<ICameraEvent, ICameraEventTypes>

options: Partial<ICameraEvent> = {}

_internal: boolean = false

_refresh: boolean = true

Returns void

add

Type declaration

Parameters

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

Returns this

assetType

autoAspect

autoLookAtTarget

autoNearFar

children

clone

Type declaration

Parameters

Optional recursive: boolean

Returns this

controlsMode

copy

Type declaration

Parameters

source: Camera<Event, string> | IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes> | ICamera<ICameraEvent, ICameraEventTypes>

Optional recursive: boolean

Optional distanceFromTarget: number

Optional worldSpace: boolean

Returns this

deactivateMain

Type declaration

Parameters

this: ICamera<ICameraEvent, ICameraEventTypes>

options: Partial<ICameraEvent> = {}

_internal: boolean = false

_refresh: boolean = true

Returns void

dispatchEvent

Type declaration

Parameters

event: ICameraEvent

Returns void

far

focus

fov

getObjectById

Type declaration

Type Parameters

T extends IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes> = IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

Parameters

id: number

Returns undefined | T

`Optional` controlsMode: string

`Optional` domElement: HTMLCanvasElement

`Optional` autoAspect: boolean

`Optional` fov: number

`Optional` aspect: number

`Private` _camUi

`Private` `Optional` _canvas

`Private` `Optional` _controls

`Private` _controlsCtors

`Private` _currentControlsMode

`Private` _interactionsDisabledBy

`Private` _positionWorld

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

`Optional` recursive: boolean

`Optional` recursive: boolean

`Optional` distanceFromTarget: number

`Optional` worldSpace: boolean

`Readonly` position

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

`Readonly` target