Module javafx.graphics
Package javafx.scene.effect

Class Light.Spot

  • Enclosing class:
    Light
    public static class Light.Spot
extends Light.Point
    Represents a spot light source at a given position in 3D space, with configurable direction and focus.

    Example: 

    
 Light.Spot light = new Light.Spot();
 light.setX(150);
 light.setY(100);
 light.setZ(80);
 light.setPointsAtX(0);
 light.setPointsAtY(0);
 light.setPointsAtZ(-50);
 light.setSpecularExponent(2);

 Lighting lighting = new Lighting();
 lighting.setLight(light);
 lighting.setSurfaceScale(5.0);

 Text text = new Text();
 text.setText("Spot");
 text.setFill(Color.STEELBLUE);
 text.setFont(Font.font(null, FontWeight.BOLD, 80));
 text.setX(10.0);
 text.setY(10.0);
 text.setTextOrigin(VPos.TOP);
 text.setEffect(lighting);

 Rectangle rect = new Rectangle(200, 150);
 rect.setFill(Color.ALICEBLUE);
 rect.setEffect(lighting);

    The code above produces the following:

    The visual effect of spot Light on text

    Since:
    JavaFX 2.0

    • Constructor Detail

      • Spot

        public Spot()
        Creates a new instance of Spot light with default parameters.

      • Spot

        public Spot​(double x,
            double y,
            double z,
            double specularExponent,
            Color color)
        Creates a new instance of Spot light with the specified x, y, z, specularExponent, and color.
        Parameters:
        x - the x coordinate of the light position
        y - the y coordinate of the light position
        z - the z coordinate of the light position
        specularExponent - the specular exponent, which controls the focus of the light source
        color - the color of the light
        Since:
        JavaFX 2.1

    • Method Detail

      • setPointsAtX

        public final void setPointsAtX​(double value)
        Sets the value of the property pointsAtX.
        Property description:
        The x coordinate of the direction vector for this light. 
               Min: n/a
       Max: n/a
   Default: 0.0
  Identity: n/a
        Default value:
        0.0

      • getPointsAtX

        public final double getPointsAtX()
        Gets the value of the property pointsAtX.
        Property description:
        The x coordinate of the direction vector for this light. 
               Min: n/a
       Max: n/a
   Default: 0.0
  Identity: n/a
        Default value:
        0.0

      • setPointsAtY

        public final void setPointsAtY​(double value)
        Sets the value of the property pointsAtY.
        Property description:
        The y coordinate of the direction vector for this light. 
               Min: n/a
       Max: n/a
   Default: 0.0
  Identity: n/a
        Default value:
        0.0

      • getPointsAtY

        public final double getPointsAtY()
        Gets the value of the property pointsAtY.
        Property description:
        The y coordinate of the direction vector for this light. 
               Min: n/a
       Max: n/a
   Default: 0.0
  Identity: n/a
        Default value:
        0.0

      • setPointsAtZ

        public final void setPointsAtZ​(double value)
        Sets the value of the property pointsAtZ.
        Property description:
        The z coordinate of the direction vector for this light. 
               Min: n/a
       Max: n/a
   Default: 0.0
  Identity: n/a
        Default value:
        0.0

      • getPointsAtZ

        public final double getPointsAtZ()
        Gets the value of the property pointsAtZ.
        Property description:
        The z coordinate of the direction vector for this light. 
               Min: n/a
       Max: n/a
   Default: 0.0
  Identity: n/a
        Default value:
        0.0

      • setSpecularExponent

        public final void setSpecularExponent​(double value)
        Sets the value of the property specularExponent.
        Property description:
        The specular exponent, which controls the focus of this light source. 
               Min: 0.0
       Max: 4.0
   Default: 1.0
  Identity: 1.0
        Default value:
        1.0

      • getSpecularExponent

        public final double getSpecularExponent()
        Gets the value of the property specularExponent.
        Property description:
        The specular exponent, which controls the focus of this light source. 
               Min: 0.0
       Max: 4.0
   Default: 1.0
  Identity: 1.0
        Default value:
        1.0