Class: Camera3D ​

Camera components

Hierarchy ​

• ComponentBase

  ↳ Camera3D

Constructors ​

• constructor

Properties ​

• object3D
• isDestroyed
• fov
• name
• aspect
• near
• far
• viewPort
• frustum
• isShadowCamera
• lookTarget
• type
• csm

Accessors ​

• eventDispatcher
• isStart
• transform
• enable
• enableCSM
• viewMatrix
• shadowViewMatrix
• pvMatrix
• pvMatrix2
• pvMatrixInv
• projectionMatrixInv
• jitterFrameIndex
• jitterX
• jitterY

Methods ​

• start
• stop
• onEnable
• onDisable
• onLateUpdate
• onBeforeUpdate
• onCompute
• onGraphic
• onParentChange
• cloneTo
• copyComponent
• beforeDestroy
• destroy
• init
• getShadowBias
• getShadowWorldExtents
• getCSMShadowBias
• getCSMShadowWorldExtents
• perspective
• resetPerspective
• ortho
• orthoOffCenter
• orthoZo
• object3DToScreenRay
• screenRayToObject3D
• unProject
• screenPointToRay
• screenPointToWorld
• worldToScreenPoint
• lookAt
• enableJitterProjection
• getWorldDirection

Constructors ​

constructor ​

• new Camera3D()

Overrides ​

ComponentBase.constructor

Defined in ​

src/core/Camera3D.ts:111

Properties ​

object3D ​

• object3D: Object3D = null

owner object3D

Inherited from ​

ComponentBase.object3D

Defined in ​

src/components/ComponentBase.ts:17

isDestroyed ​

• Optional isDestroyed: boolean

Inherited from ​

ComponentBase.isDestroyed

Defined in ​

src/components/ComponentBase.ts:38

fov ​

• fov: number = 1

camera Perspective

Defined in ​

src/core/Camera3D.ts:26

name ​

• name: string

camera use name

Defined in ​

src/core/Camera3D.ts:31

aspect ​

• aspect: number = 1

Viewport width and height Scale

Defined in ​

src/core/Camera3D.ts:36

near ​

• near: number = 1

camera near plane

Defined in ​

src/core/Camera3D.ts:41

far ​

• far: number = 5000

camera far plane

Defined in ​

src/core/Camera3D.ts:46

viewPort ​

• viewPort: Rect

camera view port size

Defined in ​

src/core/Camera3D.ts:51

frustum ​

• frustum: Frustum

camera frustum

Defined in ​

src/core/Camera3D.ts:56

isShadowCamera ​

• isShadowCamera: boolean = false

this camera is shadow camera

Defined in ​

src/core/Camera3D.ts:61

lookTarget ​

• lookTarget: Vector3

camera look at from where point

Defined in ​

src/core/Camera3D.ts:88

type ​

• type: CameraType = CameraType.perspective

camera type

Defined in ​

src/core/Camera3D.ts:93

csm ​

• csm: FrustumCSM

Defined in ​

src/core/Camera3D.ts:95

Accessors ​

eventDispatcher ​

• get eventDispatcher(): CEventDispatcher

Returns ​

CEventDispatcher

Inherited from ​

ComponentBase.eventDispatcher

Defined in ​

src/components/ComponentBase.ts:23

• set eventDispatcher(value): void

Parameters ​

Returns ​

void

Inherited from ​

ComponentBase.eventDispatcher

Defined in ​

src/components/ComponentBase.ts:28

isStart ​

• get isStart(): boolean

Returns ​

boolean

Inherited from ​

ComponentBase.isStart

Defined in ​

src/components/ComponentBase.ts:40

transform ​

• get transform(): Transform

Return the Transform component attached to the Object3D.

Returns ​

Transform

Inherited from ​

ComponentBase.transform

Defined in ​

src/components/ComponentBase.ts:47

enable ​

• get enable(): boolean

Enable/disable components. The enabled components can be updated, while the disabled components cannot be updated.

Returns ​

boolean

Inherited from ​

ComponentBase.enable

Defined in ​

src/components/ComponentBase.ts:68

• set enable(value): void

Enable/disable components. The enabled components can be updated, while the disabled components cannot be updated.

Parameters ​

Returns ​

