agi.foundation.graphics

(agi.foundation.graphics-2024r1.jar)

Class PathPoint

java.lang.Object

agi.foundation.graphics.PathPoint

All Implemented Interfaces:

IEquatable<PathPoint>

public class PathPoint
extends Object
implements IEquatable<PathPoint>

An immutable point defined by a position and a date. Also contains display properties such as color and translucency.

Constructor Summary

Constructors

Constructor and Description
PathPoint(Cartesian position, JulianDate date) Initializes a PathPoint with the given position and date.
PathPoint(Cartesian position, JulianDate date, Color color) Initializes a PathPoint with the given position, date, and color.
PathPoint(Cartesian position, JulianDate date, Color color, float translucency) Initializes a PathPoint with the given position, date, color, and translucency.
PathPoint(Cartesian position, JulianDate date, Color color, float translucency, Color outlineColor) Initializes a PathPoint with the given position, date, color, translucency, and outline color.
PathPoint(Cartesian position, JulianDate date, Color color, float translucency, Color outlineColor, float outlineTranslucency) Initializes a PathPoint with the given cartesian position, date, color, translucency, outline color, and outline translucency.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
static boolean	equals(PathPoint left, PathPoint right) Returns true if the two instances are exactly equal.
boolean	equalsType(PathPoint other) Indicates whether another instance of this type is exactly equal to this instance.
Color	getColor() Gets the color associated with this point.
JulianDate	getDate() Gets the date associated with this point.
Color	getOutlineColor() Gets the outline color associated with this point.
float	getOutlineTranslucency() Gets the outline translucency associated with this point.
Cartesian	getPosition() Gets the position associated with this point.
float	getTranslucency() Gets the translucency associated with this point.
int	hashCode() Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
static boolean	notEquals(PathPoint left, PathPoint right) Returns true if the two instances are not exactly equal.
String	toString() Returns the string representation of the value of this instance.

Methods inherited from class java.lang.Object

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

Constructor Detail

PathPoint

public PathPoint(@Nonnull
                 Cartesian position,
                 @Nonnull
                 JulianDate date)

Initializes a PathPoint with the given position and date.

The point's color is initialized to white and its translucency is initialized to zero.

Parameters:

position - The point's position.

date - The point's date.

PathPoint

public PathPoint(@Nonnull
                 Cartesian position,
                 @Nonnull
                 JulianDate date,
                 @Nonnull
                 Color color)

Initializes a PathPoint with the given position, date, and color.

The point's translucency is initialized to zero.

Parameters:

position - The point's position.

date - The point's date.

color - The point's color.

PathPoint

public PathPoint(@Nonnull
                 Cartesian position,
                 @Nonnull
                 JulianDate date,
                 @Nonnull
                 Color color,
                 float translucency)

Initializes a PathPoint with the given position, date, color, and translucency.

Parameters:

position - The point's position.

date - The point's date.

color - The point's color.

translucency - The point's translucency.

Throws:

ArgumentOutOfRangeException - Thrown when translucency is less than 0 or greater than 1.

PathPoint

public PathPoint(@Nonnull
                 Cartesian position,
                 @Nonnull
                 JulianDate date,
                 @Nonnull
                 Color color,
                 float translucency,
                 @Nonnull
                 Color outlineColor)

Initializes a PathPoint with the given position, date, color, translucency, and outline color.

Parameters:

position - The point's position.

date - The point's date.

color - The point's color.

translucency - The point's translucency.

outlineColor - The point's outline color.

Throws:

ArgumentOutOfRangeException - Thrown when translucency is less than 0 or greater than 1.

PathPoint

public PathPoint(@Nonnull
                 Cartesian position,
                 @Nonnull
                 JulianDate date,
                 @Nonnull
                 Color color,
                 float translucency,
                 @Nonnull
                 Color outlineColor,
                 float outlineTranslucency)

Initializes a PathPoint with the given cartesian position, date, color, translucency, outline color, and outline translucency.

Parameters:

position - The point's position.

date - The point's date.

color - The point's color.

translucency - The point's translucency.

outlineColor - The point's outline color.

outlineTranslucency - The point's outline translucency.

Throws:

ArgumentOutOfRangeException - Thrown when translucency or outlineTranslucency is less than 0 or greater than 1.

Method Detail

getPosition

@Nonnull
public final Cartesian getPosition()

Gets the position associated with this point.

getDate

@Nonnull
public final JulianDate getDate()

Gets the date associated with this point.

getColor

@Nonnull
public final Color getColor()

Gets the color associated with this point.

getTranslucency

public final float getTranslucency()

Gets the translucency associated with this point.

getOutlineColor

@Nonnull
public final Color getOutlineColor()

Gets the outline color associated with this point.

getOutlineTranslucency

public final float getOutlineTranslucency()

Gets the outline translucency associated with this point.

toString

public String toString()

Returns the string representation of the value of this instance.

Overrides:

toString in class Object

Returns:

A string that represents the value of this instance in the form "Position: xxx, Date: xxx, Color: xxx, Translucency: xxx, Outline Color: xxx, Outline Translucency: xxx".

equals

public boolean equals(Object obj)

Indicates whether another object is exactly equal to this instance.

Overrides:

equals in class Object

Parameters:

obj - The object to compare to this instance.

Returns:

true if obj is an instance of this type and represents the same value as this instance; otherwise false.

See Also:

Object.hashCode(), HashMap

equalsType

public final boolean equalsType(PathPoint other)

Indicates whether another instance of this type is exactly equal to this instance.

Specified by:

equalsType in interface IEquatable<PathPoint>

Parameters:

other - The instance to compare to this instance.

Returns:

true if other represents the same value as this instance; otherwise false.

hashCode

public int hashCode()

Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.

Overrides:

hashCode in class Object

Returns:

A hash code for the current object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

equals

public static boolean equals(PathPoint left,
                             PathPoint right)

Returns true if the two instances are exactly equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left represents the same value as right; otherwise false.

notEquals

public static boolean notEquals(PathPoint left,
                                PathPoint right)

Returns true if the two instances are not exactly equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left does not represent the same value as right; otherwise false.