PixiJS

Class: ObservablePoint

PIXI.ObservablePoint

The Point object represents a location in a two-dimensional coordinate system, where x represents the horizontal axis and y represents the vertical axis. An observable point is a point that triggers a callback when the point's position is changed.

new PIXI.ObservablePoint (cb, scope, x, y)

ObservablePoint.js:11
Name Type Default Description
cb function

callback when changed
scope object

owner of callback
x number 0 optional

position of the point on the x axis
y number 0 optional

position of the point on the y axis

Members

x number

The position of the displayObject on the x axis relative to the local coordinates of the parent.

y number

The position of the displayObject on the x axis relative to the local coordinates of the parent.

Methods

clone (cb, scope)PIXI.ObservablePoint

ObservablePoint.js:38

Creates a clone of this point. The callback and scope params can be overidden otherwise they will default to the clone object's values.

Name Type Default Description
cb function null optional

callback when changed
scope object null optional

owner of callback
Returns:
Type Description
PIXI.ObservablePoint a copy of the point

copy (point)

ObservablePoint.js:71

Copies the data from another point

Name Type Description
point PIXI.Point | PIXI.ObservablePoint

point to copy from

equals (p)boolean

ObservablePoint.js:87

Returns true if the given point is equal to this point

Name Type Description
p PIXI.Point | PIXI.ObservablePoint

The point to check
Returns:
Type Description
boolean Whether the given point equal to this point

set (x, y)

ObservablePoint.js:53

Sets the point to a new x and y position. If y is omitted, both x and y will be set to x.

Name Type Default Description
x number 0 optional

position of the point on the x axis
y number 0 optional

position of the point on the y axis