API Docs for:
Show:

gs.GraphicObject Class

The base class of all graphical object. Each graphic object is automatically rendered and sorted by it z-value.

Constructor

gs.GraphicObject

()

Methods

dispose

()

Disposes the graphic object.

draw

()

Draws the graphic object.

initialize

() protected

Initializes the graphic object.

update

()

Updates the graphic object.

Properties

anchor

gs.Point

The anchor point. For example: An anchor-point with 0,0 rotates the object around its top-left corner but with an 0.5, 0.5 anchor-point the object rotates around its center. An anchor-point of 1,1 rotates the object around its lower-right corner. It has not effect on the object's positioning. For positioning, take a look at positionAnchor property.

disposed

Boolean

Indicates if the object is disposed. A disposed object is not rendered.

effects

gs.EffectCollection

The effect settings for different kind of visual effect like wobble, etc.

id

Number

The unique identifier of the graphic object.

index

Number

The current index in the global rendering list. This property is read-only and automatically calculated at runtime depending on z-property.

onIndexChange

Function

Fired if the graphic object's current index in the global rendering list was changed.

Default: null

ox

Number

The x-coordinate of the origin.

oy

Number

The y-coordinate of the origin.

positionAnchor

gs.Point

The position anchor point. For example: An anchor-point with 0,0 places the object with its top-left corner at its position but with an 0.5, 0.5 anchor-point the object will be placed with its center. An anchor-point of 1,1 will place the object with its lower-right corner. It has not effect on the object's rotation/zoom anchor. For that, take a look at anchor property.

transform

Mat2d

The transformation matrix of the graphic object.

visible

Boolean

Indicates if the object is rendered.

z

Number

The z-index controls rendering-order/image-overlapping. An object with a smaller z-index is rendered before an object with a larger index. For example: To make sure a graphic object is always on top of the screen, it should have the largest z-index of all graphic objects.