Module com.marginallyclever.robotoverlord
Package com.marginallyclever.ro3.raypicking

Record Class RayHit

java.lang.Object
java.lang.Record
com.marginallyclever.ro3.raypicking.RayHit
Record Components:
target - the MeshInstance that the Ray intersected.
distance - the distance from the Ray origin to the point of contact.
normal - the normal of the Mesh at the point of contact, in world space.
public record RayHit(MeshInstance target, double distance, javax.vecmath.Vector3d normal) extends Record
A ray hit is a record of a ray hitting a MeshInstance at a certain distance.

  • Constructor Summary

    Constructors
    Constructor
    Description
    RayHit(MeshInstance target, double distance, javax.vecmath.Vector3d normal)
    Creates an instance of a RayHit record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    double
    distance()
    Returns the value of the distance 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.
    javax.vecmath.Vector3d
    normal()
    Returns the value of the normal record component.
    MeshInstance
    target()
    Returns the value of the target 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

    • RayHit

      public RayHit(MeshInstance target, double distance, javax.vecmath.Vector3d normal)
      Creates an instance of a RayHit record class.
      Parameters:
      target - the value for the target record component
      distance - the value for the distance record component
      normal - the value for the normal 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 '=='.
      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.

    • target

      public MeshInstance target()
      Returns the value of the target record component.
      Returns:
      the value of the target record component

    • distance

      public double distance()
      Returns the value of the distance record component.
      Returns:
      the value of the distance record component

    • normal

      public javax.vecmath.Vector3d normal()
      Returns the value of the normal record component.
      Returns:
      the value of the normal record component