Reference Source
public class | source

Viewport

Extends:

Component → Viewport

Member Summary

Public Members
public set

Sets if Viewport#boundary automatically synchronizes with Canvas#boundary.

public get

Gets if Viewport#boundary automatically synchronizes with Canvas#boundary.

public set

boundary(value: Number[])

Sets the canvas-space boundary of this Viewport, indicated as [min, max, width, height].

public get

Gets the canvas-space boundary of this Viewport, indicated as [min, max, width, height].

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

viewer: *

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 autoBoundary(value: Boolean) source

Sets if Viewport#boundary automatically synchronizes with Canvas#boundary.

Default is false.

public get autoBoundary: Boolean: * source

Gets if Viewport#boundary automatically synchronizes with Canvas#boundary.

Default is false.

Return:

Boolean

Returns true when automatically sycnhronizing.

public set boundary(value: Number[]) source

Sets the canvas-space boundary of this Viewport, indicated as [min, max, width, height].

When Viewport#autoBoundary is true, ignores calls to this method and automatically synchronizes with Canvas#boundary.

Fires a "boundary"" event on change.

Defaults to the Canvas extents.

public get boundary: Number[]: * source

Gets the canvas-space boundary of this Viewport, indicated as [min, max, width, height].

Return:

Number[]

The Viewport extents.