API Docs for: 0.1.0
Show:

zerk.game.engine.system.viewport.canvas Class

Extends zerk.game.engine.system.viewport
Defined in: src/zerk/class/game/engine/system/viewport/canvas.js:1
Module: zerk

Canvas Viewport System

Visualization implementation for HTML Canvas.

Methods

_createCanvas

(
  • id
  • width
  • height
  • visible
)
DOMElement protected

Defined in src/zerk/class/game/engine/system/viewport/canvas.js:640

Creates a canvas DOM element

Parameters:

  • id String

    DOM id

  • width Integer

    Canvas width

  • height Integer

    Canvas height

  • visible Boolean

    Canvas visibility

Returns:

DOMElement: Canvas DOM element

_debugDrawGrid

() protected

Inherited from zerk.game.engine.system.viewport: src/zerk/class/game/engine/system/viewport.js:683

Renders the grid

_getCanvas

(
  • PARAM_NAME
)
Boolean | Integer | Float | String | Object | Array | Function | Mixed | Any | CLASS_NAME deprecated protected async

Defined in src/zerk/class/game/engine/system/viewport/canvas.js:688

PROTECTEDMETHODDESCRIPTION

Parameters:

  • PARAM_NAME Boolean | Integer | Float | String | Object | Array | Function | Mixed | Any | CLASS_NAME

    PARAMDESCRIPTION SECONDLINE

Returns:

Boolean | Integer | Float | String | Object | Array | Function | Mixed | Any | CLASS_NAME: RETURN_DESCRIPTION

_getCanvasX

(
  • meter
  • pixel
)
Integer protected

Inherited from zerk.game.engine.system.viewport: src/zerk/class/game/engine/system/viewport.js:575

Parameters:

  • meter Float
  • pixel Integer

Returns:

Integer:

_getCanvasY

(
  • meter
  • pixel
)
Integer protected

Inherited from zerk.game.engine.system.viewport: src/zerk/class/game/engine/system/viewport.js:607

Parameters:

  • meter Float
  • pixel Integer

Returns:

Integer:

_getConfigDefaults

() Object protected

Inherited from zerk.game.engine.system but overwritten in src/zerk/class/game/engine/system/viewport.js:212

Returns the configuration defaults of the system

Returns:

Object: Default configuration

_getContext

(
  • PARAM_NAME
)
Boolean | Integer | Float | String | Object | Array | Function | Mixed | Any | CLASS_NAME deprecated protected async

Defined in src/zerk/class/game/engine/system/viewport/canvas.js:705

PROTECTEDMETHODDESCRIPTION

Parameters:

  • PARAM_NAME Boolean | Integer | Float | String | Object | Array | Function | Mixed | Any | CLASS_NAME

    PARAMDESCRIPTION SECONDLINE

Returns:

Boolean | Integer | Float | String | Object | Array | Function | Mixed | Any | CLASS_NAME: RETURN_DESCRIPTION

_getEntitiesInViewport

() Array protected

Inherited from zerk.game.engine.system.viewport: src/zerk/class/game/engine/system/viewport.js:546

Returns a list of all entities currently visible in the viewport

Returns:

Array: Entity list

_getSystem

(
  • name
)
zerk.game.engine.system protected

Inherited from zerk.game.engine.system: src/zerk/class/game/engine/system.js:231

Returns system by given name

This method is used to communicate with other systems.

Parameters:

  • name String

    System name

Returns:

zerk.game.engine.system: System instance

_log

(
  • message
  • severity
)
protected

Inherited from zerk.game.engine.system: src/zerk/class/game/engine/system.js:247

Local log method

Parameters:

  • message String

    Log message

  • severity Integer

    Log severity

_renderWorldCenterIndicator

() protected

Inherited from zerk.game.engine.system.viewport: src/zerk/class/game/engine/system/viewport.js:654

Renders the world center indicator

_setViewPosition

(
  • x
  • y
)
protected

Inherited from zerk.game.engine.system.viewport: src/zerk/class/game/engine/system/viewport.js:639

