com.almasb.fxgl.entity.component

Class RotationComponent

java.lang.Object

com.almasb.fxgl.ecs.Module

com.almasb.fxgl.ecs.Component

com.almasb.fxgl.ecs.component.DoubleComponent

com.almasb.fxgl.entity.component.RotationComponent

All Implemented Interfaces:

CopyableComponent<RotationComponent>, SerializableComponent

public class RotationComponent
extends DoubleComponent
implements CopyableComponent<RotationComponent>

Adds rotation data to an entity.

Author:

Almas Baimagambetov (AlmasB) ([email protected])

Property Summary

Type	Property and Description
javafx.beans.property.DoubleProperty	angle

Properties inherited from class com.almasb.fxgl.ecs.component.DoubleComponent

valueProperty

Constructor Summary

Constructors

Constructor and Description
RotationComponent() Constructs rotation with angle = 0.
RotationComponent(double angle) Constructs rotation with given angle.

Method Summary

Modifier and Type	Method and Description
javafx.beans.property.DoubleProperty	angleProperty()
RotationComponent	copy() Copies this component.
void	rotateBy(double byAngle) Rotate entity view by given angle.
void	rotateToVector(javafx.geometry.Point2D vector) Set absolute rotation of the entity view to angle between vector and positive X axis.
String	toString()

Methods inherited from class com.almasb.fxgl.ecs.component.DoubleComponent

getValue, read, setValue, valueProperty, write

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

getEntity, onAdded, onRemoved

Methods inherited from class java.lang.Object

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

Property Detail

angle

public final javafx.beans.property.DoubleProperty angleProperty

Constructor Detail

RotationComponent

public RotationComponent()

Constructs rotation with angle = 0.

RotationComponent

public RotationComponent(double angle)

Constructs rotation with given angle.

Parameters:

angle - the angle

Method Detail

rotateBy

public final void rotateBy(double byAngle)

Rotate entity view by given angle. Note: this doesn't affect hit boxes. For more accurate collisions use PhysicsComponent.

Parameters:

byAngle - rotation angle in degrees

rotateToVector

public final void rotateToVector(javafx.geometry.Point2D vector)

Set absolute rotation of the entity view to angle between vector and positive X axis. This is useful for projectiles (bullets, arrows, etc) which rotate depending on their current velocity. Note, this assumes that at 0 angle rotation the scene view is facing right.

Parameters:

vector - the rotation vector / velocity vector

angleProperty

public final javafx.beans.property.DoubleProperty angleProperty()

toString

public String toString()

Overrides:

toString in class DoubleComponent

copy

public RotationComponent 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<RotationComponent>

Returns:

new instance (copy) of the component with copied values