void

Inherited from ​

ComponentBase.enable

Defined in ​

src/components/ComponentBase.ts:54

enableCSM ​

• get enableCSM(): boolean

Returns ​

boolean

Defined in ​

src/core/Camera3D.ts:102

• set enableCSM(value): void

Parameters ​

Returns ​

void

Defined in ​

src/core/Camera3D.ts:105

viewMatrix ​

• get viewMatrix(): Matrix4

view invert matrix

Returns ​

Matrix4

Defined in ​

src/core/Camera3D.ts:217

shadowViewMatrix ​

• get shadowViewMatrix(): Matrix4

shadow camera view invert matrix

Returns ​

Matrix4

Defined in ​

src/core/Camera3D.ts:227

pvMatrix ​

• get pvMatrix(): Matrix4

get project * view matrix

Returns ​

Matrix4

Defined in ​

src/core/Camera3D.ts:278

pvMatrix2 ​

• get pvMatrix2(): Matrix4

Returns ​

Matrix4

Defined in ​

src/core/Camera3D.ts:283

pvMatrixInv ​

• get pvMatrixInv(): Matrix4

get (project * view) invert matrix

Returns ​

Matrix4

Defined in ​

src/core/Camera3D.ts:293

projectionMatrixInv ​

• get projectionMatrixInv(): Matrix4

get project invert matrix

Returns ​

Matrix4

Defined in ​

src/core/Camera3D.ts:302

jitterFrameIndex ​

• get jitterFrameIndex(): number

Returns ​

number

Defined in ​

src/core/Camera3D.ts:436

jitterX ​

• get jitterX(): number

Returns ​

number

Defined in ​

src/core/Camera3D.ts:440

jitterY ​

• get jitterY(): number

Returns ​

number

Defined in ​

src/core/Camera3D.ts:444

Methods ​

start ​

▸ start(): void

Returns ​

void

Inherited from ​

ComponentBase.start

Defined in ​

src/components/ComponentBase.ts:113

stop ​

▸ stop(): void

Returns ​

void

Inherited from ​

ComponentBase.stop

Defined in ​

src/components/ComponentBase.ts:114

onEnable ​

▸ Optional onEnable(view?): any

Parameters ​

Returns ​

any

Inherited from ​

ComponentBase.onEnable

Defined in ​

src/components/ComponentBase.ts:115

onDisable ​

▸ Optional onDisable(view?): any

Parameters ​

Returns ​

any

Inherited from ​

ComponentBase.onDisable

Defined in ​

src/components/ComponentBase.ts:116

onLateUpdate ​

▸ Optional onLateUpdate(view?): any

Parameters ​

Returns ​

any

Inherited from ​

ComponentBase.onLateUpdate

Defined in ​

src/components/ComponentBase.ts:118

onBeforeUpdate ​

▸ Optional onBeforeUpdate(view?): any

Parameters ​

Returns ​

any

Inherited from ​

ComponentBase.onBeforeUpdate

Defined in ​

src/components/ComponentBase.ts:119

onCompute ​

▸ Optional onCompute(view?, command?): any

Parameters ​

Returns ​

any

Inherited from ​

ComponentBase.onCompute

Defined in ​

src/components/ComponentBase.ts:120

onGraphic ​

▸ Optional onGraphic(view?): any

Parameters ​

Returns ​

any

Inherited from ​

ComponentBase.onGraphic

Defined in ​

src/components/ComponentBase.ts:121

onParentChange ​

▸ Optional onParentChange(lastParent?, currentParent?): any

Parameters ​

Returns ​

any

Inherited from ​

ComponentBase.onParentChange

Defined in ​

src/components/ComponentBase.ts:122

cloneTo ​

▸ cloneTo(obj): void

clone component data to target object3D

Parameters ​

Returns ​

void

Inherited from ​

ComponentBase.cloneTo

Defined in ​

src/components/ComponentBase.ts:129

copyComponent ​

▸ copyComponent(from): Camera3D

Parameters ​

Returns ​

Camera3D

Inherited from ​

ComponentBase.copyComponent

Defined in ​

src/components/ComponentBase.ts:131

beforeDestroy ​

▸ beforeDestroy(force?): void

before release this component, object refrences are not be set null now.