Set the view position to a given world position

Parameters:

  • x Float
  • y Float

addEntity

(
  • entity
)

Inherited from zerk.game.engine.system: src/zerk/class/game/engine/system.js:152

Adds an entity to the system

Parameters:

bufferClear

(
  • buffer
)

Defined in src/zerk/class/game/engine/system/viewport/canvas.js:177

Clear a buffer by given buffer id

Parameters:

  • buffer String

    Buffer id

bufferFlush

(
  • source
  • target
  • width
  • height
  • x
  • y
)

Defined in src/zerk/class/game/engine/system/viewport/canvas.js:147

Flush a buffers content onto another buffer

Parameters:

  • source String

    Source buffer id

  • target String

    Target buffer id

  • width Float

    Target width

  • height Float

    Target height

  • x Float

    Target horizontal position

  • y Float

    Target vertical position

bufferInit

(
  • buffer
  • width
  • height
  • x
  • y
  • angle
)

Defined in src/zerk/class/game/engine/system/viewport/canvas.js:123

Initializes a buffer for drawing

Parameters:

  • buffer String

    Buffer id

  • width Float

    Width

  • height Float

    Height

  • x Float

    Center x

  • y Float

    Center y

  • angle Float

    Angle

createBuffers

(
  • buffers
)
deprecated

Defined in src/zerk/class/game/engine/system/viewport/canvas.js:52

Creates multiple buffers

Parameters:

  • buffers Object

    A list of buffers to be created

drawArc

(
  • PARAM_NAME
)
Boolean | Integer | Float | String | Object | Array | Function | Mixed | Any | CLASS_NAME

Defined in src/zerk/class/game/engine/system/viewport/canvas.js:314

PUBLICMETHODDESCRIPTION

Parameters:

  • PARAM_NAME Boolean | Integer | Float | String | Object | Array | Function | Mixed | Any | CLASS_NAME

    PARAMDESCRIPTION SECONDLINE

Returns:

Boolean | Integer | Float | String | Object | Array | Function | Mixed | Any | CLASS_NAME: RETURN_DESCRIPTION

drawLines

(
  • buffer
  • lines
  • color
  • lineWidth
)

Defined in src/zerk/class/game/engine/system/viewport/canvas.js:191

Draw lines

Parameters:

  • buffer String

    Buffer id

  • lines Object

    Two dimensional array containing the lines

  • color String

    RGB color

  • lineWidth Float

    Width of the lines

drawPolygon

(
  • PARAM_NAME
)
Boolean | Integer | Float | String | Object | Array | Function | Mixed | Any | CLASS_NAME

Defined in src/zerk/class/game/engine/system/viewport/canvas.js:414

PUBLICMETHODDESCRIPTION

Parameters:

  • PARAM_NAME Boolean | Integer | Float | String | Object | Array | Function | Mixed | Any | CLASS_NAME

    PARAMDESCRIPTION SECONDLINE

Returns:

Boolean | Integer | Float | String | Object | Array | Function | Mixed | Any | CLASS_NAME: RETURN_DESCRIPTION

drawRect

(
  • PARAM_NAME
)
Boolean | Integer | Float | String | Object | Array | Function | Mixed | Any | CLASS_NAME

Defined in src/zerk/class/game/engine/system/viewport/canvas.js:230

Draw a rectangle

Parameters:

  • PARAM_NAME Boolean | Integer | Float | String | Object | Array | Function | Mixed | Any | CLASS_NAME

    PARAM_DESCRIPTION

Returns:

Boolean | Integer | Float | String | Object | Array | Function | Mixed | Any | CLASS_NAME: RETURN_DESCRIPTION

drawText

(
  • PARAM_NAME
)
Boolean | Integer | Float | String | Object | Array | Function | Mixed | Any | CLASS_NAME

Defined in src/zerk/class/game/engine/system/viewport/canvas.js:525

PUBLICMETHODDESCRIPTION

