import Camera2D from 'oxygen-core/components/Camera2D.js'

public class | source

Camera2D

Extends:

Component → Camera → 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	ZoomMode: *
public static get	propsTypes: *

Static Method Summary

Static Public Methods
public static	factory(): Camera2D Component factory.

Constructor Summary

Public Constructor
public	constructor() Constructor.

Member Summary

Public Members
public get	cachedWorldHeight: number
public get	cachedWorldWidth: number
public get	far: number
public set	far: number
public get	near: number
public set	near: number
public get	zoom: number
public set	zoom: number
public get	zoomMode: string
public set	zoomMode: string
public get	zoomOut: number
public set	zoomOut: number

Method Summary

Public Methods
public	buildCameraMatrix(target: , width: , height: *)
public	onPropertySerialize(name: , value: ): *

Inherited Summary

From class Component
public static get	propsTypes: *
public static	factory(): Component Component factory.
public get	entity: Entity \| null
public	[name]: *
public	deserialize(json: *) Deserialize JSON properties into this component.
public	dispose() 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	onAttach() Called after attached to entity.
public	onDetach() 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	propsTypes: *
public static	factory(): Camera Component factory.
public get	captureEntity: string \| null
public set	captureEntity: string \| null
public get	command: Command \| null
public set	command: Command \| null
public get	ignoreChildrenViews: boolean
public set	ignoreChildrenViews: boolean
public get	inverseProjectionMatrix: mat4
public get	inverseViewMatrix: mat4
public get	inverseViewProjectionMatrix: mat4
public get	layer: string \| null
public set	layer: string \| null
public get	projectionMatrix: mat4
public get	renderTargetFloat: boolean
public set	renderTargetFloat: boolean
public get	renderTargetHeight: number
public set	renderTargetHeight: number
public get	renderTargetId: string \| null
public set	renderTargetId: string \| null
public get	renderTargetMulti: *[]
public set	renderTargetMulti: *[]
public get	renderTargetScale: number
public set	renderTargetScale: number
public get	renderTargetWidth: number
public set	renderTargetWidth: number
public get	viewMatrix: mat4
public get	viewProjectionMatrix: mat4
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	dispose()
public	onAction(name: , args: ...): *
public	onAttach()
public	onDetach()
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	unregisterPostprocess() 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:

Name	Type	Attribute	Description
target	*
width	*
height	*

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

Called when property is serialized.

Override:

Component#onPropertySerialize

Params:

Name	Type	Attribute	Description
name	*
value	*

Camera2D

Extends:

Example:

Static Member Summary

Static Method Summary

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Static Public Members

public static get ZoomMode: * source

public static get propsTypes: * source

Override:

Static Public Methods

public static factory(): Camera2D source

Override:

Return:

Public Constructors

public constructor() source

Override:

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

Override:

Params:

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

Override:

Params:

Return:

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

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