Module com.marginallyclever.robotoverlord

Package com.marginallyclever.convenience.helpers

Record Class RayAABBHit

java.lang.Object

java.lang.Record

com.marginallyclever.convenience.helpers.RayAABBHit

public record RayAABBHit(boolean isHit, boolean isInside, double tEnter, double tExit)
extends Record

RayAABBHit represents the result of a ray intersecting with an Axis-Aligned Bounding Box (AABB).

Constructor Summary

Constructors

Constructor	Description
RayAABBHit(boolean isHit, boolean isInside, double tEnter, double tExit)	Creates an instance of a RayAABBHit record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
static RayAABBHit	hit(boolean inside, double tEnter, double tExit)
boolean	isHit()	Returns the value of the isHit record component.
boolean	isInside()	Returns the value of the isInside record component.
static RayAABBHit	miss()
double	tEnter()	Returns the value of the tEnter record component.
double	tExit()	Returns the value of the tExit record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

RayAABBHit

public RayAABBHit(boolean isHit,
 boolean isInside,
 double tEnter,
 double tExit)

Creates an instance of a RayAABBHit record class.

Parameters:

isHit - the value for the isHit record component

isInside - the value for the isInside record component

tEnter - the value for the tEnter record component

tExit - the value for the tExit record component

Method Details

miss

public static RayAABBHit miss()

hit

public static RayAABBHit hit(boolean inside,
 double tEnter,
 double tExit)

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

isHit

public boolean isHit()

Returns the value of the isHit record component.

Returns:

the value of the isHit record component

isInside

public boolean isInside()

Returns the value of the isInside record component.

Returns:

the value of the isInside record component

tEnter

public double tEnter()

Returns the value of the tEnter record component.

Returns:

the value of the tEnter record component

tExit

public double tExit()

Returns the value of the tExit record component.

Returns:

the value of the tExit record component