Lighting (Java FX 2.0)

java.lang.Object
- javafx.scene.effect.Effect
- - javafx.scene.effect.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.

import javafx.scene.*;
import javafx.scene.text.*;
import javafx.scene.paint.*;
import javafx.scene.effect.*;
import javafx.geometry.*;

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

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

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

t.setEffect(l);

Property Summary

Properties
Type	Property and Description
`ObjectProperty<Effect>`	`bumpInput` The optional bump map input.
`ObjectProperty<Effect>`	`contentInput` The content input for this `Effect`.
`DoubleProperty`	`diffuseConstant` The diffuse constant.
`ObjectProperty<Light>`	`light` The light source for this `Lighting` effect.
`DoubleProperty`	`specularConstant` The specular constant.
`DoubleProperty`	`specularExponent` The specular exponent.
`DoubleProperty`	`surfaceScale` The surface scale factor.

Constructor Summary

Constructors
Constructor and Description

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

Constructors
Constructor and Description
`Lighting()` Creates a new instance of Lighting with default parameters.

Method Summary

Methods
Modifier and Type	Method and Description
`ObjectProperty<Effect>`	`bumpInputProperty()` The optional bump map input.
`ObjectProperty<Effect>`	`contentInputProperty()` The content input for this `Effect`.
`DoubleProperty`	`diffuseConstantProperty()` The diffuse constant.
`Effect`	`getBumpInput()` The optional bump map input.
`Effect`	`getContentInput()` The content input for this `Effect`.
`double`	`getDiffuseConstant()` The diffuse constant.
`Light`	`getLight()` The light source for this `Lighting` effect.
`double`	`getSpecularConstant()` The specular constant.
`double`	`getSpecularExponent()` The specular exponent.
`double`	`getSurfaceScale()` The surface scale factor.
`ObjectProperty<Light>`	`lightProperty()` The light source for this `Lighting` effect.
`void`	`setBumpInput(Effect value)` The optional bump map input.
`void`	`setContentInput(Effect value)` The content input for this `Effect`.
`void`	`setDiffuseConstant(double value)` The diffuse constant.
`void`	`setLight(Light value)` The light source for this `Lighting` effect.
`void`	`setSpecularConstant(double value)` The specular constant.
`void`	`setSpecularExponent(double value)` The specular exponent.
`void`	`setSurfaceScale(double value)` The surface scale factor.
`DoubleProperty`	`specularConstantProperty()` The specular constant.
`DoubleProperty`	`specularExponentProperty()` The specular exponent.
`DoubleProperty`	`surfaceScaleProperty()` The surface scale factor.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Property Detail
  - light
    
    The light source for this Lighting effect.
    
    See Also:
    getLight(), setLight(Light)
  - bumpInput
    
    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.
    
    See Also:
    getBumpInput(), setBumpInput(Effect)
  - contentInput
    
    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.
    
    See Also:
    getContentInput(), setContentInput(Effect)
  - diffuseConstant
    The diffuse constant.
```
       Min: 0.0
       Max: 2.0
   Default: 1.0
  Identity: n/a
 
```
    See Also:
    getDiffuseConstant(), setDiffuseConstant(double)
  - specularConstant
    The specular constant.
```
       Min: 0.0
       Max: 2.0
   Default: 0.3
  Identity: n/a
 
```
    See Also:
    getSpecularConstant(), setSpecularConstant(double)
  - specularExponent
    The specular exponent.
```
       Min:  0.0
       Max: 40.0
   Default: 20.0
  Identity:  n/a
 
```
    See Also:
    getSpecularExponent(), setSpecularExponent(double)
  - surfaceScale
    The surface scale factor.
```
       Min:  0.0
       Max: 10.0
   Default:  1.5
  Identity:  n/a
 
```
    See Also:
    getSurfaceScale(), setSurfaceScale(double)
- Constructor Detail
  - Lighting
```
public Lighting()
```
    Creates a new instance of Lighting with default parameters.
- Method Detail
  - setLight
```
public final void setLight(Light value)
```
    The light source for this Lighting effect.
  - getLight
```
public final Light getLight()
```
    The light source for this Lighting effect.
  - lightProperty
