Lighting

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.

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

Property Summary

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

private class Lighting.LightChangeListener
- Nested classes/interfaces inherited from class javafx.scene.effect.Effect
  Effect.EffectInputChangeListener, Effect.EffectInputProperty

Nested Classes
Modifier and Type	Class and Description
`private class`	`Lighting.LightChangeListener`

Field Summary

Fields
Modifier and Type	Field and Description
`private <any>`	`bumpInput` The optional bump map input.
`private <any>`	`contentInput` The content input for this `Effect`.
`private Light`	`defaultLight`
`private DoubleProperty`	`diffuseConstant` The diffuse constant.
`private <any>`	`light` The light source for this `Lighting` effect.
`private Lighting.LightChangeListener`	`lightChangeListener`
`private DoubleProperty`	`specularConstant` The specular constant.
`private DoubleProperty`	`specularExponent` The specular exponent.
`private DoubleProperty`	`surfaceScale` The surface scale factor.

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<any>`	`bumpInputProperty()` The optional bump map input.
`(package private) boolean`	`checkChainContains(Effect e)`
`<any>`	`contentInputProperty()` The content input for this `Effect`.
`(package private) Effect`	`copy()`
`(package private) com.sun.scenario.effect.PhongLighting`	`createPeer()`
`DoubleProperty`	`diffuseConstantProperty()` The diffuse constant.
`(package private) BaseBounds`	`getBounds(BaseBounds bounds, BaseTransform tx, Node node, BoundsAccessor boundsAccessor)` Returns bounds of given node with applied effect.
`Effect`	`getBumpInput()` Gets the value of the property bumpInput.
`Effect`	`getContentInput()` Gets the value of the property contentInput.
`double`	`getDiffuseConstant()` Gets the value of the property diffuseConstant.
`Light`	`getLight()` Gets the value of the property light.
`private Light`	`getLightInternal()`
`double`	`getSpecularConstant()` Gets the value of the property specularConstant.
`double`	`getSpecularExponent()` Gets the value of the property specularExponent.
`double`	`getSurfaceScale()` Gets the value of the property surfaceScale.
`<any>`	`lightProperty()` The light source for this `Lighting` effect.
`void`	`setBumpInput(Effect value)` Sets the value of the property bumpInput.
`void`	`setContentInput(Effect value)` Sets the value of the property contentInput.
`void`	`setDiffuseConstant(double value)` Sets the value of the property diffuseConstant.
`void`	`setLight(Light value)` Sets the value of the property light.
`void`	`setSpecularConstant(double value)` Sets the value of the property specularConstant.
`void`	`setSpecularExponent(double value)` Sets the value of the property specularExponent.
`void`	`setSurfaceScale(double value)` Sets the value of the property surfaceScale.
`DoubleProperty`	`specularConstantProperty()` The specular constant.
`DoubleProperty`	`specularExponentProperty()` The specular exponent.
`DoubleProperty`	`surfaceScaleProperty()` The surface scale factor.
`(package private) void`	`update()`

Methods inherited from class javafx.scene.effect.Effect
containsCycles, effectBoundsChanged, getInputBounds, getKernelSize, getPeer, getShadowBounds, markDirty, sync, transformBounds

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

- Property Detail
  - light
```
public final <any> lightProperty
```
    The light source for this Lighting effect.
    
    See Also:
    
    getLight(), setLight(Light)
  - bumpInput
```
public final <any> 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)
  - contentInput
```
public final <any> 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)
  - diffuseConstant
```
public final DoubleProperty diffuseConstantProperty
```
    The diffuse constant.
```
       Min: 0.0
       Max: 2.0
   Default: 1.0
  Identity: n/a
 
```
    See Also:
    
    getDiffuseConstant(), setDiffuseConstant(double)
  - specularConstant
```
public final DoubleProperty specularConstantProperty
```
    The specular constant.
```
       Min: 0.0
       Max: 2.0
   Default: 0.3
  Identity: n/a
 
```
    See Also:
    
    getSpecularConstant(), setSpecularConstant(double)
  - specularExponent
```
public final DoubleProperty specularExponentProperty
```
    The specular exponent.
```
       Min:  0.0
       Max: 40.0
   Default: 20.0
  Identity:  n/a
 
```
    See Also:
    
    getSpecularExponent(), setSpecularExponent(double)
  - surfaceScale
```
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)
- Field Detail
  - defaultLight
```
private final Light defaultLight
```
  - light
```
private <any> light
```
    The light source for this Lighting effect.
  - lightChangeListener
