Package org.anchoranalysis.spatial.orientation

Class Orientation2D

Object

Orientation

Orientation2D

All Implemented Interfaces:

Serializable

public class Orientation2D
extends Orientation

A simple angular orientation the 2D plane, relative to the x-axis.

Author:

Owen Feehan

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
Orientation2D()
Orientation2D(double angleRadians)	Creates a new Orientation2D instance.

Method Summary

Modifier and Type	Method	Description
protected boolean	canEqual(Object other)
protected RotationMatrix	deriveRotationMatrix()	Derives a RotationMatrix that can be applied to rotate an entity anti-clockwise to the current orientation.
boolean	equals(Object o)
double	getAngleDegrees()	The angle of the rotation in the 2D plane anti-clockwise, in degrees.
int	hashCode()
Orientation2D	negative()	Derives a new Orientation in the opposite (negative) direction to the current instance.
int	numberDimensions()	The dimensionality of space the orientation is valid for.
String	toString()

Methods inherited from class org.anchoranalysis.spatial.orientation.Orientation

getRotationMatrix

Methods inherited from class java.lang.Object

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

Constructor Details

Orientation2D

public Orientation2D(double angleRadians)

Creates a new Orientation2D instance.

Parameters:

angleRadians - The angle of the rotation in the 2D plane anti-clockwise, in radians.

Orientation2D

public Orientation2D()

Method Details

getAngleDegrees

public double getAngleDegrees()

The angle of the rotation in the 2D plane anti-clockwise, in degrees.

Returns:

the angle in degrees.

negative

public Orientation2D negative()

Description copied from class: Orientation

Derives a new Orientation in the opposite (negative) direction to the current instance.

A unit step from the origin in the current orientation direction, summed with a unit step in the negative direction, should end in the origin.

Specified by:

negative in class Orientation

Returns:

the new Orientation in the negative direction.

deriveRotationMatrix

protected RotationMatrix deriveRotationMatrix()

Description copied from class: Orientation

Derives a RotationMatrix that can be applied to rotate an entity anti-clockwise to the current orientation.

It presumes the existing entity has a neutral orientation along the x-axis.

Specified by:

deriveRotationMatrix in class Orientation

Returns:

the rotation-matrix.

toString

public String toString()

Overrides:

toString in class Object

numberDimensions

public int numberDimensions()

Description copied from class: Orientation

The dimensionality of space the orientation is valid for.

Specified by:

numberDimensions in class Orientation

Returns:

2 or 3.

equals

public boolean equals(Object o)

Specified by:

equals in class Orientation

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Specified by:

hashCode in class Orientation