```
public final ObjectProperty<Light> lightProperty()
```
    The light source for this Lighting effect.
    
    See Also:
    getLight(), setLight(Light)
  - setBumpInput
```
public final void setBumpInput(Effect value)
```
    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.
  - getBumpInput
```
public final Effect getBumpInput()
```
    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.
  - 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.
    
    See Also:
    getBumpInput(), setBumpInput(Effect)
  - setContentInput
```
public final void setContentInput(Effect value)
```
    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.
  - getContentInput
```
public final Effect getContentInput()
```
    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.
  - 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.
    
    See Also:
    getContentInput(), setContentInput(Effect)
  - setDiffuseConstant
```
public final void setDiffuseConstant(double value)
```
    The diffuse constant.
```
       Min: 0.0
       Max: 2.0
   Default: 1.0
  Identity: n/a
 
```
  - getDiffuseConstant
```
public final double getDiffuseConstant()
```
    The diffuse constant.
```
       Min: 0.0
       Max: 2.0
   Default: 1.0
  Identity: n/a
 
```
  - diffuseConstantProperty
```
public final DoubleProperty diffuseConstantProperty()
```
    The diffuse constant.
```
       Min: 0.0
       Max: 2.0
   Default: 1.0
  Identity: n/a
 
```
    See Also:
    getDiffuseConstant(), setDiffuseConstant(double)
  - setSpecularConstant
```
public final void setSpecularConstant(double value)
```
    The specular constant.
```
       Min: 0.0
       Max: 2.0
   Default: 0.3
  Identity: n/a
 
```
  - getSpecularConstant
```
public final double getSpecularConstant()
```
    The specular constant.
```
       Min: 0.0
       Max: 2.0
   Default: 0.3
  Identity: n/a
 
```
  - specularConstantProperty
```
public final DoubleProperty specularConstantProperty()
```
    The specular constant.
```
       Min: 0.0
       Max: 2.0
   Default: 0.3
  Identity: n/a
 
```
    See Also:
    getSpecularConstant(), setSpecularConstant(double)
  - setSpecularExponent
```
public final void setSpecularExponent(double value)
```
    The specular exponent.
```
       Min:  0.0
       Max: 40.0
   Default: 20.0
  Identity:  n/a
 
```
  - getSpecularExponent
```
public final double getSpecularExponent()
```
    The specular exponent.
```
       Min:  0.0
       Max: 40.0
   Default: 20.0
  Identity:  n/a
 
```
  - specularExponentProperty
```
public final DoubleProperty specularExponentProperty()
```
    The specular exponent.
```
       Min:  0.0
       Max: 40.0
   Default: 20.0
  Identity:  n/a
 
```
    See Also:
    getSpecularExponent(), setSpecularExponent(double)
  - setSurfaceScale
```
public final void setSurfaceScale(double value)
```
    The surface scale factor.
```
       Min:  0.0
       Max: 10.0
   Default:  1.5
  Identity:  n/a
 
```
  - getSurfaceScale
```
public final double getSurfaceScale()
```
    The surface scale factor.
```
       Min:  0.0
       Max: 10.0
   Default:  1.5
  Identity:  n/a
 
```
  - surfaceScaleProperty
```
public final DoubleProperty surfaceScaleProperty()
```
    The surface scale factor.
```
       Min:  0.0
       Max: 10.0
   Default:  1.5
  Identity:  n/a
 
```
    See Also:
    getSurfaceScale(), setSurfaceScale(double)

Class Lighting

Property Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Property Detail

light

bumpInput

contentInput

diffuseConstant

specularConstant

specularExponent

surfaceScale

Constructor Detail

Lighting

Method Detail

setLight

getLight

lightProperty

setBumpInput

getBumpInput

bumpInputProperty

setContentInput

getContentInput

contentInputProperty

setDiffuseConstant

getDiffuseConstant

diffuseConstantProperty

setSpecularConstant

getSpecularConstant

specularConstantProperty

setSpecularExponent

getSpecularExponent

specularExponentProperty

setSurfaceScale

getSurfaceScale

surfaceScaleProperty