Reference Source
public class | source

CustomProjection

Extends:

Component → CustomProjection

Defines a custom projection for a Camera as a custom 4x4 matrix..

Located at Camera#customProjection.

Member Summary

Public Members
public

The Camera this CustomProjection belongs to.

public get

Gets the inverse of CustomProjection#matrix.

public set

matrix(matrix: Number[])

Sets the CustomProjection's projection transform matrix.

Fires a "matrix" event on change.

Default value is [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1].

public get

matrix: Number[]: *

Gets the CustomProjection's projection transform matrix.

Default value is [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1].

public get

Gets the transpose of CustomProjection#matrix.

Method Summary

Public Methods
public

unproject(canvasPos: Number[], screenZ: Number, screenPos: Number[], viewPos: Number[], worldPos: Number[]): *

Un-projects the given Canvas-space coordinates, using this CustomProjection.

Inherited Summary

From class Component
public get

The Component that owns the lifecycle of this Component, if any.

public

True as soon as this Component has been destroyed

public

ID of this Component, unique within the Scene.

public

meta: *

Arbitrary, user-defined metadata on this component.

public

The parent Scene that contains this Component.

public

The viewer that contains this Scene.

public

clear()

Destroys all Components that are owned by this.

public

Destroys this component.

public

error(message: String)

Logs an error for this component to the JavaScript console.

public

fire(event: String, value: Object, forget: Boolean)

Fires an event on this component.

public

Returns true if there are any subscribers to the given event on this component.

public

isType(type: *): *: Boolean

Tests if this component is of the given type, or is a subclass of the given type.

public

log(message: String)

Logs a console debugging message for this component.

public

off(subId: String)

Cancels an event subscription that was previously made with Component#on or Component#once.

public

on(event: String, callback: Function, scope: Object): String

Subscribes to an event on this component.

public

once(event: String, callback: Function, scope: Object)

Subscribes to the next occurrence of the given event, then un-subscribes as soon as the event is subIdd.

public

scheduleTask(task: *)

Schedule a task to perform on the next browser interval

public

warn(message: String)

Logs a warning for this component to the JavaScript console.

Public Members

public camera: Camera source

The Camera this CustomProjection belongs to.

Properties:

NameTypeAttributeDescription
camera *

public get inverseMatrix: Number[]: * source

Gets the inverse of CustomProjection#matrix.

Return:

Number[]

The inverse of CustomProjection#matrix.

public set matrix(matrix: Number[]) source

Sets the CustomProjection's projection transform matrix.

Fires a "matrix" event on change.

Default value is [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1].

public get matrix: Number[]: * source

Gets the CustomProjection's projection transform matrix.

Default value is [1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1, 0, 0, 0, 0, 1].

Return:

Number[]

New value for the CustomProjection's matrix.

public get transposedMatrix: Number[]: * source

Gets the transpose of CustomProjection#matrix.

Return:

Number[]

The transpose of CustomProjection#matrix.

Public Methods

public unproject(canvasPos: Number[], screenZ: Number, screenPos: Number[], viewPos: Number[], worldPos: Number[]): * source

Un-projects the given Canvas-space coordinates, using this CustomProjection.

Params:

NameTypeAttributeDescription
canvasPos Number[]

Inputs 2D Canvas-space coordinates.

screenZ Number

Inputs Screen-space Z coordinate.

screenPos Number[]

Outputs 3D Screen/Clip-space coordinates.

viewPos Number[]

Outputs un-projected 3D View-space coordinates.

worldPos Number[]

Outputs un-projected 3D World-space coordinates.

Return:

*