agi.foundation.graphics.advanced

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

Class BoundingSphere

java.lang.Object

agi.foundation.graphics.advanced.BoundingSphere

All Implemented Interfaces:

IEquatable<BoundingSphere>, ImmutableValueType, ValueType

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

A sphere that encapsulates an object.

Constructor Summary

Constructors

Constructor and Description
BoundingSphere() Initializes a new instance.
BoundingSphere(Cartesian center, double radius) Initializes a BoundingSphere from a center (Cartesian) and a radius (double).

Method Summary

Modifier and Type	Method and Description
static boolean	equals(BoundingSphere left, BoundingSphere right) Returns true if the two instances are exactly equal.
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
boolean	equalsEpsilon(BoundingSphere other, double epsilon) Indicates whether the center and radius of another instance of this type is within the required tolerance of the corresponding center and radius value of this instance.
boolean	equalsType(BoundingSphere other) Indicates whether another instance of this type is exactly equal to this instance.
Cartesian	getCenter() Gets the Cartesian center of the bounding sphere.
static BoundingSphere	getMaximumRadiusBoundingSphere() Gets the bounding sphere of maximum possible radius.
double	getRadius() Gets the radius of the bounding sphere.
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(BoundingSphere left, BoundingSphere 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

BoundingSphere

public BoundingSphere()

Initializes a new instance.

BoundingSphere

public BoundingSphere(@Nonnull
                      Cartesian center,
                      double radius)

Initializes a BoundingSphere from a center (Cartesian) and a radius (double).

Parameters:

center - The center of the bounding sphere.

radius - The radius of the bounding sphere.

Method Detail

getCenter

@Nonnull
public final Cartesian getCenter()

Gets the Cartesian center of the bounding sphere.

getRadius

public final double getRadius()

Gets the radius of the bounding sphere.

getMaximumRadiusBoundingSphere

@Nonnull
public static BoundingSphere getMaximumRadiusBoundingSphere()

Gets the bounding sphere of maximum possible radius.

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

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

Specified by:

equalsType in interface IEquatable<BoundingSphere>

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
                                   BoundingSphere other,
                                   double epsilon)

Indicates whether the center and radius of another instance of this type is within the required tolerance of the corresponding center and radius value of this instance.

Parameters:

other - The set of BoundingSphere parameters (center and radius) 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 "[(X, Y, Z), Radius]".

equals

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