Class Camera

Hierarchy

Component
- Camera

Index

Constructors

constructor

Accessors

Constructors

constructor

new Camera(props?: ObjectProps<Camera>): Camera

- Defined in src/graphics/camera/Camera.ts:110
Parameters
- Optional props: ObjectProps<Camera>
Returns Camera

Accessors

active

get active(): boolean
set active(active: boolean): void

Inherited from Component.active
- Defined in src/core/Component.ts:12
Returns boolean
Inherited from Component.active
- Defined in src/core/Component.ts:13
Parameters
- active: boolean
Returns void

clearValue

get clearValue(): CameraClear

- Defined in src/graphics/camera/Camera.ts:53
Returns CameraClear

entity

get entity(): Entity

Inherited from Component.entity
- Defined in src/core/Component.ts:10
Returns Entity

filter

set filter(filter: VisualFilter): void

- Defined in src/graphics/camera/Camera.ts:85
Parameters
- filter: VisualFilter
Returns void

frustum

get frustum(): IFrustum

- Defined in src/graphics/camera/Camera.ts:73
Returns IFrustum

id

get id(): string

Inherited from Component.id
- Defined in src/core/Component.ts:11
Returns string

parent

get parent(): undefined | Entity

Inherited from Component.parent
- Defined in src/core/Component.ts:9
Returns undefined | Entity

postEffects

get postEffects(): undefined | PostEffects

- Defined in src/graphics/camera/Camera.ts:54
Returns undefined | PostEffects

priority

get priority(): number

- Defined in src/graphics/camera/Camera.ts:56
Returns number

projector

get projector(): Projector
set projector(projector: Projector): void

- Defined in src/graphics/camera/Camera.ts:52
Returns Projector
- Defined in src/graphics/camera/Camera.ts:41
Parameters
- projector: Projector
Returns void

renderTarget

get renderTarget(): null | RenderTarget
set renderTarget(renderTarget: RenderTarget | null): void

- Defined in src/graphics/camera/Camera.ts:55
Returns null | RenderTarget
- Defined in src/graphics/camera/Camera.ts:81
Parameters
- renderTarget: RenderTarget | null
Returns void

sceneRenderTarget

get sceneRenderTarget(): RenderTarget

- Defined in src/graphics/camera/Camera.ts:58
Returns RenderTarget

version

get version(): number

- Defined in src/graphics/camera/Camera.ts:39
Returns number

Methods

canRenderGroup

canRenderGroup(group: VisualGroup | null): boolean

- Defined in src/graphics/camera/Camera.ts:160
Parameters
- group: VisualGroup | null
Returns boolean

copy

copy(): SerializableObject

Inherited from SerializableObject.copy
- Defined in src/core/SerializableObject.ts:27
Returns SerializableObject

deserialize

deserialize(json: SerializedObjectType): Promise<SerializableObject> | SerializableObject

Inherited from SerializableObject.deserialize
- Defined in src/core/SerializableObject.ts:45
Parameters
- json: SerializedObjectType
Returns Promise<SerializableObject> | SerializableObject

destroy

destroy(): void

Overrides SerializableObject.destroy
- Defined in src/graphics/camera/Camera.ts:139
Returns void

getProjectionMatrix

getProjectionMatrix(): Matrix44

- Defined in src/graphics/camera/Camera.ts:164
Returns Matrix44

getScreenPosition

getScreenPosition(worldPosition: Vector3, screenPositionOut: Vector3): boolean

- Defined in src/graphics/camera/Camera.ts:238
Parameters
- worldPosition: Vector3
- screenPositionOut: Vector3
Returns boolean

getViewMatrix

getViewMatrix(): Matrix44

- Defined in src/graphics/camera/Camera.ts:175
Returns Matrix44

getViewPosition

getViewPosition(worldPosition: Vector3, viewPositionOut: Vector3): boolean

- Defined in src/graphics/camera/Camera.ts:227
Parameters
- worldPosition: Vector3
- viewPositionOut: Vector3
Returns boolean

getWorldRay

getWorldRay(screenX: number, screenY: number): null | Ray

- Defined in src/graphics/camera/Camera.ts:184
Parameters
- screenX: number
- screenY: number
Returns null | Ray

invalidateFrustum

invalidateFrustum(): void

- Defined in src/graphics/camera/Camera.ts:318
Returns void

isA

isA<T>(type: object): boolean

Inherited from SerializableObject.isA
- Defined in src/core/SerializableObject.ts:23
Type parameters
- T
Parameters
- type: object
  - constructor: function
    - new __type(...args: any[]): T
    - Defined in src/core/SerializableObject.ts:23
      Parameters
      - Rest ...args: any[]
      Returns T
Returns boolean

isLoaded

isLoaded(): boolean

Inherited from Component.isLoaded
- Defined in src/core/Component.ts:36
Returns boolean

onReplace

onReplace(previous: Component): void

Inherited from Component.onReplace
- Defined in src/core/Component.ts:46
Parameters
- previous: Component
Returns void

reset

reset(): void

Inherited from Component.reset
- Defined in src/core/Component.ts:40
Returns void

serialize

serialize(): SerializedObjectType

Inherited from SerializableObject.serialize
- Defined in src/core/SerializableObject.ts:41
Returns SerializedObjectType

setEntity

setEntity(entity: Entity): void

Overrides Component.setEntity
- Defined in src/graphics/camera/Camera.ts:127
Parameters
- entity: Entity
Returns void

setProperty

setProperty(property: string, value: any): void

Overrides SerializableObject.setProperty
- Defined in src/graphics/camera/Camera.ts:254
Parameters
- property: string
- value: any
Returns void

setState

setState<T>(props: ObjectProps<T>): void

Inherited from SerializableObject.setState
- Defined in src/core/SerializableObject.ts:54
Type parameters
- T
Parameters
- props: ObjectProps<T>
Returns void

setupFrame

setupFrame(): void

- Defined in src/graphics/camera/Camera.ts:249
Returns void

upgrade

upgrade(json: SerializedObject, previousVersion: number): SerializedObject

Overrides SerializableObject.upgrade
- Defined in src/graphics/camera/Camera.ts:262
Parameters
- json: SerializedObject
- previousVersion: number
Returns SerializedObject