Module javafx.graphics
Package javafx.scene.effect

Class Lighting


  • public class Lighting
extends Effect
    An effect that simulates a light source shining on the given content, which can be used to give flat objects a more realistic, three-dimensional appearance.

    Example: 

    
 Light.Distant light = new Light.Distant();
 light.setAzimuth(-135.0);

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

 Text text = new Text();
 text.setText("JavaFX!");
 text.setFill(Color.STEELBLUE);
 text.setFont(Font.font(null, FontWeight.BOLD, 60));
 text.setX(10.0);
 text.setY(10.0);
 text.setTextOrigin(VPos.TOP);

 text.setEffect(lighting);

    The code above produces the following:

    The visual effect of Lighting on text

    Since:
    JavaFX 2.0

    • Constructor Detail

      • Lighting

        public Lighting​()
        Creates a new instance of Lighting with default parameters.

      • Lighting

        public Lighting​(Light light)
        Creates a new instance of Lighting with the specified light.
        Parameters:
        light - the light source for this Lighting effect
        Since:
        JavaFX 2.1

    • Method Detail

      • setLight

        public final void setLight​(Light value)
        Sets the value of the property light.
        Property description:
        The light source for this Lighting effect.

      • getLight

        public final Light getLight​()
        Gets the value of the property light.
        Property description:
        The light source for this Lighting effect.

      • setBumpInput

        public final void setBumpInput​(Effect value)
        Sets the value of the property bumpInput.
        Property description:
        The optional bump map input. If not specified, a bump map will be automatically generated from the default input. If set to null, or left unspecified, a graphical image of the Node to which the Effect is attached will be used to generate a default bump map.
        Default value:
        a Shadow effect with a radius of 10

      • getBumpInput

        public final Effect getBumpInput​()
        Gets the value of the property bumpInput.
        Property description:
        The optional bump map input. If not specified, a bump map will be automatically generated from the default input. If set to null, or left unspecified, a graphical image of the Node to which the Effect is attached will be used to generate a default bump map.
        Default value:
        a Shadow effect with a radius of 10

      • bumpInputProperty

        public final ObjectProperty<Effect> bumpInputProperty​()
        The optional bump map input. If not specified, a bump map will be automatically generated from the default input. If set to null, or left unspecified, a graphical image of the Node to which the Effect is attached will be used to generate a default bump map.
        Default value:
        a Shadow effect with a radius of 10
        See Also:
        getBumpInput(), setBumpInput(Effect)

      • setContentInput

        public final void setContentInput​(Effect value)
        Sets the value of the property contentInput.
        Property description:
        The content input for this Effect. If set to null, or left unspecified, a graphical image of the Node to which the Effect is attached will be used as the input.
        Default value:
        null

      • getContentInput

        public final Effect getContentInput​()
        Gets the value of the property contentInput.
        Property description:
        The content input for this Effect. If set to null, or left unspecified, a graphical image of the Node to which the Effect is attached will be used as the input.
        Default value:
        null

      • contentInputProperty

        public final ObjectProperty<Effect> contentInputProperty​()
        The content input for this Effect. If set to null, or left unspecified, a graphical image of the Node to which the Effect is attached will be used as the input.
        Default value:
        null
        See Also:
        getContentInput(), setContentInput(Effect)

      • setDiffuseConstant

        public final void setDiffuseConstant​(double value)
        Sets the value of the property diffuseConstant.
        Property description:
        The diffuse constant. 
               Min: 0.0
       Max: 2.0
   Default: 1.0
  Identity: n/a
        Default value:
        1.0

      • getDiffuseConstant

        public final double getDiffuseConstant​()
        Gets the value of the property diffuseConstant.
        Property description:
        The diffuse constant. 
               Min: 0.0
       Max: 2.0
   Default: 1.0
  Identity: n/a
        Default value:
        1.0

      • setSpecularConstant

        public final void setSpecularConstant​(double value)
        Sets the value of the property specularConstant.
        Property description:
        The specular constant. 
               Min: 0.0
       Max: 2.0
   Default: 0.3
  Identity: n/a
        Default value:
        0.3

      • getSpecularConstant

        public final double getSpecularConstant​()
        Gets the value of the property specularConstant.
        Property description:
        The specular constant. 
               Min: 0.0
       Max: 2.0
   Default: 0.3
  Identity: n/a
        Default value:
        0.3

      • setSpecularExponent

        public final void setSpecularExponent​(double value)
        Sets the value of the property specularExponent.
        Property description:
        The specular exponent. 
               Min:  0.0
       Max: 40.0
   Default: 20.0
  Identity:  n/a
        Default value:
        20.0

      • getSpecularExponent

        public final double getSpecularExponent​()
        Gets the value of the property specularExponent.
        Property description:
        The specular exponent. 
               Min:  0.0
       Max: 40.0
   Default: 20.0
  Identity:  n/a
        Default value:
        20.0

      • setSurfaceScale

        public final void setSurfaceScale​(double value)
        Sets the value of the property surfaceScale.
        Property description:
        The surface scale factor. 
               Min:  0.0
       Max: 10.0
   Default:  1.5
  Identity:  n/a
        Default value:
        1.5

      • getSurfaceScale

        public final double getSurfaceScale​()
        Gets the value of the property surfaceScale.
        Property description:
        The surface scale factor. 
               Min:  0.0
       Max: 10.0
   Default:  1.5
  Identity:  n/a
        Default value:
        1.5