org.mini2Dx.core.geom

Class Point

java.lang.Object

org.mini2Dx.gdx.math.Vector2

org.mini2Dx.core.geom.Point

All Implemented Interfaces:

java.io.Serializable, Positionable, org.mini2Dx.gdx.math.Vector<org.mini2Dx.gdx.math.Vector2>

Direct Known Subclasses:

CollisionPoint

public class Point
extends org.mini2Dx.gdx.math.Vector2
implements Positionable

Extends Vector2 with additional functionality

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected org.mini2Dx.gdx.utils.Array<PositionChangeListener>	positionChangeListeners

Fields inherited from class org.mini2Dx.gdx.math.Vector2

x, X, y, Y, Zero

Constructor Summary

Constructors

Constructor and Description
Point() Constructs a new Point at 0,0
Point(float x, float y) Constructs a new Point at a specific coordinate
Point(Geometry geometry) Constructs a new Point belonging to the Geometry pool
Point(Point point) Constructs a new Point with the same coordinates as another Point

Method Summary

Modifier and Type	Method and Description
org.mini2Dx.gdx.math.Vector2	add(float x, float y)
org.mini2Dx.gdx.math.Vector2	add(org.mini2Dx.gdx.math.Vector2 v)
<T extends Positionable> void	addPostionChangeListener(PositionChangeListener<T> listener) Adds a Positionable to be notified of coordinate changes
protected void	clearPositionChangeListeners()
Point	copy()
void	dispose() Releases this Point back to the Geometry pool (if it was created from the pool)
boolean	equals(float x, float y, float delta) Determines if a coordinate is nearly equal to this one.
boolean	equals(org.mini2Dx.gdx.math.Vector2 v) Determines if another Vector2 is exactly equal to this one
boolean	equals(org.mini2Dx.gdx.math.Vector2 v, float delta) Determines if this and a Vector2 are nearly equal.
float	getDistanceTo(float x, float y) Returns this distance between this object's x,y coordinates and the provided xy coordinates
float	getDistanceTo(Positionable positionable) Returns this distance between this object's x,y coordinates and the provided Positionable's xy coordinates
float	getX() Returns the x coordinate of this object
float	getY() Returns the y coordinate of this object
boolean	isOnLineBetween(Point a, Point b) Returns if this Point is between a and b on a line
void	moveTowards(float x, float y, float speed) Moves this Positionable towards a coordinate
void	moveTowards(Positionable positionable, float speed) Moves this Positionable towards another Positionable
org.mini2Dx.gdx.math.Vector2	mul(org.mini2Dx.gdx.math.Matrix3 mat)
org.mini2Dx.gdx.math.Vector2	mulAdd(org.mini2Dx.gdx.math.Vector2 vec, float scalar)
org.mini2Dx.gdx.math.Vector2	mulAdd(org.mini2Dx.gdx.math.Vector2 vec, org.mini2Dx.gdx.math.Vector2 mulVec)
protected void	notifyPositionChangeListeners()
<T extends Positionable> void	removePositionChangeListener(PositionChangeListener<T> listener) Removes a PositionChangeListener to stop it being notified of coordinate changes
void	rotateAround(float centerX, float centerY, float degrees) Rotates this Point around a coordinate
void	rotateAround(Point center, float degrees) Rotates this Point around another Point
org.mini2Dx.gdx.math.Vector2	scl(float scalar)
org.mini2Dx.gdx.math.Vector2	scl(float x, float y)
org.mini2Dx.gdx.math.Vector2	scl(org.mini2Dx.gdx.math.Vector2 v)
org.mini2Dx.gdx.math.Vector2	set(float x, float y)
org.mini2Dx.gdx.math.Vector2	set(org.mini2Dx.gdx.math.Vector2 v)
void	setX(float x) Sets the x coordinate of this object
void	setXY(float x, float y) Sets the x and y coordinate of this object
void	setY(float y) Sets the y coordinate of this object
org.mini2Dx.gdx.math.Vector2	sub(float x, float y)
org.mini2Dx.gdx.math.Vector2	sub(org.mini2Dx.gdx.math.Vector2 v)

Methods inherited from class org.mini2Dx.gdx.math.Vector2

angle, angle, angleRad, angleRad, clamp, cpy, crs, crs, dot, dot, dot, dst, dst, dst, dst2, dst2, dst2, epsilonEquals, epsilonEquals, epsilonEquals, epsilonEquals, equals, fromString, hashCode, hasOppositeDirection, hasSameDirection, interpolate, isCollinear, isCollinear, isCollinearOpposite, isCollinearOpposite, isOnLine, isOnLine, isPerpendicular, isPerpendicular, isUnit, isUnit, isZero, isZero, len, len, len2, len2, lerp, limit, limit2, nor, rotate, rotate90, rotateRad, setAngle, setAngleRad, setLength, setLength2, setToRandomDirection, setZero, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

