Enum Light.Type

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Light.Type>
    Enclosing class:
    Light

    public static enum Light.Type
    extends java.lang.Enum<Light.Type>
    Type of Light Source
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DIRECTIONAL
      Approximates an infinitely far away, purely directional light
      FOCUSED_SPOTLIGHT
      The same as a spotlight with the exception that the apparent lighting stays the same as the cone angle changes.
      POINT
      Approximates light radiating in all directions from a single point in space, where the intensity falls off with the inverse square of the distance.
      SPOTLIGHT
      Similar to a point light but radiating light in a cone rather than all directions.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static Light.Type valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Light.Type[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • POINT

        public static final Light.Type POINT
        Approximates light radiating in all directions from a single point in space, where the intensity falls off with the inverse square of the distance. Point lights have a position but no direction. Use Light.setFalloffRadius(float) to control the falloff.
      • DIRECTIONAL

        public static final Light.Type DIRECTIONAL
        Approximates an infinitely far away, purely directional light
      • SPOTLIGHT

        public static final Light.Type SPOTLIGHT
        Similar to a point light but radiating light in a cone rather than all directions. Note that as you make the cone wider, the energy is spread causing the lighting to appear dimmer. A spotlight has a position and a direction. Use Light.setInnerConeAngle(float) and Light.setOuterConeAngle(float) to control the cone size.
    • Method Detail

      • values

        public static Light.Type[] values()
        Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
        for (Light.Type c : Light.Type.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static Light.Type valueOf​(java.lang.String name)
        Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
        Parameters:
        name - the name of the enum constant to be returned.
        Returns:
        the enum constant with the specified name
        Throws:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null