Parameters:

  • PARAM_NAME Boolean | Integer | Float | String | Object | Array | Function | Mixed | Any | CLASS_NAME

    PARAMDESCRIPTION SECONDLINE

Returns:

Boolean | Integer | Float | String | Object | Array | Function | Mixed | Any | CLASS_NAME: RETURN_DESCRIPTION

fillArc

(
  • PARAM_NAME
)
Boolean | Integer | Float | String | Object | Array | Function | Mixed | Any | CLASS_NAME

Defined in src/zerk/class/game/engine/system/viewport/canvas.js:370

PUBLICMETHODDESCRIPTION

Parameters:

  • PARAM_NAME Boolean | Integer | Float | String | Object | Array | Function | Mixed | Any | CLASS_NAME

    PARAMDESCRIPTION SECONDLINE

Returns:

Boolean | Integer | Float | String | Object | Array | Function | Mixed | Any | CLASS_NAME: RETURN_DESCRIPTION

fillPolygon

(
  • PARAM_NAME
)
Boolean | Integer | Float | String | Object | Array | Function | Mixed | Any | CLASS_NAME

Defined in src/zerk/class/game/engine/system/viewport/canvas.js:477

PUBLICMETHODDESCRIPTION

Parameters:

  • PARAM_NAME Boolean | Integer | Float | String | Object | Array | Function | Mixed | Any | CLASS_NAME

    PARAMDESCRIPTION SECONDLINE

Returns:

Boolean | Integer | Float | String | Object | Array | Function | Mixed | Any | CLASS_NAME: RETURN_DESCRIPTION

fillRect

(
  • PARAM_NAME
)
Boolean | Integer | Float | String | Object | Array | Function | Mixed | Any | CLASS_NAME

Defined in src/zerk/class/game/engine/system/viewport/canvas.js:283

PUBLICMETHODDESCRIPTION

Parameters:

  • PARAM_NAME Boolean | Integer | Float | String | Object | Array | Function | Mixed | Any | CLASS_NAME

    PARAMDESCRIPTION SECONDLINE

Returns:

Boolean | Integer | Float | String | Object | Array | Function | Mixed | Any | CLASS_NAME: RETURN_DESCRIPTION

fireEvent

(
  • event
)
Boolen

Inherited from zerk.observable: src/zerk/class/observable.js:112

Fire event

Parameters:

  • event String

    Event name

Returns:

Boolen: Returns false when the bubble was canceled

fromScaleX

(
  • value
)
Float

Inherited from zerk.game.engine.system.viewport: src/zerk/class/game/engine/system/viewport.js:474

Un-scales given value by current zoom factor

Parameters:

  • value Float

    Value

Returns:

Float: Scaled value

fromScaleY

(
  • value
)
Float

Inherited from zerk.game.engine.system.viewport: src/zerk/class/game/engine/system/viewport.js:487

Un-scales given value by current zoom factor

Parameters:

  • value Float

    Value

Returns:

Float: Scaled value

getBufferSize

(
  • buffer
)
Object

Defined in src/zerk/class/game/engine/system/viewport/canvas.js:105

Returns the size of the buffer by given id

Parameters:

  • buffer String

    Buffer id

Returns:

Object: An object containing with and height

getCanvasElement

(
  • buffer
)
DOMElement

Defined in src/zerk/class/game/engine/system/viewport/canvas.js:92

Return a canvas element for given buffer id

Parameters:

  • buffer String

    Buffer id

Returns:

DOMElement: Canvas element

getCanvasPhysicsDebug

() DOMElement

Defined in src/zerk/class/game/engine/system/viewport/canvas.js:613

Returns the physics debug canvas DOM element

Returns:

DOMElement: Physics debug canvas DOM element

getCanvasPosition

(
  • buffer
)
Object

Defined in src/zerk/class/game/engine/system/viewport/canvas.js:77

Returns a canvas position relative to its parent HTML document

Parameters:

  • buffer String

    Buffer id

Returns:

Object: An object containing x and y

getFPS

() Integer