positionChangeListeners

protected org.mini2Dx.gdx.utils.Array<PositionChangeListener> positionChangeListeners

Constructor Detail

Point

public Point(Geometry geometry)

Constructs a new Point belonging to the Geometry pool

Parameters:

geometry - The Geometry pool

Point

public Point()

Constructs a new Point at 0,0

Point

public Point(float x,
             float y)

Constructs a new Point at a specific coordinate

Parameters:

x - The x coordinate

y - The y coordinate

Point

public Point(Point point)

Constructs a new Point with the same coordinates as another Point

Parameters:

point - The Point to copy from

Method Detail

dispose

public void dispose()

Releases this Point back to the Geometry pool (if it was created from the pool)

getDistanceTo

public float getDistanceTo(float x,
                           float y)

Description copied from interface: Positionable

Returns this distance between this object's x,y coordinates and the provided xy coordinates

Specified by:

getDistanceTo in interface Positionable

Parameters:

x - The x coordinate to measure distance to

y - The y coordinate to measure distance to

Returns:

0 if the xy coordinates are the same

getDistanceTo

public float getDistanceTo(Positionable positionable)

Description copied from interface: Positionable

Returns this distance between this object's x,y coordinates and the provided Positionable's xy coordinates

Specified by:

getDistanceTo in interface Positionable

Parameters:

positionable - The Positionable to retrieve the distance from

Returns:

0 if the xy coordinates are the same

moveTowards

public void moveTowards(float x,
                        float y,
                        float speed)

Description copied from interface: Positionable

Moves this Positionable towards a coordinate

Specified by:

moveTowards in interface Positionable

Parameters:

x - The target x coordinate

y - The target y coordinate

speed - The amount to move by

moveTowards

public void moveTowards(Positionable positionable,
                        float speed)

Description copied from interface: Positionable

Moves this Positionable towards another Positionable

Specified by:

moveTowards in interface Positionable

Parameters:

positionable - The target Positionable

speed - The amount to move by

addPostionChangeListener

public <T extends Positionable> void addPostionChangeListener(PositionChangeListener<T> listener)

Description copied from interface: Positionable

Adds a Positionable to be notified of coordinate changes

Specified by:

addPostionChangeListener in interface Positionable

Parameters:

listener - The PositionChangeListener to add

See Also:

Positionable.addPostionChangeListener(PositionChangeListener)

removePositionChangeListener

public <T extends Positionable> void removePositionChangeListener(PositionChangeListener<T> listener)

Description copied from interface: Positionable

Removes a PositionChangeListener to stop it being notified of coordinate changes

Specified by:

removePositionChangeListener in interface Positionable

Parameters:

listener - The PositionChangeListener to remove

See Also:

Positionable.removePositionChangeListener(PositionChangeListener)

notifyPositionChangeListeners

protected void notifyPositionChangeListeners()

clearPositionChangeListeners

protected void clearPositionChangeListeners()

rotateAround

public void rotateAround(Point center,
                         float degrees)

Rotates this Point around another Point

Parameters:

center - The Point to rotate around

degrees - The angle to rotate by in degrees

rotateAround

public void rotateAround(float centerX,
                         float centerY,
                         float degrees)

Rotates this Point around a coordinate

Parameters:

centerX - The x coordinate to rotate around

centerY - The y coordinate to rotate around

degrees - The angle to rotate by in degrees

isOnLineBetween

public boolean isOnLineBetween(Point a,
                               Point b)

Returns if this Point is between a and b on a line

Parameters:

a - Point a on a line

b - Point b on a line

Returns:

False if this Point is not on the same line as a and b OR is not between a and b on the same line

equals

public boolean equals(org.mini2Dx.gdx.math.Vector2 v)

Determines if another Vector2 is exactly equal to this one

Parameters:

v - The Vector2 to compare to

Returns:

True if both Vector2s x and y are exactly equal

equals

public boolean equals(org.mini2Dx.gdx.math.Vector2 v,
                      float delta)

Determines if this and a Vector2 are nearly equal. A delta of 0.1 means 0.0 and 0.1 would be considered equal but 0.0 and 0.11 would not.

Parameters:

v - The Vector2 to compare to

delta - The amount of error to allow for.

Returns:

True if the two points are equal allowing for a certain margin of error

