javafx.scene.paint

Class PhongMaterial

java.lang.Object

javafx.scene.paint.Material

javafx.scene.paint.PhongMaterial

public class PhongMaterial
extends Material

The PhongMaterial class provides definitions of properties that represent a Phong shaded material. It describes the interaction of light with the surface of the Mesh it is applied to. The PhongMaterial reflects light in terms of a diffuse and specular component together with an ambient and a self illumination term. The color of a point on a geometric surface is mathematical function of these four components.

The color is computed by the following equation:

 for each ambient light source i {
     ambient += lightColor[i]
 }

 for each point light source i {
     diffuse += (L[i] . N) * lightColor[i]
     specular += ((R[i] . V) ^ (specularPower * intensity(specularMap))) * lightColor[i]
 }

 color = (ambient + diffuse) * diffuseColor * diffuseMap
             + specular * specularColor * specularMap
             + selfIlluminationMap
 

where lightColor[i] is the color of light source i,
L[i] is the vector from the surface to light source i,
N is the normal vector (taking into the account the bumpMap if present),
R[i] is the normalized reflection vector for L[i] about the surface normal,
and V is the normalized view vector.

Since:

JavaFX 8.0

See Also:

AmbientLight, PointLight

Field Summary

Fields

Modifier and Type	Field and Description
private ObjectProperty<Image>	bumpMap The bump map of this PhongMaterial, which is a normal map stored as a RGB Image.
private boolean	bumpMapDirty
private ObjectProperty<Color>	diffuseColor The diffuse color of this PhongMaterial.
private boolean	diffuseColorDirty
private ObjectProperty<Image>	diffuseMap The diffuse map of this PhongMaterial.
private boolean	diffuseMapDirty
private Image	oldBumpMap
private Image	oldDiffuseMap
private Image	oldSelfIlluminationMap
private Image	oldSpecularMap
private NGPhongMaterial	peer The peer node created by the graphics Toolkit/Pipeline implementation
private AbstractNotifyListener	platformImageChangeListener
private ObjectProperty<Image>	selfIlluminationMap The self illumination map of this PhongMaterial.
private boolean	selfIlluminationMapDirty
private ObjectProperty<Color>	specularColor The specular color of this PhongMaterial.
private boolean	specularColorDirty
private ObjectProperty<Image>	specularMap The specular map of this PhongMaterial.
private boolean	specularMapDirty
private DoubleProperty	specularPower The specular power of this PhongMaterial.
private boolean	specularPowerDirty

Constructor Summary

Constructors

Constructor and Description
PhongMaterial() Creates a new instance of PhongMaterial class with a default Color.WHITE diffuseColor property.
PhongMaterial(Color diffuseColor) Creates a new instance of PhongMaterial class using the specified color for its diffuseColor property.
PhongMaterial(Color diffuseColor, Image diffuseMap, Image specularMap, Image bumpMap, Image selfIlluminationMap) Creates a new instance of PhongMaterial class using the specified colors and images for its diffuseColor properties.

Method Summary

Modifier and Type	Method and Description
ObjectProperty<Image>	bumpMapProperty()
ObjectProperty<Color>	diffuseColorProperty()
ObjectProperty<Image>	diffuseMapProperty()
Image	getBumpMap()
Color	getDiffuseColor()
Image	getDiffuseMap()
Image	getSelfIlluminationMap()
Color	getSpecularColor()
Image	getSpecularMap()
double	getSpecularPower()
NGPhongMaterial	impl_getNGMaterial() Deprecated. This is an internal API that is not intended for use and will be removed in the next version
void	impl_updatePG() Deprecated. This is an internal API that is not intended for use and will be removed in the next version
ObjectProperty<Image>	selfIlluminationMapProperty()
void	setBumpMap(Image value)
void	setDiffuseColor(Color value)
void	setDiffuseMap(Image value)
(package private) void	setDirty(boolean value)
void	setSelfIlluminationMap(Image value)
void	setSpecularColor(Color value)
void	setSpecularMap(Image value)
void	setSpecularPower(double value)
ObjectProperty<Color>	specularColorProperty()
ObjectProperty<Image>	specularMapProperty()
DoubleProperty	specularPowerProperty()
java.lang.String	toString()

Methods inherited from class javafx.scene.paint.Material

impl_dirtyProperty, isDirty

Methods inherited from class java.lang.Object

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

Field Detail

