com.almasb.fxgl.entity.component

Class PositionComponent

java.lang.Object

com.almasb.fxgl.entity.Module

com.almasb.fxgl.entity.Component

com.almasb.fxgl.entity.component.PositionComponent

All Implemented Interfaces:

CopyableComponent<PositionComponent>, SerializableComponent

public class PositionComponent
extends Component
implements SerializableComponent, CopyableComponent<PositionComponent>

Component that adds a 2d position to an entity.

Author:

Almas Baimagambetov (AlmasB) (almaslvl@gmail.com)

Property Summary

Type	Property and Description
javafx.beans.property.DoubleProperty	x
javafx.beans.property.DoubleProperty	y

Constructor Summary

Constructors

Constructor and Description
PositionComponent() Constructs a position component with x = y = 0.
PositionComponent(double x, double y) Constructs a position component from given x and y.
PositionComponent(javafx.geometry.Point2D position) Constructs a position component from given point.

Method Summary

Modifier and Type	Method and Description
PositionComponent	copy() Copies this component.
double	distance(PositionComponent other)
int	getGridX(int cellSize) Note: if there is no bbox attached, entity is considered as a point, else as a rectangle with the center placed in the cell.
int	getGridY(int cellSize) Note: if there is no bbox attached, entity is considered as a point, else as a rectangle with the center placed in the cell.
javafx.geometry.Point2D	getValue()
double	getX()
double	getY()
void	read(Bundle bundle)
void	setValue(double x, double y) Set position.
void	setValue(javafx.geometry.Point2D position) Set position.
void	setX(double x) Set x.
void	setY(double y) Set y.
String	toString()
void	translate(double x, double y) Translate x and y by given values.
void	translate(javafx.geometry.Point2D vector) Translate x and y by given vector.
void	translateTowards(javafx.geometry.Point2D position, double distance)
void	translateX(double x) Translate X by given value.
void	translateY(double y) Translate Y by given value.
void	write(Bundle bundle)
javafx.beans.property.DoubleProperty	xProperty()
javafx.beans.property.DoubleProperty	yProperty()

Methods inherited from class com.almasb.fxgl.entity.Module

getEntity, onAdded, onRemoved

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Property Detail

x

public javafx.beans.property.DoubleProperty xProperty

See Also:

getX(), setX(double)

y

public javafx.beans.property.DoubleProperty yProperty

See Also:

getY(), setY(double)

Constructor Detail

PositionComponent

public PositionComponent(double x,
                         double y)

Constructs a position component from given x and y.

Parameters:

x - x coordinate

y - y coordinate

PositionComponent

public PositionComponent(javafx.geometry.Point2D position)

Constructs a position component from given point.

Parameters:

position - point

PositionComponent

public PositionComponent()

Constructs a position component with x = y = 0.

Method Detail

getX

public double getX()

Returns:

x coordinate

xProperty

public javafx.beans.property.DoubleProperty xProperty()

See Also:

getX(), setX(double)

setX

public void setX(double x)

Set x.

Parameters:

x - x coordinate

getY

public double getY()

Returns:

y coordinate

yProperty

public javafx.beans.property.DoubleProperty yProperty()

See Also:

getY(), setY(double)

setY

public void setY(double y)

Set y.

Parameters:

y - y coordinate

getValue

public javafx.geometry.Point2D getValue()

Returns:

position

setValue

public void setValue(double x,
                     double y)

Set position.

Parameters:

x - x coordinate

y - y coordinate

setValue

public void setValue(javafx.geometry.Point2D position)

Set position.

Parameters:

position - position

translateX

public void translateX(double x)

Translate X by given value.

Parameters:

x - dx

translateY

public void translateY(double y)

Translate Y by given value.

Parameters:

y - dy

translate

public void translate(double x,
                      double y)

Translate x and y by given values.

Parameters:

x - dx value

y - dy value

translate

public void translate(javafx.geometry.Point2D vector)

Translate x and y by given vector.

Parameters:

vector - translate vector

translateTowards

public void translateTowards(javafx.geometry.Point2D position,
                             double distance)

Parameters:

position - the point to move towards

distance - the distance to move

distance

public double distance(PositionComponent other)

Parameters:

other - the other component

Returns:

distance in pixels from this position to the other

getGridX

public int getGridX(int cellSize)

Note: if there is no bbox attached, entity is considered as a point, else as a rectangle with the center placed in the cell.

Parameters:

cellSize - size of each cell in the grid

Returns:

x position of the entity in the grid

getGridY

public int getGridY(int cellSize)

Note: if there is no bbox attached, entity is considered as a point, else as a rectangle with the center placed in the cell.

Parameters:

cellSize - size of each cell in the grid

Returns:

y position of the entity in the grid

toString

public String toString()

Overrides:

toString in class Object

write

public void write(@NotNull
                  Bundle bundle)

read

public void read(@NotNull
                 Bundle bundle)

copy

public PositionComponent copy()

Description copied from interface: CopyableComponent

Copies this component. The general contract should be similar to Object.clone(). The 'depth' of the copy should be determined by the user.

Specified by:

copy in interface CopyableComponent<PositionComponent>

Returns:

new instance (copy) of the component with copied values