Class Light

java.lang.Object

javafx.scene.effect.Light

Direct Known Subclasses:: Light.Distant, Light.Point

public abstract class Light extends Object

The abstract base class for all light implementations.

Since:: JavaFX 2.0

Property Summary

Type	Property	Description
`final ObjectProperty<Color>`	`color`	The color of the light source.

Nested Class Summary

Modifier and Type	Class	Description
`static class`	`Light.Distant`	Represents a distant light source.
`static class`	`Light.Point`	Represents a light source at a given position in 3D space.
`static class`	`Light.Spot`	Represents a spot light source at a given position in 3D space, with configurable direction and focus.

Constructor Summary

Light()

Modifier	Constructor	Description
`protected`	Creates a new Light.

Method Summary

Modifier and Type	Method	Description
`final ObjectProperty<Color>`	`colorProperty()`	The color of the light source.
`final Color`	`getColor()`	Gets the value of the `color` property.
`final void`	`setColor(Color value)`	Sets the value of the `color` property.

Methods declared in class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Property Details

color

public final ObjectProperty<Color> colorProperty

The color of the light source.

       Min: n/a
       Max: n/a
   Default: Color.WHITE
  Identity: n/a

Default value:

WHITE

See Also:

getColor()
setColor(Color)
colorProperty()

Constructor Details

Light

protected Light()

Creates a new Light.

Method Details

setColor

public final void setColor(Color value)

Sets the value of the color property.

Property description:

The color of the light source.

       Min: n/a
       Max: n/a
   Default: Color.WHITE
  Identity: n/a

Default value:

WHITE

Parameters:

value - the value for the color property

See Also:

getColor()
colorProperty()

getColor

public final Color getColor()

Gets the value of the color property.

Property description:

The color of the light source.

       Min: n/a
       Max: n/a
   Default: Color.WHITE
  Identity: n/a

Default value:

WHITE

Returns:

the value of the color property

See Also:

setColor(Color)
colorProperty()

colorProperty

public final ObjectProperty<Color> colorProperty()

The color of the light source.

       Min: n/a
       Max: n/a
   Default: Color.WHITE
  Identity: n/a

Default value:

WHITE

Returns:

the color property

See Also:

getColor()
setColor(Color)

© 2008, 2025, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from JavaFX API Documentation.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Java, JavaFX and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.