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

Record Class ConvexPolygon

java.lang.Object
java.lang.Record
technology.sola.math.geometry.ConvexPolygon
Record Components:
points - the points of the convex polygon
All Implemented Interfaces:
Shape
@NullMarked public record ConvexPolygon(Vector2D[] points) extends Record implements Shape
ConvexPolygon represents a convex polygon.

  • Constructor Summary

    Constructors
    Constructor
    Description
    ConvexPolygon(Vector2D[] points)
    Creates a convex polygon from the provided points.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    contains(Vector2D point)
    Checks if this Shape contains a point.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    float
    getArea()
    Calculates the area of this shape and return it.
    final int
    hashCode()
    Returns a hash code value for this object.
    Vector2D[]
    points()
    Returns the value of the points 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

    Methods inherited from interface technology.sola.math.geometry.Shape

    getCentroid

  • Constructor Details

    • ConvexPolygon

      public ConvexPolygon(Vector2D[] points)
      Creates a convex polygon from the provided points.
      Parameters:
      points - the points of the convex polygon
      Throws:
      IllegalArgumentException - if the provided points do not form a convex polygon

  • Method Details

    • contains

      public boolean contains(Vector2D point)
      Description copied from interface: Shape
      Checks if this Shape contains a point.
      Specified by:
      contains in interface Shape
      Parameters:
      point - the point to check
      Returns:
      true if this shape contains the point

    • getArea

      public float getArea()
      Description copied from interface: Shape
      Calculates the area of this shape and return it.
      Specified by:
      getArea in interface Shape
      Returns:
      the area of this shape

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

    • points

      public Vector2D[] points()
      Returns the value of the points record component.
      Specified by:
      points in interface Shape
      Returns:
      the value of the points record component