Inherited from zerk.game.engine.system.viewport: src/zerk/class/game/engine/system/viewport.js:522

Returns the current count of frames drawn per second

Returns:

Integer: FPS

getHeight

()

Inherited from zerk.game.engine.system.viewport: src/zerk/class/game/engine/system/viewport.js:436

Returns the height of the viewport in pixels

Returns:

Integer

getName

() String

Inherited from zerk.game.engine.system: src/zerk/class/game/engine/system.js:128

Returns the name of the system

Returns:

String: System name

getOffsetX

() deprecated

Inherited from zerk.game.engine.system.viewport: src/zerk/class/game/engine/system/viewport.js:398

Returns the horizontal view position in meters

Returns:

Float

getOffsetY

() deprecated

Inherited from zerk.game.engine.system.viewport: src/zerk/class/game/engine/system/viewport.js:411

Returns the vertical view position in meters

Returns:

Float

getPriority

() Integer

Inherited from zerk.game.engine.system: src/zerk/class/game/engine/system.js:140

Returns the priority of the system

Returns:

Integer: System priority

getThread

() String

Inherited from zerk.game.engine.system: src/zerk/class/game/engine/system.js:116

Returns the thread the systems runs in

Returns:

String: Thread name

getWidth

()

Inherited from zerk.game.engine.system.viewport: src/zerk/class/game/engine/system/viewport.js:424

Returns the width of the viewport in pixels

Returns:

Integer

getX

()

Inherited from zerk.game.engine.system.viewport: src/zerk/class/game/engine/system/viewport.js:350

Returns the horizontal view position in pixels

Returns:

Float

getY

()

Inherited from zerk.game.engine.system.viewport: src/zerk/class/game/engine/system/viewport.js:362

Returns the vertical view position in pixels

Returns:

Float

getZoom

() Float

Inherited from zerk.game.engine.system.viewport: src/zerk/class/game/engine/system/viewport.js:534

Return the current zoom factor

Returns:

Float: Zoom factor

init

(
  • engine
  • config
)

Inherited from zerk.observable but overwritten in src/zerk/class/game/engine/system/viewport/canvas.js:36

Class constructor

Parameters:

on

(
  • event
  • callback
  • scope
)

Inherited from zerk.observable: src/zerk/class/observable.js:38

Register event handler

Parameters:

  • event String

    Event name

  • callback Function

    Callback function. Return false to cancel event bubble.

  • scope Object

    Scope to be used in callback function

removeEntity

(
  • entity
)

Inherited from zerk.game.engine.system: src/zerk/class/game/engine/system.js:164

Removes an entity from the system

Parameters:

setX

()

Inherited from zerk.game.engine.system.viewport: src/zerk/class/game/engine/system/viewport.js:374

Sets the horizontal view position in pixels

Returns:

Float

setY

()

Inherited from zerk.game.engine.system.viewport: src/zerk/class/game/engine/system/viewport.js:386

Sets the vertical view position in pixels

Returns:

Float

start

()

Inherited from zerk.game.engine.system but overwritten in src/zerk/class/game/engine/system/viewport.js:248

Starts the system

stop

()

Inherited from zerk.game.engine.system but overwritten in src/zerk/class/game/engine/system/viewport.js:264

Stops the system

toScaleX

(
  • value
)
Float

Inherited from zerk.game.engine.system.viewport: src/zerk/class/game/engine/system/viewport.js:448

Scales given value by current zoom factor

Parameters:

  • value Float

    Value

Returns:

Float: Scaled value

toScaleY

(
  • value
)
Float

Inherited from zerk.game.engine.system.viewport: src/zerk/class/game/engine/system/viewport.js:461

Scales given value by current zoom factor

Parameters:

  • value Float

    Value

Returns:

Float: Scaled value

un

(
  • event
  • callback
)
Boolen

Inherited from zerk.observable: src/zerk/class/observable.js:80

Unregister event handler

Parameters:

  • event String

    Event name

  • callback Function

    Callback function

Returns:

Boolen: Returns true on success

update

