Package nl.colorize.multimedialib.math

Record Class Sphere

java.lang.Object
java.lang.Record
nl.colorize.multimedialib.math.Sphere
All Implemented Interfaces:
Shape3D
public record Sphere(Point3D center, float radius) extends Record implements Shape3D
Immutable three-dimensional sphere with float precision. The sphere is defined based on the location of its center point and its radius.

  • Field Summary

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

    EPSILON

  • Constructor Summary

    Constructors
    Constructor
    Description
    Sphere(float radius)
    Creates a sphere with its center point located at the origin (0, 0, 0).
    Sphere(Point3D center, float radius)
    Creates an instance of a Sphere record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Point3D
    center()
    Returns the value of the center record component.
    boolean
    contains(Point3D point)
     
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    Box
    getBoundingBox()
    Returns the smallest possible bounding box that can fit this shape.
    Point3D
    getCenter()
     
    final int
    hashCode()
    Returns a hash code value for this object.
    float
    radius()
    Returns the value of the radius record component.
    Sphere
    reposition(Point3D offset)
    Returns a new Shape3D instance that is repositioned by the specified offset.
    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

  • Constructor Details

    • Sphere

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

    • Sphere

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

  • Method Details

    • getBoundingBox

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

    • getCenter

      public Point3D getCenter()
      Specified by:
      getCenter in interface Shape3D

    • contains

      public boolean contains(Point3D point)
      Specified by:
      contains in interface Shape3D

    • reposition

      public Sphere reposition(Point3D offset)
      Description copied from interface: Shape3D
      Returns a new Shape3D instance that is repositioned by the specified offset.
      Specified by:
      reposition in interface Shape3D

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

    • center

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