API Docs for: 0.1.0
Show:

zerk.game.engine.viewport Class

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

Viewport

This class is responsible for rendering the world on a canvas.

Methods

_clearMessages

() protected

Defined in src/zerk/class/game/engine/viewport.js:768

Removes messages that timed out

_debugDrawGrid

() protected

Defined in src/zerk/class/game/engine/viewport.js:1449

Renders the grid

_getCanvasX

(
  • meter
  • pixel
)
Integer protected

Defined in src/zerk/class/game/engine/viewport.js:913

Parameters:

  • meter Float
  • pixel Integer

Returns:

Integer:

_getCanvasY

(
  • meter
  • pixel
)
Integer protected

Defined in src/zerk/class/game/engine/viewport.js:945

Parameters:

  • meter Float
  • pixel Integer

Returns:

Integer:

_getEntitiesInViewport

() Array protected

Defined in src/zerk/class/game/engine/viewport.js:669

Returns a list of all entities currently visible in the viewport

Returns:

Array: Entity list

_log

(
  • msg
)
protected

Defined in src/zerk/class/game/engine/viewport.js:1521

Local log method

Parameters:

  • msg String

    Log message

_renderBody

(
  • entity
  • body
)
protected

Defined in src/zerk/class/game/engine/viewport.js:1024

Renders a body onto the game canvas

Parameters:

_renderBodyAngleIndicator

(
  • entity
  • body
)
protected

Defined in src/zerk/class/game/engine/viewport.js:1337

Renders an angle indicator for each body of the entity

Parameters:

_renderDebugInfo

() protected

Defined in src/zerk/class/game/engine/viewport.js:870

Renders debug information onto the game canvas

_renderDebugInfoLine

(
  • text
  • line
)
protected

Defined in src/zerk/class/game/engine/viewport.js:992

Renders a line of debug information onto the game canvas

Parameters:

  • text String

    Text to be rendered

  • line Integer

    Row number

_renderEntity

(
  • entity
)
protected

Defined in src/zerk/class/game/engine/viewport.js:1007

Renders an entity onto the game canvas

Parameters:

_renderEntityBoundingBody

(
  • entity
  • body
)
protected

Defined in src/zerk/class/game/engine/viewport.js:1293

Renders a bounding box for a body

Parameters:

_renderEntityOriginIndicator

(
  • entity
)
protected

Defined in src/zerk/class/game/engine/viewport.js:1376

Renders the entity origin indicator

Parameters:

_renderFixture

(
  • entity
  • body
  • fixture
)
protected

Defined in src/zerk/class/game/engine/viewport.js:1097

Renders a fixture onto the body buffer canvas

Parameters:

  • entity zerk.engine.entity.entity

    Entity

  • body zerk.engine.physics.body.body

    Body

  • fixture zerk.engine.physics.fixture.fixture

    Fixture

_renderFixtureBoundingCircle

(
  • entity
  • body
  • fixture
)
protected

Defined in src/zerk/class/game/engine/viewport.js:1228

Renders the bounding area for a circle shaped fixture

Parameters:

_renderFixtureBoundingPolygon

(
  • entity
  • body
  • fixture
)
protected

Defined in src/zerk/class/game/engine/viewport.js:1254

Renders the bounding area for a polygon shaped fixture

Parameters:

_renderFixtureBoundingShape

(
  • entity
  • body
  • fixture
)
protected

Defined in src/zerk/class/game/engine/viewport.js:1169

Renders a shape indicating the bounding area of a fixture

Delegate method for the fixture bounding shape methods

Parameters:

_renderFixtureBoundingShape

(
  • entity
  • body
  • fixture
)
protected

Defined in src/zerk/class/game/engine/viewport.js:1196

Renders the bounding area for a box shaped fixture

Parameters:

_renderMessages

() protected

Defined in src/zerk/class/game/engine/viewport.js:800

Renders messages

_renderSprite

(
  • entity
  • body
  • fixture
  • sprite
)
protected

Defined in src/zerk/class/game/engine/viewport.js:1314

Render sprite

Parameters:

_renderText

(
  • text
  • x
  • y
  • font
  • size
  • color
)
protected

Defined in src/zerk/class/game/engine/viewport.js:825

Render text onto the game canvas

Parameters:

  • text String
  • x Integer
  • y Integer
  • font String
  • size Integer
  • color String

_renderViewCenterIndicator

() protected

Defined in src/zerk/class/game/engine/viewport.js:1429

Renders the view center indicator

_renderWorldCenterIndicator

() protected

Defined in src/zerk/class/game/engine/viewport.js:1409

Renders the world center indicator

_setupRequestAnimationFrame

() protected

Defined in src/zerk/class/game/engine/viewport.js:698

Crossbrowser requestAnimationFrame

http://paulirish.com/2011/requestanimationframe-for-smart-animating/

http://my.opera.com/emoller/blog/2011/12/20/requestanimationframe-for-smart-er-animating

requestAnimationFrame polyfill by Erik Möller

fixes from Paul Irish and Tino Zijdel

_setViewPosition

(
  • x
  • y
)
protected

Defined in src/zerk/class/game/engine/viewport.js:977

Set the view position to a given world position

Parameters:

  • x Float
  • y Float

autoScale

()

Defined in src/zerk/class/game/engine/viewport.js:322

Scale the viewport size to the game canvas size

clear

()

Defined in src/zerk/class/game/engine/viewport.js:375

