Package nl.colorize.multimedialib.math

Record Class Circle

java.lang.Object
java.lang.Record
nl.colorize.multimedialib.math.Circle
All Implemented Interfaces:
Shape
public record Circle(Point2D center, float radius) extends Record implements Shape
Circle that is defined by its center point and a radius. Circles are immutable and are defined with float precision.

  • Field Summary

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

    EPSILON

  • Constructor Summary

    Constructors
    Constructor
    Description
    Circle(float radius)
    Creates a circle with its center point located at the origin (0, 0).
    Circle(float x, float y, float radius)
     
    Circle(Point2D center, float radius)
    Creates an instance of a Circle record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    float
    calculateDistance(Circle other)
    Returns the distance between the center of this circle and the center of the specified other circle.
    float
    calculateDistance(Point2D p)
    Returns the distance between the center of this circle and the specified point.
    Point2D
    center()
    Returns the value of the center record component.
    boolean
    contains(Point2D p)
    Returns whether this shape contains the specified point.
    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.
    Point2D
    getCenter()
     
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    intersects(Circle other)
     
    float
    radius()
    Returns the value of the radius record component.
    Circle
    reposition(Point2D offset)
    Returns a new Shape instance that is repositioned by the specified offset.
    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

    • Circle

      public Circle(Point2D center, float radius)
      Creates an instance of a Circle record class.
      Parameters:
      center - the value for the center record component
      radius - the value for the radius record component

    • Circle

      public Circle(float x, float y, float radius)

    • Circle

      public Circle(float radius)
      Creates a circle with its center point located at the origin (0, 0).

  • Method Details

    • getCenter

      public Point2D getCenter()
      Specified by:
      getCenter in interface Shape

    • 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

    • intersects

      public boolean intersects(Circle other)

    • calculateDistance

      public float calculateDistance(Point2D p)
      Returns the distance between the center of this circle and the specified point.

    • calculateDistance

      public float calculateDistance(Circle other)
      Returns the distance between the center of this circle and the center of the specified other circle.

    • 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 Circle reposition(Point2D offset)
      Description copied from interface: Shape
      Returns a new Shape instance that is repositioned by the specified 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. 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.

    • center

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

    • radius

      public float radius()
      Returns the value of the radius record component.
      Returns:
      the value of the radius record component