agi.foundation.graphics

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

Class PathPointBuilder

java.lang.Object

agi.foundation.graphics.PathPointBuilder

All Implemented Interfaces:

IEquatable<PathPointBuilder>

public class PathPointBuilder
extends Object
implements IEquatable<PathPointBuilder>

A mutable point used to build immutable PathPoint objects.

Constructor Summary

Constructors

Constructor and Description
PathPointBuilder() Constructs a default PathPointBuilder object.
PathPointBuilder(Cartesian position, JulianDate date) Initializes a PathPointBuilder with the given position and date.
PathPointBuilder(Cartesian position, JulianDate date, Color color) Initializes a PathPointBuilder with the given position, date, and color.
PathPointBuilder(Cartesian position, JulianDate date, Color color, float translucency) Initializes a PathPointBuilder with the given position, date, color, and translucency.
PathPointBuilder(Cartesian position, JulianDate date, Color color, float translucency, Color outlineColor) Initializes a PathPointBuilder with the given position, date, color, translucency, and outline color.
PathPointBuilder(Cartesian position, JulianDate date, Color color, float translucency, Color outlineColor, float outlineTranslucency) Initializes a PathPointBuilder with the given cartesian position, date, color, translucency, outline color, and outline translucency.
PathPointBuilder(CentralBody centralBody, Cartographic position, JulianDate date) Initializes a PathPointBuilder with the given position and date.
PathPointBuilder(CentralBody centralBody, Cartographic position, JulianDate date, Color color) Initializes a PathPointBuilder with the given position, date, and color.
PathPointBuilder(CentralBody centralBody, Cartographic position, JulianDate date, Color color, float translucency) Initializes a PathPointBuilder with the given position, date, color, and translucency.
PathPointBuilder(CentralBody centralBody, Cartographic position, JulianDate date, Color color, float translucency, Color outlineColor) Initializes a PathPointBuilder with the given position, date, color, translucency, and outline color.
PathPointBuilder(CentralBody centralBody, Cartographic position, JulianDate date, Color color, float translucency, Color outlineColor, float outlineTranslucency) Initializes a PathPointBuilder with the given cartographic 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(PathPointBuilder left, PathPointBuilder right) Returns true if the two instances are exactly equal.
boolean	equalsType(PathPointBuilder 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(PathPointBuilder left, PathPointBuilder right) Returns true if the two instances are not exactly equal.
void	setColor(Color value) Sets the color associated with this point.
void	setDate(JulianDate value) Sets the date associated with this point.
void	setOutlineColor(Color value) Sets the outline color associated with this point.
void	setOutlineTranslucency(float value) Sets the outline translucency associated with this point.
void	setPosition(Cartesian value) Sets the position associated with this point.
void	setPositionCartographic(CentralBody centralBody, Cartographic position) Sets the position of the point given in cartographic coordinates defined on a central body.
void	setTranslucency(float value) Sets the translucency associated with this point.
PathPoint	toPathPoint() Returns an immutable PathPoint object built from this object's attributes.
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

PathPointBuilder

public PathPointBuilder()

Constructs a default PathPointBuilder object.

The point's position is initialized to Zero (get), its date is initialized to MinValue (get), its color is initialized to white, its translucency is initialized to zero, its outline color is initialized to black, and its outline translucency is initialized to 0.

PathPointBuilder

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

Initializes a PathPointBuilder with the given position and date.

The point's color is initialized to white, its translucency is initialized to zero, its outline color is initialized to black, and its outline translucency is initialized to 0.

Parameters:

position - The point's position.

date - The point's date.

PathPointBuilder

public PathPointBuilder(@Nonnull
                        CentralBody centralBody,
                        @Nonnull
                        Cartographic position,
                        @Nonnull
                        JulianDate date)

Initializes a PathPointBuilder with the given position and date.

The point's color is initialized to white, its translucency is initialized to zero, its outline color is initialized to black, and its outline translucency is initialized to 0.

Parameters:

centralBody - The central body the position is defined on.

position - The point's position.

date - The point's date.

Throws:

ArgumentNullException - Thrown when centralBody is null.

PathPointBuilder

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

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

The point's translucency is initialized to zero, its outline color is initialized to black, and its outline translucency is initialized to 0.

Parameters:

position - The point's position.

date - The point's date.

color - The point's color.

PathPointBuilder

public PathPointBuilder(@Nonnull
                        CentralBody centralBody,
                        @Nonnull
                        Cartographic position,
                        @Nonnull
                        JulianDate date,
                        @Nonnull
                        Color color)

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

The point's translucency is initialized to zero, its outline color is initialized to black, and its outline translucency is initialized to 0.

Parameters:

centralBody - The central body the position is defined on.

position - The point's position.

date - The point's date.

color - The point's color.

Throws:

ArgumentNullException - Thrown when centralBody is null.

PathPointBuilder

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

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

The point's outline color is initialized to black, and its outline translucency is initialized to 0.

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.

PathPointBuilder

public PathPointBuilder(@Nonnull
                        CentralBody centralBody,
                        @Nonnull
                        Cartographic position,
                        @Nonnull
                        JulianDate date,
                        @Nonnull
                        Color color,
                        float translucency)

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

The point's outline color is initialized to black, and its outline translucency is initialized to 0.

Parameters:

centralBody - The central body the position is defined on.

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.

ArgumentNullException - Thrown when centralBody is null.

PathPointBuilder

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

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

The point's outline translucency is initialized to 0.

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.

PathPointBuilder

public PathPointBuilder(@Nonnull
                        CentralBody centralBody,
                        @Nonnull
                        Cartographic position,
                        @Nonnull
                        JulianDate date,
                        @Nonnull
                        Color color,
                        float translucency,
                        @Nonnull
                        Color outlineColor)

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

The point's outline translucency is initialized to 0.

Parameters:

centralBody - The central body the position is defined on.

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.

ArgumentNullException - Thrown when centralBody is null.

PathPointBuilder

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

Initializes a PathPointBuilder 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.

PathPointBuilder

public PathPointBuilder(@Nonnull
                        CentralBody centralBody,
                        @Nonnull
                        Cartographic position,
                        @Nonnull
                        JulianDate date,
                        @Nonnull
                        Color color,
                        float translucency,
                        @Nonnull
                        Color outlineColor,
                        float outlineTranslucency)

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

Parameters:

centralBody - The central body the position is defined on.

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.

ArgumentNullException - Thrown when centralBody is null.

Method Detail

getPosition

@Nonnull
public final Cartesian getPosition()

Gets the position associated with this point.

setPosition

public final void setPosition(@Nonnull
                              Cartesian value)

Sets the position associated with this point.

setPositionCartographic

public final void setPositionCartographic(@Nonnull
                                          CentralBody centralBody,
                                          @Nonnull
                                          Cartographic position)

Sets the position of the point given in cartographic coordinates defined on a central body.

Parameters:

centralBody - The central body the position is defined on.

position - The point's position.

Throws:

ArgumentNullException - Thrown when centralBody is null.

getDate

@Nonnull
public final JulianDate getDate()

Gets the date associated with this point.

setDate

public final void setDate(@Nonnull
                          JulianDate value)

Sets the date associated with this point.

getColor

@Nonnull
public final Color getColor()

Gets the color associated with this point.

setColor

public final void setColor(@Nonnull
                           Color value)

Sets the color associated with this point.

getTranslucency

public final float getTranslucency()

Gets the translucency associated with this point.

setTranslucency

public final void setTranslucency(float value)

Sets the translucency associated with this point.

getOutlineColor

@Nonnull
public final Color getOutlineColor()

Gets the outline color associated with this point.

setOutlineColor

public final void setOutlineColor(@Nonnull
                                  Color value)

Sets the outline color associated with this point.

getOutlineTranslucency

public final float getOutlineTranslucency()

Gets the outline translucency associated with this point.

setOutlineTranslucency

public final void setOutlineTranslucency(float value)

Sets the outline translucency associated with this point.

toPathPoint

@Nonnull
public final PathPoint toPathPoint()

Returns an immutable PathPoint object built from this object's attributes.

Returns:

An immutable PathPoint object built from this objects attributes.

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".

equalsType

public final boolean equalsType(PathPointBuilder other)

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

Specified by:

equalsType in interface IEquatable<PathPointBuilder>

Parameters:

other - The instance to compare to this instance.

Returns:

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

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

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(PathPointBuilder left,
                             PathPointBuilder 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(PathPointBuilder left,
                                PathPointBuilder 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.