Clear the viewport

clearMessages

()

Defined in src/zerk/class/game/engine/viewport.js:488

Removes all messages

fromScaleX

(
  • value
)
Float

Defined in src/zerk/class/game/engine/viewport.js:621

Un-scales given value by current zoom factor

Parameters:

  • value Float

    Value

Returns:

Float: Scaled value

fromScaleY

(
  • value
)
Float

Defined in src/zerk/class/game/engine/viewport.js:634

Un-scales given value by current zoom factor

Parameters:

  • value Float

    Value

Returns:

Float: Scaled value

getHeight

()

Defined in src/zerk/class/game/engine/viewport.js:583

Returns the height of the viewport in pixels

Returns:

Integer

getOffsetX

()

Defined in src/zerk/class/game/engine/viewport.js:547

Returns the horizontal view position in meters

Returns:

Float

getOffsetY

()

Defined in src/zerk/class/game/engine/viewport.js:559

Returns the vertical view position in meters

Returns:

Float

getWidth

()

Defined in src/zerk/class/game/engine/viewport.js:571

Returns the width of the viewport in pixels

Returns:

Integer

getX

()

Defined in src/zerk/class/game/engine/viewport.js:499

Returns the horizontal view position in pixels

Returns:

Float

getY

()

Defined in src/zerk/class/game/engine/viewport.js:511

Returns the vertical view position in pixels

Returns:

Float

init

(
  • engine
)

Defined in src/zerk/class/game/engine/viewport.js:202

Class constructor

Parameters:

registerMessage

(
  • message
)

Defined in src/zerk/class/game/engine/viewport.js:453

Registers a message

Parameters:

render

()

Defined in src/zerk/class/game/engine/viewport.js:386

Renders the current world state onto the game canvas

reset

()

Defined in src/zerk/class/game/engine/viewport.js:364

Reset the viewport

setX

()

Defined in src/zerk/class/game/engine/viewport.js:523

Sets the horizontal view position in pixels

Returns:

Float

setY

()

Defined in src/zerk/class/game/engine/viewport.js:535

Sets the vertical view position in pixels

Returns:

Float

start

()

Defined in src/zerk/class/game/engine/viewport.js:336

Start the viewport

stop

()

Defined in src/zerk/class/game/engine/viewport.js:349

Stop the viewport

toScaleX

(
  • value
)
Float

Defined in src/zerk/class/game/engine/viewport.js:595

Scales given value by current zoom factor

Parameters:

  • value Float

    Value

Returns:

Float: Scaled value

toScaleY

(
  • value
)
Float

Defined in src/zerk/class/game/engine/viewport.js:608

Scales given value by current zoom factor

Parameters:

  • value Float

    Value

Returns:

Float: Scaled value

unregisterMessage

(
  • id
)

Defined in src/zerk/class/game/engine/viewport.js:465

Unregisters a message

Parameters:

  • id String

    Message id

zoomIn

()

Defined in src/zerk/class/game/engine/viewport.js:647

Increases current zoom factor by factor 10

zoomOut

()

Defined in src/zerk/class/game/engine/viewport.js:658

Decreases current zoom factor by factor 10

Properties

_bufferBody

DOMElement protected

Defined in src/zerk/class/game/engine/viewport.js:36

Buffer to render full bodies

_bufferBodyContext

Object protected

Defined in src/zerk/class/game/engine/viewport.js:45

Context of the body buffer

_bufferFixture

DOMElement protected

Defined in src/zerk/class/game/engine/viewport.js:54

Buffer for rendering of single fixtures

_bufferFixtureContext

Object protected

Defined in src/zerk/class/game/engine/viewport.js:63

Context of the fixture buffer

_canvas

DOMElement protected

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

Game canvas

_context

Object protected

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

Context of the main canvas

_fps

Integer protected

Defined in src/zerk/class/game/engine/viewport.js:117

The number of rendered frames per second

_fpsCounter

Integer protected

Defined in src/zerk/class/game/engine/viewport.js:99

Counter used to calculate FPS

_fpsSecond

Integer protected

Defined in src/zerk/class/game/engine/viewport.js:108

Stores the second of the last FPS measuring

_frameCount

Integer protected

Defined in src/zerk/class/game/engine/viewport.js:90

The total number of frames rendered

_height

Integer protected

Defined in src/zerk/class/game/engine/viewport.js:184

Height of the viewport in pixels

_messages

Array protected

Defined in src/zerk/class/game/engine/viewport.js:193

Text messages

_offsetX

Float protected

Defined in src/zerk/class/game/engine/viewport.js:157

Horizontal view position in meters

_offsetY

Float protected

Defined in src/zerk/class/game/engine/viewport.js:166

Vertical view position in meters

_running

Boolean protected

Defined in src/zerk/class/game/engine/viewport.js:81

Inidcates if the viewport is running

_timer

DOMTimer protected

Defined in src/zerk/class/game/engine/viewport.js:72

Rendering timer

_width

Integer protected

Defined in src/zerk/class/game/engine/viewport.js:175

Width of the viewport in pixels

_x

Float protected

Defined in src/zerk/class/game/engine/viewport.js:139

Horizontal view position in pixels

_y

Float protected

Defined in src/zerk/class/game/engine/viewport.js:148

Vertical view position in pixels

_zoom

Float protected

Defined in src/zerk/class/game/engine/viewport.js:126

Zoom factor