```
private final Lighting.LightChangeListener lightChangeListener
```
  - bumpInput
```
private <any> 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.
  - contentInput
```
private <any> 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.
  - diffuseConstant
```
private DoubleProperty diffuseConstant
```
    The diffuse constant.
```
       Min: 0.0
       Max: 2.0
   Default: 1.0
  Identity: n/a
 
```
  - specularConstant
```
private DoubleProperty specularConstant
```
    The specular constant.
```
       Min: 0.0
       Max: 2.0
   Default: 0.3
  Identity: n/a
 
```
  - specularExponent
```
private DoubleProperty specularExponent
```
    The specular exponent.
```
       Min:  0.0
       Max: 40.0
   Default: 20.0
  Identity:  n/a
 
```
  - surfaceScale
```
private DoubleProperty surfaceScale
```
    The surface scale factor.
```
       Min:  0.0
       Max: 10.0
   Default:  1.5
  Identity:  n/a
 
```
- 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
  - createPeer
```
com.sun.scenario.effect.PhongLighting createPeer()
```
    Specified by:
    
    createPeer in class Effect
  - setLight
```
public final void setLight(Light value)
```
    Sets the value of the property light.
  - getLight
```
public final Light getLight()
```
    Gets the value of the property light.
  - lightProperty
```
public final <any> lightProperty()
```
    The light source for this Lighting effect.
    
    See Also:
    
    getLight(), setLight(Light)
  - copy
```
Effect copy()
```
    Specified by:
    
    copy in class Effect
  - setBumpInput
```
public final void setBumpInput(Effect value)
```
    Sets the value of the property bumpInput.
  - getBumpInput
```
public final Effect getBumpInput()
```
    Gets the value of the property bumpInput.
  - bumpInputProperty
```
public final <any> 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)
```
    Sets the value of the property contentInput.
  - getContentInput
```
public final Effect getContentInput()
```
    Gets the value of the property contentInput.
  - contentInputProperty
```
public final <any> 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)
  - checkChainContains
```
boolean checkChainContains(Effect e)
```
    Specified by:
    
    checkChainContains in class Effect
  - setDiffuseConstant
```
public final void setDiffuseConstant(double value)
```
    Sets the value of the property diffuseConstant.
  - getDiffuseConstant
```
public final double getDiffuseConstant()
```
    Gets the value of the property diffuseConstant.
  - 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)
```
    Sets the value of the property specularConstant.
  - getSpecularConstant
```
public final double getSpecularConstant()
```
    Gets the value of the property specularConstant.
  - 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)
```
    Sets the value of the property specularExponent.
  - getSpecularExponent
```
public final double getSpecularExponent()
```
    Gets the value of the property specularExponent.
  - 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)
```
    Sets the value of the property surfaceScale.
  - getSurfaceScale
```
public final double getSurfaceScale()
```
    Gets the value of the property surfaceScale.
  - 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)
  - getLightInternal
```
private Light getLightInternal()
```
  - update
```
void update()
```
    Specified by:
    
    update in class Effect
  - getBounds
```
BaseBounds getBounds(BaseBounds bounds,
                     BaseTransform tx,
                     Node node,
                     BoundsAccessor boundsAccessor)
```
    Description copied from class: Effect
    
    Returns bounds of given node with applied effect. We *never* pass null in as a bounds. This method will NOT take a null bounds object. The returned value may be the same bounds object passed in, or it may be a new object.
    
    Specified by:
    
    getBounds in class Effect

Class Lighting

Property Summary

Nested Class Summary

Nested classes/interfaces inherited from class javafx.scene.effect.Effect

Field Summary

Constructor Summary

Method Summary

Methods inherited from class javafx.scene.effect.Effect

Methods inherited from class java.lang.Object

Property Detail

light

bumpInput

contentInput

diffuseConstant

specularConstant

specularExponent

surfaceScale

Field Detail

defaultLight

light

lightChangeListener

bumpInput

contentInput

diffuseConstant

specularConstant

specularExponent

surfaceScale

Constructor Detail

Lighting

Lighting

Method Detail

createPeer

setLight

getLight

lightProperty

copy

setBumpInput

getBumpInput

bumpInputProperty

setContentInput

getContentInput

contentInputProperty

checkChainContains

setDiffuseConstant

getDiffuseConstant

diffuseConstantProperty

setSpecularConstant

getSpecularConstant

specularConstantProperty

setSpecularExponent

getSpecularExponent

specularExponentProperty

setSurfaceScale

getSurfaceScale

surfaceScaleProperty

getLightInternal

update

getBounds