equals

public boolean equals(float x,
                      float y,
                      float delta)

Determines if a coordinate is nearly equal to this one. A delta of 0.1 means 0.0 and 0.1 would be considered equal but 0.0 and 0.11 would not.

Parameters:

x - The x coordinate

y - The y coordinate

delta - The amount of error to allow for.

Returns:

True if the two points are equal allowing for a certain margin of error

getX

public float getX()

Description copied from interface: Positionable

Returns the x coordinate of this object

Specified by:

getX in interface Positionable

Returns:

0 by default

getY

public float getY()

Description copied from interface: Positionable

Returns the y coordinate of this object

Specified by:

getY in interface Positionable

Returns:

0 by default

setX

public void setX(float x)

Description copied from interface: Positionable

Sets the x coordinate of this object

Specified by:

setX in interface Positionable

Parameters:

x - The x coordinate

setY

public void setY(float y)

Description copied from interface: Positionable

Sets the y coordinate of this object

Specified by:

setY in interface Positionable

Parameters:

y - The y coordinate

setXY

public void setXY(float x,
                  float y)

Description copied from interface: Positionable

Sets the x and y coordinate of this object

Specified by:

setXY in interface Positionable

Parameters:

x - The x coordinate

y - The y coordinate

set

public org.mini2Dx.gdx.math.Vector2 set(float x,
                                        float y)

Overrides:

set in class org.mini2Dx.gdx.math.Vector2

add

public org.mini2Dx.gdx.math.Vector2 add(float x,
                                        float y)

Overrides:

add in class org.mini2Dx.gdx.math.Vector2

sub

public org.mini2Dx.gdx.math.Vector2 sub(float x,
                                        float y)

Overrides:

sub in class org.mini2Dx.gdx.math.Vector2

mul

public org.mini2Dx.gdx.math.Vector2 mul(org.mini2Dx.gdx.math.Matrix3 mat)

Overrides:

mul in class org.mini2Dx.gdx.math.Vector2

mulAdd

public org.mini2Dx.gdx.math.Vector2 mulAdd(org.mini2Dx.gdx.math.Vector2 vec,
                                           float scalar)

Specified by:

mulAdd in interface org.mini2Dx.gdx.math.Vector<org.mini2Dx.gdx.math.Vector2>

Overrides:

mulAdd in class org.mini2Dx.gdx.math.Vector2

mulAdd

public org.mini2Dx.gdx.math.Vector2 mulAdd(org.mini2Dx.gdx.math.Vector2 vec,
                                           org.mini2Dx.gdx.math.Vector2 mulVec)

Specified by:

mulAdd in interface org.mini2Dx.gdx.math.Vector<org.mini2Dx.gdx.math.Vector2>

Overrides:

mulAdd in class org.mini2Dx.gdx.math.Vector2

scl

public org.mini2Dx.gdx.math.Vector2 scl(org.mini2Dx.gdx.math.Vector2 v)

Specified by:

scl in interface org.mini2Dx.gdx.math.Vector<org.mini2Dx.gdx.math.Vector2>

Overrides:

scl in class org.mini2Dx.gdx.math.Vector2

scl

public org.mini2Dx.gdx.math.Vector2 scl(float scalar)

Specified by:

scl in interface org.mini2Dx.gdx.math.Vector<org.mini2Dx.gdx.math.Vector2>

Overrides:

scl in class org.mini2Dx.gdx.math.Vector2

scl

public org.mini2Dx.gdx.math.Vector2 scl(float x,
                                        float y)

Overrides:

scl in class org.mini2Dx.gdx.math.Vector2

set

public org.mini2Dx.gdx.math.Vector2 set(org.mini2Dx.gdx.math.Vector2 v)

Specified by:

set in interface org.mini2Dx.gdx.math.Vector<org.mini2Dx.gdx.math.Vector2>

Overrides:

set in class org.mini2Dx.gdx.math.Vector2

add

public org.mini2Dx.gdx.math.Vector2 add(org.mini2Dx.gdx.math.Vector2 v)

Specified by:

add in interface org.mini2Dx.gdx.math.Vector<org.mini2Dx.gdx.math.Vector2>

Overrides:

add in class org.mini2Dx.gdx.math.Vector2

sub

public org.mini2Dx.gdx.math.Vector2 sub(org.mini2Dx.gdx.math.Vector2 v)

Specified by:

sub in interface org.mini2Dx.gdx.math.Vector<org.mini2Dx.gdx.math.Vector2>

Overrides:

sub in class org.mini2Dx.gdx.math.Vector2

copy

public Point copy()