agi.foundation.coordinates

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

Class TextureCoordinate4DF

java.lang.Object

agi.foundation.coordinates.TextureCoordinate4DF

All Implemented Interfaces:

IEquatable<TextureCoordinate4DF>, ImmutableValueType, ValueType

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

A Texture Coordinate with four parameters of type float.

Constructor Summary

Constructors

Constructor and Description
TextureCoordinate4DF() Initializes a new instance.
TextureCoordinate4DF(float[] elements) Initializes a set of TextureCoordinate4DF coordinates from the first four consecutive elements in the provided array.
TextureCoordinate4DF(float[] elements, int startIndex) Initializes a set of TextureCoordinate4DF coordinates from four consecutive elements in the provided array.
TextureCoordinate4DF(float s, float t, float p, float q) Initializes a TextureCoordinate4DF from four parameters.

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(TextureCoordinate4DF left, TextureCoordinate4DF right) Returns true if the two instances are exactly equal.
boolean	equalsEpsilon(TextureCoordinate4DF other, double epsilon) Indicates whether each coordinate parameter of another instance of this type is within the required tolerance of the corresponding coordinate parameter.
boolean	equalsType(TextureCoordinate4DF other) Indicates whether another instance of this type is exactly equal to this instance.
float	get(int index) Gets the value of the specified element with index of 0, 1, 2, and 3 corresponding to the coordinates S, T, P, and Q.
int	getLength() Gets the number of elements in this set of coordinates.
float	getP() Gets the p coordinate.
float	getQ() Gets the q coordinate.
float	getS() Gets the s coordinate.
float	getT() Gets the t coordinate.
static TextureCoordinate4DF	getZero() Gets a set of TextureCoordinate4DF parameters with values of zero.
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(TextureCoordinate4DF left, TextureCoordinate4DF 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

TextureCoordinate4DF

public TextureCoordinate4DF()

Initializes a new instance.

TextureCoordinate4DF

public TextureCoordinate4DF(float s,
                            float t,
                            float p,
                            float q)

Initializes a TextureCoordinate4DF from four parameters.

Parameters:

s - The s (x) coordinate.

t - The t (y) coordinate.

p - The p (z) coordinate.

q - The q (w) coordinate.

TextureCoordinate4DF

public TextureCoordinate4DF(@Nonnull
                            float[] elements)

Initializes a set of TextureCoordinate4DF coordinates from the first four consecutive elements in the provided array.

Parameters:

elements - The array of coordinate values.

Throws:

ArgumentNullException - The array of elements cannot be null.

ArgumentOutOfRangeException - An object of this type must be constructed from an array with at least four elements.

TextureCoordinate4DF

public TextureCoordinate4DF(@Nonnull
                            float[] elements,
                            int startIndex)

Initializes a set of TextureCoordinate4DF coordinates from four consecutive elements in the provided array.

Parameters:

elements - The array of coordinate values.

startIndex - The index of the first element in the array to use.

Throws:

ArgumentNullException - Thrown when the array of elements is null.

ArgumentOutOfRangeException - Thrown when an object of this type is constructed from an array with less than four elements.

Method Detail

getZero

@Nonnull
public static TextureCoordinate4DF getZero()

Gets a set of TextureCoordinate4DF parameters with values of zero.

getS

public final float getS()

Gets the s coordinate.

getT

public final float getT()

Gets the t coordinate.

getP

public final float getP()

Gets the p coordinate.

getQ

public final float getQ()

Gets the q coordinate.

getLength

public final int getLength()

Gets the number of elements in this set of coordinates.

get

public final float get(int index)

Gets the value of the specified element with index of 0, 1, 2, and 3 corresponding to the coordinates S, T, P, and Q.

Parameters:

index - The index to retrieve.

Returns:

The coordinate associated with the specified index.

Throws:

ArgumentOutOfRangeException - Thrown when the index is less than 0 or is equal to or greater than Length (get).

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
                                TextureCoordinate4DF other)

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

Specified by:

equalsType in interface IEquatable<TextureCoordinate4DF>

Parameters:

other - The instance to compare to this instance.

Returns:

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

equalsEpsilon

public final boolean equalsEpsilon(@Nonnull
                                   TextureCoordinate4DF other,
                                   double epsilon)

Indicates whether each coordinate parameter of another instance of this type is within the required tolerance of the corresponding coordinate parameter.

Parameters:

other - The set of TextureCoordinate4DF parameters to compare to this instance.

epsilon - The limit at which the absolute differences between the values will not be considered equal.

Returns:

true if the absolute differences are less than or equal to epsilon; 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)

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 "S, T, P, Q".

equals

public static boolean equals(@Nonnull
                             TextureCoordinate4DF left,
                             @Nonnull
                             TextureCoordinate4DF 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
                                TextureCoordinate4DF left,
                                @Nonnull
                                TextureCoordinate4DF 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.