()

Inherited from zerk.game.engine.system but overwritten in src/zerk/class/game/engine/system/viewport.js:282

Updates the system

useComponent

(
  • name
)
Boolean

Inherited from zerk.game.engine.system but overwritten in src/zerk/class/game/engine/system/viewport.js:234

Returns true when the system is interested in given component

Parameters:

  • name String

    Component name

Returns:

Boolean: True when the system is intereseted in given component

zoomIn

()

Inherited from zerk.game.engine.system.viewport: src/zerk/class/game/engine/system/viewport.js:500

Increases current zoom factor by factor 10

zoomOut

()

Inherited from zerk.game.engine.system.viewport: src/zerk/class/game/engine/system/viewport.js:511

Decreases current zoom factor by factor 10

Properties

_canvas

Object protected

Defined in src/zerk/class/game/engine/system/viewport/canvas.js:18

Register for canvas references

_config

Object protected

Inherited from zerk.game.engine.system: src/zerk/class/game/engine/system.js:77

System configuration

_context

Object protected

Defined in src/zerk/class/game/engine/system/viewport/canvas.js:27

Register for canvas context references

_engine

zerk.game.engine protected

Inherited from zerk.game.engine.system: src/zerk/class/game/engine/system.js:55

Engine instance

Back reference to the engine instance.

_entities

Array protected

Inherited from zerk.game.engine.system: src/zerk/class/game/engine/system.js:66

Entities register

Entities that this system is interested in.

_eventListeners

Array protected

Inherited from zerk.observable: src/zerk/class/observable.js:18

List of event handlers

_fps

Integer protected

Inherited from zerk.game.engine.system.viewport: src/zerk/class/game/engine/system/viewport.js:85

The number of rendered frames per second

_fpsCounter

Integer protected

Inherited from zerk.game.engine.system.viewport: src/zerk/class/game/engine/system/viewport.js:67

Counter used to calculate FPS

_fpsSecond

Integer protected

Inherited from zerk.game.engine.system.viewport: src/zerk/class/game/engine/system/viewport.js:76

Stores the second of the last FPS measuring

_frameCount

Integer protected

Inherited from zerk.game.engine.system.viewport: src/zerk/class/game/engine/system/viewport.js:58

The total number of frames rendered

_height

Integer protected

Inherited from zerk.game.engine.system.viewport: src/zerk/class/game/engine/system/viewport.js:154

Height of the viewport in pixels

_name

String protected

Inherited from zerk.game.engine.system but overwritten in src/zerk/class/game/engine/system/viewport.js:18

Name of the system

_offsetX

Float deprecated protected

Inherited from zerk.game.engine.system.viewport: src/zerk/class/game/engine/system/viewport.js:125

Horizontal view position in meters

_offsetY

Float deprecated protected

Inherited from zerk.game.engine.system.viewport: src/zerk/class/game/engine/system/viewport.js:135

Vertical view position in meters

_priority

Integer protected

Inherited from zerk.game.engine.system but overwritten in src/zerk/class/game/engine/system/viewport.js:36

Priority of this system

_thread

String protected

Inherited from zerk.game.engine.system but overwritten in src/zerk/class/game/engine/system/viewport.js:27

Thread that runs this system

_timer

DOMTimer protected

Inherited from zerk.game.engine.system.viewport: src/zerk/class/game/engine/system/viewport.js:45

Rendering timer

_width

Integer protected

Inherited from zerk.game.engine.system.viewport: src/zerk/class/game/engine/system/viewport.js:145

Width of the viewport in pixels

_x

Float protected

Inherited from zerk.game.engine.system.viewport: src/zerk/class/game/engine/system/viewport.js:107

Horizontal view position in pixels

_y

Float protected

Inherited from zerk.game.engine.system.viewport: src/zerk/class/game/engine/system/viewport.js:116

Vertical view position in pixels

_zoom

Float protected

Inherited from zerk.game.engine.system.viewport: src/zerk/class/game/engine/system/viewport.js:94

Zoom factor