Package nl.colorize.multimedialib.math

Record Class Line

java.lang.Object
java.lang.Record
nl.colorize.multimedialib.math.Line
All Implemented Interfaces:
Shape
public record Line(Point2D start, Point2D end) extends Record implements Shape
Describes a straight line between two points within a two-dimensional space. Line instances can only be used to describe simple, straight lines. Use SegmentedLine to describe more complex line shapes.

  • Field Summary

    Fields inherited from interface nl.colorize.multimedialib.math.Shape

    EPSILON

  • Constructor Summary

    Constructors
    Constructor
    Description
    Line(float startX, float startY, float endX, float endY)
     
    Line(Point2D start, Point2D end)
    Creates an instance of a Line record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    contains(Point2D p)
    Returns whether this shape contains the specified point.
    Point2D
    end()
    Returns the value of the end record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    Rect
    getBoundingBox()
    Returns the smallest possible rectangular bounding box that can fit this shape.
    final int
    hashCode()
    Returns a hash code value for this object.
    Line
    reposition(Point2D offset)
    Returns a new Shape instance that is repositioned by the specified X and Y offset.
    Point2D
    start()
    Returns the value of the start record component.
    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

    Methods inherited from interface nl.colorize.multimedialib.math.Shape

    reposition

  • Constructor Details

    • Line

      public Line(float startX, float startY, float endX, float endY)

    • Line

      public Line(Point2D start, Point2D end)
      Creates an instance of a Line record class.
      Parameters:
      start - the value for the start record component
      end - the value for the end record component

  • Method Details

    • contains

      public boolean contains(Point2D p)
      Description copied from interface: Shape
      Returns whether this shape contains the specified point.
      Specified by:
      contains in interface Shape

    • getBoundingBox

      public Rect getBoundingBox()
      Description copied from interface: Shape
      Returns the smallest possible rectangular bounding box that can fit this shape.
      Specified by:
      getBoundingBox in interface Shape

    • reposition

      public Line reposition(Point2D offset)
      Description copied from interface: Shape
      Returns a new Shape instance that is repositioned by the specified X and Y offset.
      Specified by:
      reposition in interface Shape

    • toString

      public 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.

    • start

      public Point2D start()
      Returns the value of the start record component.
      Returns:
      the value of the start record component

    • end

      public Point2D end()
      Returns the value of the end record component.
      Returns:
      the value of the end record component