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

Camera2D

Extends:

ComponentCamera → Camera2D

Camera used to view 2D scene.

Example:

const component = new Camera2D();
component.deserialize({ zoomOut: 1024, zoomMode: 'keep-aspect' });

Static Member Summary

Static Public Members
public static get
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 get
public get
public set
public get
public set
public get
public set
public get
public set
public get
public set

Method Summary

Public Methods
public

buildCameraMatrix(target: *, width: *, height: *)

public

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

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.

From class Camera
public static get
public static

Component factory.

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
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.

Static Public Members

public static get ZoomMode: * source

public static get propsTypes: * source

Override:

Camera#propsTypes

Static Public Methods

public static factory(): Camera2D source

Component factory.

Override:

Camera#factory

Return:

Camera2D

Component instance.

Public Constructors

public constructor() source

Constructor.

Override:

Camera#constructor

Public Members

public get cachedWorldHeight: number source

public get cachedWorldWidth: number source

public get far: number source

public set far: number source

public get near: number source

public set near: number source

public get zoom: number source

public set zoom: number source

public get zoomMode: string source

public set zoomMode: string source

public get zoomOut: number source

public set zoomOut: number source

Public Methods

public buildCameraMatrix(target: *, width: *, height: *) source

Building camera matrix.

Override:

Camera#buildCameraMatrix

Params:

NameTypeAttributeDescription
target *
width *
height *

public onPropertySerialize(name: *, value: *): * source

Called when property is serialized.

Override:

Component#onPropertySerialize

Params:

NameTypeAttributeDescription
name *
value *

Return:

*