Home Reference Source 
import Camera from 'oxygen-core/components/Camera.js'
public class | source

Camera

Extends:

Component → Camera

Direct Subclass:

Camera2D

Camera base class component.

Static Member Summary

Static Public Members
public static get

Static Method Summary

Static Public Methods
public static

Component factory.

Constructor Summary

Public Constructor
public

Constructor.

Member Summary

Public Members
public get
public set
public get
public set
public get
public set
public get
public get
public get
public get
public set
public get
public get
public set
public get
public set
public get
public set
public get
public set
public get
public set
public get
public set
public get

viewMatrix: mat4

public get

Method Summary

Public Methods
public abstract

buildCameraMatrix(target: mat4, width: number, height: number)

Building camera matrix.
public

convertUnitPointToGlobalPoint(target: vec2, unitVec: vec2)

Convert screen space unit ([-1; 1]) vec2 point to global vec2 point.
public
public

onAction(name: *, args: ...*): *

public
public
public

onResize(width: number, height: number)

Called on view resize.
public

onView(gl: WebGLRenderingContext, renderer: RenderSystem, deltaTime: number): boolean

Called when camera need to view rendered scene.
public

registerPostprocess(postprocess: PostprocessPass, floatPointData: boolean)

Register postprocess.
public

Unregister postprocess.

Inherited Summary

From class Component
public static get
public static

Component factory.
public get
public

[name]: *

public

deserialize(json: *)

Deserialize JSON properties into this component.
public

Destructor (dispose internal resources and detach from entity).
public

onAction(name: string, args: *)

Called when action arrived.
public

onAlterActionArguments(name: string, args: *): array | undefined

Called when asked to alter arrived action parameters.
public

Called after attached to entity.
public

Called before detached from entity.
public

onPropertySerialize(name: string, value: *): *

Called when property is serialized.
public

onPropertySetup(name: string, value: *)

Called when given property is deserialized.
public

serialize(): *

Serialize component into JSON data.

Static Public Members

public static get propsTypes: * source

Override:

Component#propsTypes

Static Public Methods

public static factory(): Camera source

Component factory.

Override:

Component#factory

Return:

Camera

Component instance.

Public Constructors

public constructor() source

Constructor.

Override:

Component#constructor

Public Members

public get captureEntity: string | null source

public set captureEntity: string | null source

public get command: Command | null source

public set command: Command | null source

public get ignoreChildrenViews: boolean source

public set ignoreChildrenViews: boolean source

public get inverseProjectionMatrix: mat4 source

public get inverseViewMatrix: mat4 source

public get inverseViewProjectionMatrix: mat4 source

public get layer: string | null source

public set layer: string | null source

public get projectionMatrix: mat4 source

public get renderTargetFloat: boolean source

public set renderTargetFloat: boolean source

public get renderTargetHeight: number source

public set renderTargetHeight: number source

public get renderTargetId: string | null source

public set renderTargetId: string | null source

public get renderTargetMulti: *[] source

public set renderTargetMulti: *[] source

public get renderTargetScale: number source

public set renderTargetScale: number source

public get renderTargetWidth: number source

public set renderTargetWidth: number source

public get viewMatrix: mat4 source

public get viewProjectionMatrix: mat4 source

Public Methods

public abstract buildCameraMatrix(target: mat4, width: number, height: number) source

Building camera matrix.

Params:

NameTypeAttributeDescription
target mat4

Result mat4 object.
width number

Width.
height number

Height.

public convertUnitPointToGlobalPoint(target: vec2, unitVec: vec2) source

Convert screen space unit ([-1; 1]) vec2 point to global vec2 point.

Params:

NameTypeAttributeDescription
target vec2

Result vec2 point.
unitVec vec2

Input screen space unit vec2 point.

public dispose() source

Destructor (dispose internal resources and detach from entity).

Override:

Component#dispose

public onAction(name: *, args: ...*): * source

Called when action arrived.

Override:

Component#onAction

Params:

NameTypeAttributeDescription
name *
args ...*

Return:

*

public onAttach() source

Called after attached to entity.

Override:

Component#onAttach

public onDetach() source

Called before detached from entity.

Override:

Component#onDetach

public onResize(width: number, height: number) source

Called on view resize.

Params:

NameTypeAttributeDescription
width number

Width.
height number

Height.

public onView(gl: WebGLRenderingContext, renderer: RenderSystem, deltaTime: number): boolean source

Called when camera need to view rendered scene.

Params:

NameTypeAttributeDescription
gl WebGLRenderingContext

WebGL context.
renderer RenderSystem

Calling renderer instance.
deltaTime number

Delta time.

Return:

boolean

True if ignore viewing entity children, false otherwise.

public registerPostprocess(postprocess: PostprocessPass, floatPointData: boolean) source

Register postprocess.

Params:

NameTypeAttributeDescription
postprocess PostprocessPass

Postprocess pass.
floatPointData boolean

Tells if stores floating point texture data.

public unregisterPostprocess() source

Unregister postprocess.