agi.foundation.geometry.shapes

(agi.foundation.core-2024r3.jar)

Class PointOnCurve

java.lang.Object

agi.foundation.geometry.shapes.PointOnCurve

All Implemented Interfaces:

IEquatable<PointOnCurve>, ImmutableValueType, ValueType

public final class PointOnCurve
extends Object
implements IEquatable<PointOnCurve>, ImmutableValueType

Represents a specific point on a Curve.

Constructor Summary

Constructors

Constructor and Description
PointOnCurve() Initializes a new instance.
PointOnCurve(double fraction, double arcDistance, Cartesian point) Initializes a new instance.

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(PointOnCurve left, PointOnCurve right) Returns true if the two instances are exactly equal.
boolean	equalsType(PointOnCurve other) Indicates whether another instance of this type is exactly equal to this instance.
double	getArcDistance() Gets the actual distance along the curve at which this point occurs.
double	getFraction() Gets the fractional distance along the curve at which this point occurs.
Cartesian	getPoint() Gets the coordinates of the point on the curve.
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(PointOnCurve left, PointOnCurve right) Returns true if the two instances are not exactly equal.

Methods inherited from class java.lang.Object

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

Constructor Detail

PointOnCurve

public PointOnCurve()

Initializes a new instance.

PointOnCurve

public PointOnCurve(double fraction,
                    double arcDistance,
                    @Nonnull
                    Cartesian point)

Initializes a new instance.

Parameters:

fraction - The fractional distance along the curve at which this point occurs.

arcDistance - The real distance along the curve at which this point occurs.

point - The location of the point.

Method Detail

getFraction

public final double getFraction()

Gets the fractional distance along the curve at which this point occurs. This value is between 0.0 and 1.0.

getArcDistance

public final double getArcDistance()

Gets the actual distance along the curve at which this point occurs. This value is between 0.0 and the AngleSubtended (get) of the curve.

getPoint

@Nonnull
public final Cartesian getPoint()

Gets the coordinates of the point on the curve.

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(@Nonnull
                                PointOnCurve other)

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

Specified by:

equalsType in interface IEquatable<PointOnCurve>

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(@Nonnull
                             PointOnCurve left,
                             @Nonnull
                             PointOnCurve 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(@Nonnull
                                PointOnCurve left,
                                @Nonnull
                                PointOnCurve 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.