API Docs for: 1.0.1

Grape.Visualizer Class

Extends
Defined in: js\grape\etc\visualizer.js:2

An abstract class for visualizing different things. This class provides alpha and visible properties. It calls the visualize method with the rendering context in each render frame if visible is set to true.

Constructor

Grape.Visualizer

(
  • [opts]
)

Defined in js\grape\etc\visualizer.js:2

Parameters:

  • [opts] Object optional

    Initial values of properties

Item Index

Methods

Properties

Methods

getGame

() Grape.Game | Null

Inherited from Grape.GameObject: js\grape\game\game-object.js:96

Gets the current game instance through the current layer.

Returns:

Grape.Game | Null:

The current game, or null, if the lookup fails.

getLayer

() Grape.Layer

Inherited from Grape.GameObject: js\grape\game\game-object.js:114

Returns the layer the instance is added to.

Returns:

Grape.Layer:

The layer

getScene

() Grape.Scene | Null

Inherited from Grape.GameObject: js\grape\game\game-object.js:105

Gets the root layer.

Returns:

Grape.Scene | Null:

The root layer, or null, if the lookup fails.

onGlobal

(
  • event
  • handler
)

Inherited from Grape.GameObject: js\grape\game\game-object.js:64

Subscribes to an event on the layer the instance is added to. If the instance is not yet added to any layers, it will subscribe when added.

Parameters:

  • event String

    Event

  • handler Function

    Event listener

remove

()

Inherited from Grape.GameObject: js\grape\game\game-object.js:88

Removes the instance from the layer.

visualize

(
  • ctx
)

Defined in js\grape\etc\visualizer.js:48

This abstract method is called each render frame if visible is set to true.

Parameters:

  • ctx CanvasRenderingContext2D

    The rendering context

Properties

alpha

Number

Defined in js\grape\etc\visualizer.js:17

The alpha value set before calling the visualize method

Default: 1

visible

Number

Defined in js\grape\etc\visualizer.js:29

If set false, the visualize method is not called.

Default: true

x

Number

Inherited from Grape.Position: js\grape\etc\position.js:12

X coordinate

Default: 0

y

Number

Inherited from Grape.Position: js\grape\etc\position.js:20

Y coordinate

Default: 0