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

CameraDirector2D

Extends:

Component → CameraDirector2D

Control multiple 2D cameras with one director.

Example:

const component = new CameraDirector2D();
component.deserialize({ zoomOut: 1024, zoomMode: 'keep-aspect', cameras: [ './cameraA', './cameraB' ] });

Static Member Summary

Static Public Members
public static get
public static get

Static Method Summary

Static Public Methods
public static

Componeny 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 set
public get
public set
public get
public set
public get
public set

Method Summary

Public Methods
public

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

public

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

public

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

Called when camera need to view rendered scene.

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 ZoomMode: * source

public static get propsTypes: * source

Override:

Component#propsTypes

Static Public Methods

public static factory(): CameraDirector2D source

Componeny factory.

Override:

Component#factory

Return:

CameraDirector2D

Component instance.

Public Constructors

public constructor() source

Constructor.

Override:

Component#constructor

Public Members

public get cameras: Array<string> source

public set cameras: Array<string> source

public get captureEntity: string | null source

public set captureEntity: number | null 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 onAction(name: *, args: ...*): * source

Called when action arrived.

Override:

Component#onAction

Params:

NameTypeAttributeDescription
name *
args ...*

Return:

*

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

Called when property is serialized.

Override:

Component#onPropertySerialize

Params:

NameTypeAttributeDescription
name *
value *

Return:

*

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.