Class PerspectiveCamera2

Hierarchy

PerspectiveCamera
- PerspectiveCamera2

Implements

ICamera

Index

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:104

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` _interactionsEnabled

_interactionsEnabled: boolean = true

`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) => PerspectiveCamera2)

Type declaration

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

assetType

assetType: "camera" = ...

autoAspect

autoAspect: boolean

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

autoNearFar

autoNearFar: boolean = true

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

children

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

clone

clone: ((recursive?) => PerspectiveCamera2)

Type declaration

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

controlsMode

controlsMode: string

copy

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

Type declaration

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

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, T> = 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, T> = 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, T> = IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>
  Parameters
  - name: string
  - value: string
  Returns undefined | T

maxFarPlane

maxFarPlane: number = 1000

Maximum far clipping plane allowed. (Distance from camera)

minNearPlane

minNearPlane: number = 0.5

Minimum near clipping plane allowed. (Distance from camera)

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) => PerspectiveCamera2)

Type declaration

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

`Readonly` target

target: Vector3 = ...

Target of camera, in world(global) coordinates.

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
Deprecated
use this instead

Returns this
Implementation of ICamera.cameraObject
- Defined in src/core/camera/PerspectiveCamera2.ts:463

canUserInteract

get canUserInteract(): boolean
Check whether user can interact with this camera. Interactions can be enabled/disabled in a variety of ways, like interactionsEnabled, controlsMode, isMainCamera property

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

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
Returns boolean
Implementation of ICamera.interactionsEnabled
- Defined in src/core/camera/PerspectiveCamera2.ts:148
set interactionsEnabled(value): void
Parameters
- value: boolean
Returns void
Implementation of ICamera.interactionsEnabled
- Defined in src/core/camera/PerspectiveCamera2.ts:152

isActiveCamera

get isActiveCamera(): boolean
Deprecated
use isMainCamera instead

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

isMainCamera

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

modelObject

get modelObject(): this
Deprecated
use this instead

Returns this
Implementation of ICamera.modelObject
- Defined in src/core/camera/PerspectiveCamera2.ts:470

Methods

`Private` _controlsChanged

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

`Private` _disposeCameraControls

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

`Private` _initCameraControls

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

`Protected` _nearFarChanged

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

dispose

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

fromJSON

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

getControls

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

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:322

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:179

refreshCameraControls

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

removeControlsCtor

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

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:215

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:163

setView

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

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:361

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:366

targetUpdated

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

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:281

updateShaderProperties

updateShaderProperties(material): PerspectiveCamera2
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 PerspectiveCamera2
Implementation of ICamera.updateShaderProperties
- Defined in src/core/camera/PerspectiveCamera2.ts:375

Class PerspectiveCamera2

Hierarchy

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 _interactionsEnabled

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 PerspectiveCamera2

assetType

autoAspect

autoNearFar

children

clone

Type declaration

Parameters

Optional recursive: boolean

Returns PerspectiveCamera2

controlsMode

copy

Type declaration

Parameters

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

Optional recursive: boolean

Optional distanceFromTarget: number

Optional worldSpace: boolean

Returns PerspectiveCamera2

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, T> = IObject3D<IObject3DEvent<IObject3DEventTypes>, IObject3DEventTypes>

Parameters

id: number

Returns undefined | T

getObjectByName

`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` _interactionsEnabled

`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