org.mini2Dx.core.engine

Interface Positionable

All Superinterfaces:

Updatable

All Known Subinterfaces:

CollisionShape

All Known Implementing Classes:

CollisionBox, CollisionCircle, CollisionPoint, CollisionPolygon, StaticCollisionBox, StaticCollisionCircle, StaticCollisionPolygon

public interface Positionable
extends Updatable

A common interface for objects that can be positioned with an x and y coordinate

Method Summary

Modifier and Type	Method and Description
<T extends Positionable> void	addPostionChangeListener(PositionChangeListener<T> listener) Adds a PositionChangeListener to be notified of coordinate changes
float	getDistanceTo(float x, float y) Returns this distance between this object's x,y coordinates and the provided xy coordinates
float	getDistanceTo(Point point) Returns this distance between this object's x,y coordinates and the provided Point's xy coordinates
float	getDistanceTo(Positionable positionable) Returns this distance between this object's x,y coordinates and the provided Positionable's xy coordinates
int	getId() Returns the unique id of this object
int	getRenderX() Returns the render x coordinate of this object
int	getRenderY() Returns the render y coordinate of this object
float	getX() Returns the x coordinate of this object
float	getY() Returns the y coordinate of this object
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
<T extends Positionable> void	removePositionChangeListener(PositionChangeListener<T> listener) Removes a PositionChangeListener to stop it being notified of coordinate changes
void	setX(float x) Sets the x coordinate of this object
void	setY(float y) Sets the y coordinate of this object

Methods inherited from interface org.mini2Dx.core.engine.Updatable

interpolate, update

Method Detail

getId

int getId()

Returns the unique id of this object

Returns:

getX

float getX()

Returns the x coordinate of this object

Returns:

0 by default

getY

float getY()

Returns the y coordinate of this object

Returns:

0 by default

setX

void setX(float x)

Sets the x coordinate of this object

Parameters:

x - The x coordinate

setY

void setY(float y)

Sets the y coordinate of this object

Parameters:

y - The y coordinate

getRenderX

int getRenderX()

Returns the render x coordinate of this object

Returns:

getRenderY

int getRenderY()

Returns the render y coordinate of this object

Returns:

getDistanceTo

float getDistanceTo(Positionable positionable)

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

Parameters:

positionable - The Positionable to retrieve the distance from

Returns:

0 if the xy coordinates are the same

getDistanceTo

float getDistanceTo(Point point)

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

Parameters:

point - The Point to retrieve the distance from

Returns:

0 if the xy coordinates are the same

getDistanceTo

float getDistanceTo(float x,
                    float y)

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

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

moveTowards

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

Moves this Positionable towards a coordinate

Parameters:

x - The target x coordinate

y - The target y coordinate

speed - The amount to move by

moveTowards

void moveTowards(Positionable positionable,
                 float speed)

Moves this Positionable towards another Positionable

Parameters:

positionable - The target Positionable

speed - The amount to move by

addPostionChangeListener

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

Adds a PositionChangeListener to be notified of coordinate changes

Parameters:

listener - The PositionChangeListener to add

removePositionChangeListener

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

Removes a PositionChangeListener to stop it being notified of coordinate changes

Parameters:

listener - The PositionChangeListener to remove