Module technology.sola.engine
Package technology.sola.math.geometry

Record Class Line

java.lang.Object
java.lang.Record
technology.sola.math.geometry.Line
Record Components:
p1 - the first point of the line
p2 - the second point of the line
@NullMarked public record Line(Vector2D p1, Vector2D p2) extends Record
Line represents a geometric line with two points.

  • Constructor Details

    • Line

      public Line(Vector2D p1, Vector2D p2)
      Creates an instance of a Line record class.
      Parameters:
      p1 - the value for the p1 record component
      p2 - the value for the p2 record component

  • Method Details

    • closestPointOnLine

      public Vector2D closestPointOnLine(Vector2D targetPoint)
      Calculates the closest point on this line to the desired target point.
      Parameters:
      targetPoint - the target point
      Returns:
      the closest point on the line to the target point

    • 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 Objects::equals(Object,Object).
      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.

    • p1

      public Vector2D p1()
      Returns the value of the p1 record component.
      Returns:
      the value of the p1 record component

    • p2

      public Vector2D p2()
      Returns the value of the p2 record component.
      Returns:
      the value of the p2 record component