Reference Source
public class | source

Ortho

Extends:

Component → Ortho

Defines its Camera's orthographic projection as a box-shaped view volume.

  • Located at Camera#ortho.
  • Works like Blender's orthographic projection, where the positions of the left, right, top and bottom planes are implicitly indicated with a single Ortho#scale property, which causes the frustum to be symmetrical on X and Y axis, large enough to contain the number of units given by Ortho#scale.
  • Ortho#near and Ortho#far indicated the distances to the WebGL clipping planes.

Member Summary

Public Members
public set

far(value: Number)

Sets the position of the Ortho's far plane on the positive View-space Z-axis.

Fires a "far" event on change.

Default value is 10000.0.

public get

far: Number: *

Gets the position of the Ortho's far plane on the positive View-space Z-axis.

Default value is 10000.0.

public get

matrix: Number[]: *

Gets the Ortho'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 set

near(value: Number)

Sets the position of the Ortho's near plane on the positive View-space Z-axis.

Fires a "near" emits on change.

Default value is 0.1.

public get

near: Number: *

Gets the position of the Ortho's near plane on the positive View-space Z-axis.

Default value is 0.1.

public set

scale(value: Number)

Sets scale factor for this Ortho's extents on X and Y axis.

Clamps to minimum value of `0.01.

Fires a "scale" event on change.

Default value is 1.0

public get

Gets scale factor for this Ortho's extents on X and Y axis.

Clamps to minimum value of `0.01.

Default value is 1.0

Method Summary

Public Methods
public

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

warn(message: String)

Logs a warning for this component to the JavaScript console.

Public Members

public set far(value: Number) source

Sets the position of the Ortho's far plane on the positive View-space Z-axis.

Fires a "far" event on change.

Default value is 10000.0.

public get far: Number: * source

Gets the position of the Ortho's far plane on the positive View-space Z-axis.

Default value is 10000.0.

Return:

Number

New far ortho plane position.

public get matrix: Number[]: * source

Gets the Ortho'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].

Return:

Number[]

The Ortho's projection matrix.

public set near(value: Number) source

Sets the position of the Ortho's near plane on the positive View-space Z-axis.

Fires a "near" emits on change.

Default value is 0.1.

public get near: Number: * source

Gets the position of the Ortho's near plane on the positive View-space Z-axis.

Default value is 0.1.

Return:

Number

New Ortho near plane position.

public set scale(value: Number) source

Sets scale factor for this Ortho's extents on X and Y axis.

Clamps to minimum value of `0.01.

Fires a "scale" event on change.

Default value is 1.0

public get scale: Number: * source

Gets scale factor for this Ortho's extents on X and Y axis.

Clamps to minimum value of `0.01.

Default value is 1.0

Return:

Number

New Ortho scale value.

Public Methods

public destroy() source

Destroys this component.

Override:

Component#destroy