API Docs for: 0.0.2
Show:

Atlantis.Camera2D Class

Defined in: Engine\Graphics\Camera2D.js:11
Module: Engine
Parent Module: Atlantis

A camera used in a 2D scene to manage scrolling

Constructor

Atlantis.Camera2D

(
  • x
  • y
  • width
  • height
)

Defined in Engine\Graphics\Camera2D.js:11

Parameters:

  • x Number

    The position on X of the camera.

  • y Number

    The position on Y of the camera.

  • width Number

    The size of the camera.

  • height Number

    The size of the camera.

Methods

follow

(
  • sprite
)

Defined in Engine\Graphics\Camera2D.js:41

Follow a sprite

Parameters:

  • sprite Atlantis.Sprite

    A sprite to follow.

getRelativePosition

(
  • sprite
)
Object

Defined in Engine\Graphics\Camera2D.js:62

Gets the relative position of a sprite relative to the camera position.

Parameters:

  • sprite Atlantis.Sprite

    The sprite to use.

Returns:

Object:

Return a structure with x and y coordinates.

getSpritePosition

() Object

Defined in Engine\Graphics\Camera2D.js:50

Gets the position of the sprite on screen relative to the camera position.

Returns:

Object:

Return a structure with x and y coordinates.

update

()

Defined in Engine\Graphics\Camera2D.js:72

Update the camera position. If a sprite is attached to it, its position is managed by the camera.