Package limn.render3d

Record Class Light.Directional

java.lang.Object
java.lang.Record
limn.render3d.Light.Directional
All Implemented Interfaces:
Light
Enclosing interface:
Light
public static record Light.Directional(Vec3 direction, Vec3 color, float intensity) extends Record implements Light
An infinitely distant light (sun): direction points toward the source.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface limn.render3d.Light

    Light.Directional, Light.Point, Light.Spot

  • Constructor Summary

    Constructors
    Constructor
    Description
    Directional(Vec3 direction, Vec3 color, float intensity)
    Creates an instance of a Directional record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    Vec3
    color()
    Returns the value of the color record component.
    Vec3
    direction()
    Returns the value of the direction record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    float
    intensity()
    Returns the value of the intensity record component.
    static Light.Directional
    of(Vec3 direction, Vec3 color)
    A light with no position; direction is where it shines towards.
    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

    • Directional

      public Directional(Vec3 direction, Vec3 color, float intensity)
      Creates an instance of a Directional record class.
      Parameters:
      direction - the value for the direction record component
      color - the value for the color record component
      intensity - the value for the intensity record component

  • Method Details

    • of

      public static Light.Directional of(Vec3 direction, Vec3 color)
      A light with no position; direction is where it shines towards.

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

    • direction

      public Vec3 direction()
      Returns the value of the direction record component.
      Returns:
      the value of the direction record component

    • color

      public Vec3 color()
      Returns the value of the color record component.
      Specified by:
      color in interface Light
      Returns:
      the value of the color record component

    • intensity

      public float intensity()
      Returns the value of the intensity record component.
      Specified by:
      intensity in interface Light
      Returns:
      the value of the intensity record component