Package io.github.srcimon.screwbox.core

Class Rotation

java.lang.Object

io.github.srcimon.screwbox.core.Rotation

All Implemented Interfaces:

Serializable, Comparable<Rotation>

public final class Rotation
extends Object
implements Serializable, Comparable<Rotation>

Represents the Rotation between two Lines.

See Also:

• Serialized Form

Method Summary

Modifier and Type	Method	Description
Line	applyOn(Line line)	Rotates the given Line by the given Rotation around Line.from().
int	compareTo(Rotation other)
double	degrees()	Returns the degrees value of this Rotation.
static Rotation	degrees(double degrees)	Creates a new Rotation by the given degrees().
boolean	equals(Object obj)
int	hashCode()
boolean	isNone()	Checks if there isn't any rotation.
static Rotation	none()	Creates a new Rotation of zero degrees().
static Rotation	of(Line line)	Returns the Rotation between a given Line and a vertical line from the Line.from().
static Rotation	ofMomentum(double x, double y)	Returns the Rotation-value of an objects momentum.
static Rotation	ofMovement(Vector momentum)	Returns the Rotation-value of an objects momentum.
double	radians()	Returns the radians value of this Rotation.
static Rotation	random()	Creates a new random Rotation.
String	toString()

Methods inherited from class java.lang.Object

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

Method Details

degrees

public static Rotation degrees(double degrees)

Creates a new Rotation by the given degrees().

ofMomentum

public static Rotation ofMomentum(double x,
 double y)

Returns the Rotation-value of an objects momentum. This value equals the angle between a vertical line and the Vector starting on the button of this line.

See Also:

• ofMovement(Vector)

ofMovement

public static Rotation ofMovement(Vector momentum)

Returns the Rotation-value of an objects momentum. This value equals the angle between a vertical line and the Vector starting on the button of this line.

See Also:

• ofMomentum(double, double)

none

public static Rotation none()

Creates a new Rotation of zero degrees().

random

public static Rotation random()

Creates a new random Rotation.

radians

public double radians()

Returns the radians value of this Rotation.

degrees

public double degrees()

Returns the degrees value of this Rotation.

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

isNone

public boolean isNone()

Checks if there isn't any rotation.

of

public static Rotation of(Line line)

Returns the Rotation between a given Line and a vertical line from the Line.from().

Parameters:

line - the Line that is used to calculate the Rotation

applyOn

public Line applyOn(Line line)

Rotates the given Line by the given Rotation around Line.from().

Parameters:

line - the Line to be rotated

Returns:

the rotated Line

compareTo

public int compareTo(Rotation other)

Specified by:

compareTo in interface Comparable<Rotation>