Package limn.render3d

Record Class Light.Spot

java.lang.Object
java.lang.Record
limn.render3d.Light.Spot
All Implemented Interfaces:
Light
Enclosing interface:
Light
public static record Light.Spot(Vec3 position, Vec3 direction, Vec3 color, float intensity, float range, float innerAngleRadians, float outerAngleRadians) extends Record implements Light
A cone light at position aimed along direction (pointing away from the light). Full intensity within innerAngleRadians, falling to zero at outerAngleRadians; range as in Light.Point.

  • Nested Class Summary

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

    Light.Directional, Light.Point, Light.Spot

  • Constructor Summary

    Constructors
    Constructor
    Description
    Spot(Vec3 position, Vec3 direction, Vec3 color, float intensity, float range, float innerAngleRadians, float outerAngleRadians)
    Creates an instance of a Spot 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
    innerAngleRadians()
    Returns the value of the innerAngleRadians record component.
    float
    intensity()
    Returns the value of the intensity record component.
    float
    outerAngleRadians()
    Returns the value of the outerAngleRadians record component.
    Vec3
    position()
    Returns the value of the position record component.
    float
    range()
    Returns the value of the range 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

  • Constructor Details

    • Spot

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

  • Method Details

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

    • position

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

    • 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

    • range

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

    • innerAngleRadians

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

    • outerAngleRadians

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