Parameters ​

Returns ​

void

Inherited from ​

ComponentBase.beforeDestroy

Defined in ​

src/components/ComponentBase.ts:198

destroy ​

▸ destroy(force?): void

release this component

Parameters ​

Returns ​

void

Inherited from ​

ComponentBase.destroy

Defined in ​

src/components/ComponentBase.ts:205

init ​

▸ init(): void

Returns ​

void

Overrides ​

ComponentBase.init

Defined in ​

src/core/Camera3D.ts:115

getShadowBias ​

▸ getShadowBias(depthTexSize): number

Parameters ​

Returns ​

number

Defined in ​

src/core/Camera3D.ts:127

getShadowWorldExtents ​

▸ getShadowWorldExtents(): number

Returns ​

number

Defined in ​

src/core/Camera3D.ts:133

getCSMShadowBias ​

▸ getCSMShadowBias(index, depthTexSize): number

Parameters ​

Returns ​

number

Defined in ​

src/core/Camera3D.ts:143

getCSMShadowWorldExtents ​

▸ getCSMShadowWorldExtents(index): number

Parameters ​

Returns ​

number

Defined in ​

src/core/Camera3D.ts:149

perspective ​

▸ perspective(fov, aspect, near, far): void

Create a perspective camera

Parameters ​

Returns ​

void

Defined in ​

src/core/Camera3D.ts:160

resetPerspective ​

▸ resetPerspective(aspect): void

Parameters ​

Returns ​

void

Defined in ​

src/core/Camera3D.ts:169

ortho ​

▸ ortho(width, height, znear, zfar): void

Create an orthographic camera

Parameters ​

Returns ​

void

Defined in ​

src/core/Camera3D.ts:182

orthoOffCenter ​

▸ orthoOffCenter(l, r, b, t, zn, zf): void

Create an orthographic camera

Parameters ​

Returns ​

void

Defined in ​

src/core/Camera3D.ts:199

orthoZo ​

▸ orthoZo(l, r, b, t, zn, zf): void

Parameters ​

Returns ​

void

Defined in ​

src/core/Camera3D.ts:206

object3DToScreenRay ​

▸ object3DToScreenRay(n, target?): Vector3

world space object to screen

Parameters ​

Returns ​

Vector3

Defined in ​

src/core/Camera3D.ts:239

screenRayToObject3D ​

▸ screenRayToObject3D(n, target?): Vector3

Convert 2D screen coordinates to 3D coordinates as world space

Parameters ​

Returns ​

Vector3

Defined in ​

src/core/Camera3D.ts:259

unProject ​

▸ unProject(nX, nY, sZ, target?): Vector3

Enter a 3D coordinate point to obtain the projected coordinate point

Parameters ​

Returns ​

Vector3

Coordinates after projection

Defined in ​

src/core/Camera3D.ts:316

screenPointToRay ​

▸ screenPointToRay(viewPortPosX, viewPortPosY): Ray

Enter the 2D coordinates of the screen to obtain a ray that starts from the camera position and passes through the corresponding 3D position of the screen.

Parameters ​

Returns ​

Ray

ray

Defined in ​

src/core/Camera3D.ts:355

screenPointToWorld ​

▸ screenPointToWorld(viewPortPosX, viewPortPosY, z): Vector3

Convert screen coordinates to world coordinates

Parameters ​

Returns ​

Vector3

World coordinates

Defined in ​

src/core/Camera3D.ts:376

worldToScreenPoint ​

▸ worldToScreenPoint(point, target?): Vector3

Convert world coordinates to screen coordinates

Parameters ​

Returns ​

Vector3

World coordinates

Defined in ​

src/core/Camera3D.ts:388

lookAt ​

▸ lookAt(pos, target, up?): void

Current object's gaze position (global) (modified by its own global transformation)

Parameters ​

Returns ​

void

Defined in ​

src/core/Camera3D.ts:399

enableJitterProjection ​

▸ enableJitterProjection(value): void

Parameters ​

Returns ​

void

Defined in ​

src/core/Camera3D.ts:448

getWorldDirection ​

▸ getWorldDirection(target?): Vector3

Parameters ​

Returns ​

Vector3

Defined in ​

src/core/Camera3D.ts:553