Record Class RaycastHit

java.lang.Object

java.lang.Record

de.gurkenlabs.litiengine.physics.RaycastHit

Record Components:

point - the point of impact

entity - the entity hit by the raycast

distance - the distance to the point of impact

public record RaycastHit(Point2D point, ICollisionEntity entity, double distance)
extends Record

Represents the result of a raycast in the physics engine. A RaycastHit contains the point of impact, the entity hit, and the distance to the impact point.

Constructor Summary

Constructors

Constructor	Description
RaycastHit(Point2D point, ICollisionEntity entity, double distance)	Creates an instance of a RaycastHit record class.

Method Summary

Modifier and Type	Method	Description
double	distance()	Returns the value of the distance record component.
ICollisionEntity	entity()	Returns the value of the entity record component.
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.
Point2D	point()	Returns the value of the point record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

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

Constructor Details

RaycastHit

public RaycastHit(Point2D point,
 ICollisionEntity entity,
 double distance)

Creates an instance of a RaycastHit record class.

Parameters:

point - the value for the point record component

entity - the value for the entity record component

distance - the value for the distance record component

Method Details

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

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.

point

public Point2D point()

Returns the value of the point record component.

Returns:

the value of the point record component

entity

public ICollisionEntity entity()

Returns the value of the entity record component.

Returns:

the value of the entity record component

distance

public double distance()

Returns the value of the distance record component.

Returns:

the value of the distance record component