diffuseColorDirty

private boolean diffuseColorDirty

specularColorDirty

private boolean specularColorDirty

specularPowerDirty

private boolean specularPowerDirty

diffuseMapDirty

private boolean diffuseMapDirty

specularMapDirty

private boolean specularMapDirty

bumpMapDirty

private boolean bumpMapDirty

selfIlluminationMapDirty

private boolean selfIlluminationMapDirty

diffuseColor

private ObjectProperty<Color> diffuseColor

The diffuse color of this PhongMaterial.

specularColor

private ObjectProperty<Color> specularColor

The specular color of this PhongMaterial.

specularPower

private DoubleProperty specularPower

The specular power of this PhongMaterial.

platformImageChangeListener

private final AbstractNotifyListener platformImageChangeListener

diffuseMap

private ObjectProperty<Image> diffuseMap

The diffuse map of this PhongMaterial.

oldDiffuseMap

private Image oldDiffuseMap

specularMap

private ObjectProperty<Image> specularMap

The specular map of this PhongMaterial.

oldSpecularMap

private Image oldSpecularMap

bumpMap

private ObjectProperty<Image> bumpMap

The bump map of this PhongMaterial, which is a normal map stored as a RGB Image.

oldBumpMap

private Image oldBumpMap

selfIlluminationMap

private ObjectProperty<Image> selfIlluminationMap

The self illumination map of this PhongMaterial.

oldSelfIlluminationMap

private Image oldSelfIlluminationMap

peer

private NGPhongMaterial peer

The peer node created by the graphics Toolkit/Pipeline implementation

Constructor Detail

PhongMaterial

public PhongMaterial()

Creates a new instance of PhongMaterial class with a default Color.WHITE diffuseColor property.

PhongMaterial

public PhongMaterial(Color diffuseColor)

Creates a new instance of PhongMaterial class using the specified color for its diffuseColor property.

Parameters:

diffuseColor - the color of the diffuseColor property

PhongMaterial

public PhongMaterial(Color diffuseColor,
                     Image diffuseMap,
                     Image specularMap,
                     Image bumpMap,
                     Image selfIlluminationMap)

Creates a new instance of PhongMaterial class using the specified colors and images for its diffuseColor properties.

Parameters:

diffuseColor - the color of the diffuseColor property

diffuseMap - the image of the diffuseMap property

specularMap - the image of the specularMap property

bumpMap - the image of the bumpMap property

selfIlluminationMap - the image of the selfIlluminationMap property

Method Detail

setDiffuseColor

public final void setDiffuseColor(Color value)

getDiffuseColor

public final Color getDiffuseColor()

diffuseColorProperty

public final ObjectProperty<Color> diffuseColorProperty()

setSpecularColor

public final void setSpecularColor(Color value)

getSpecularColor

public final Color getSpecularColor()

specularColorProperty

public final ObjectProperty<Color> specularColorProperty()

setSpecularPower

public final void setSpecularPower(double value)

getSpecularPower

public final double getSpecularPower()

specularPowerProperty

public final DoubleProperty specularPowerProperty()

setDiffuseMap

public final void setDiffuseMap(Image value)

getDiffuseMap

public final Image getDiffuseMap()

diffuseMapProperty

public final ObjectProperty<Image> diffuseMapProperty()

setSpecularMap

public final void setSpecularMap(Image value)

getSpecularMap

public final Image getSpecularMap()

specularMapProperty

public final ObjectProperty<Image> specularMapProperty()

setBumpMap

public final void setBumpMap(Image value)

getBumpMap

public final Image getBumpMap()

bumpMapProperty

public final ObjectProperty<Image> bumpMapProperty()

setSelfIlluminationMap

public final void setSelfIlluminationMap(Image value)

getSelfIlluminationMap

public final Image getSelfIlluminationMap()

selfIlluminationMapProperty

public final ObjectProperty<Image> selfIlluminationMapProperty()

setDirty

void setDirty(boolean value)

Overrides:

setDirty in class Material

impl_getNGMaterial

@Deprecated
public NGPhongMaterial impl_getNGMaterial()

Deprecated. This is an internal API that is not intended for use and will be removed in the next version

Specified by:

impl_getNGMaterial in class Material

impl_updatePG

@Deprecated
public void impl_updatePG()

Deprecated. This is an internal API that is not intended for use and will be removed in the next version

Specified by:

impl_updatePG in class Material

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object