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

Property Summary

All Methods Instance Methods Concrete Methods
Type	Property and Description
`<any>`	`bumpMap` The bump map of this `PhongMaterial`, which is a normal map stored as a RGB `Image`.
`<any>`	`diffuseColor` The diffuse color of this `PhongMaterial`.
`<any>`	`diffuseMap` The diffuse map of this `PhongMaterial`.
`<any>`	`selfIlluminationMap` The self illumination map of this `PhongMaterial`.
`<any>`	`specularColor` The specular color of this `PhongMaterial`.
`<any>`	`specularMap` The specular map of this `PhongMaterial`.
`DoubleProperty`	`specularPower` The specular power of this `PhongMaterial`.

Properties inherited from class javafx.scene.paint.Material
dirtyProperty

Field Summary

Fields
Modifier and Type	Field and Description
`private <any>`	`bumpMap` The bump map of this `PhongMaterial`, which is a normal map stored as a RGB `Image`.
`private boolean`	`bumpMapDirty`
`private <any>`	`diffuseColor` The diffuse color of this `PhongMaterial`.
`private boolean`	`diffuseColorDirty`
`private <any>`	`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 <any>`	`selfIlluminationMap` The self illumination map of this `PhongMaterial`.
`private boolean`	`selfIlluminationMapDirty`
`private <any>`	`specularColor` The specular color of this `PhongMaterial`.
`private boolean`	`specularColorDirty`
`private <any>`	`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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<any>`	`bumpMapProperty()` The bump map of this `PhongMaterial`, which is a normal map stored as a RGB `Image`.
`<any>`	`diffuseColorProperty()` The diffuse color of this `PhongMaterial`.
`<any>`	`diffuseMapProperty()` The diffuse map of this `PhongMaterial`.
`Image`	`getBumpMap()` Gets the value of the property bumpMap.
`Color`	`getDiffuseColor()` Gets the value of the property diffuseColor.
`Image`	`getDiffuseMap()` Gets the value of the property diffuseMap.
`(package private) NGPhongMaterial`	`getNGMaterial()`
`Image`	`getSelfIlluminationMap()` Gets the value of the property selfIlluminationMap.
`Color`	`getSpecularColor()` Gets the value of the property specularColor.
`Image`	`getSpecularMap()` Gets the value of the property specularMap.
`double`	`getSpecularPower()` Gets the value of the property specularPower.
`<any>`	`selfIlluminationMapProperty()` The self illumination map of this `PhongMaterial`.
`void`	`setBumpMap(Image value)` Sets the value of the property bumpMap.
`void`	`setDiffuseColor(Color value)` Sets the value of the property diffuseColor.
`void`	`setDiffuseMap(Image value)` Sets the value of the property diffuseMap.
`(package private) void`	`setDirty(boolean value)`
`void`	`setSelfIlluminationMap(Image value)` Sets the value of the property selfIlluminationMap.
`void`	`setSpecularColor(Color value)` Sets the value of the property specularColor.
`void`	`setSpecularMap(Image value)` Sets the value of the property specularMap.
`void`	`setSpecularPower(double value)` Sets the value of the property specularPower.
`<any>`	`specularColorProperty()` The specular color of this `PhongMaterial`.
`<any>`	`specularMapProperty()` The specular map of this `PhongMaterial`.
`DoubleProperty`	`specularPowerProperty()` The specular power of this `PhongMaterial`.
`java.lang.String`	`toString()`
`(package private) void`	`updatePG()`

Methods inherited from class javafx.scene.paint.Material
dirtyProperty, isDirty

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

- Property Detail
  - diffuseColor
```
public final <any> diffuseColorProperty
```
    The diffuse color of this PhongMaterial.
    
    See Also:
    
    getDiffuseColor(), setDiffuseColor(Color)
  - specularColor
```
public final <any> specularColorProperty
```
    The specular color of this PhongMaterial.
    
    See Also:
    
    getSpecularColor(), setSpecularColor(Color)
  - specularPower
```
public final DoubleProperty specularPowerProperty
```
    The specular power of this PhongMaterial.
    
    See Also:
    
    getSpecularPower(), setSpecularPower(double)
  - diffuseMap
```
public final <any> diffuseMapProperty
```
    The diffuse map of this PhongMaterial.
    
    See Also:
    
    getDiffuseMap(), setDiffuseMap(Image)
  - specularMap
```
public final <any> specularMapProperty
```
    The specular map of this PhongMaterial.
    
    See Also:
    
    getSpecularMap(), setSpecularMap(Image)
  - bumpMap
```
public final <any> bumpMapProperty
```
    The bump map of this PhongMaterial, which is a normal map stored as a RGB Image.
    
    See Also:
    
    getBumpMap(), setBumpMap(Image)
  - selfIlluminationMap
```
public final <any> selfIlluminationMapProperty
```
    The self illumination map of this PhongMaterial.
    
    See Also:
    
    getSelfIlluminationMap(), setSelfIlluminationMap(Image)
- 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 <any> diffuseColor
```
    The diffuse color of this PhongMaterial.
  - specularColor
```
private <any> specularColor
```
    The specular color of this PhongMaterial.
  - specularPower
```
private DoubleProperty specularPower
```
    The specular power of this PhongMaterial.
  - platformImageChangeListener
```
private final AbstractNotifyListener platformImageChangeListener
```
  - diffuseMap
```
private <any> diffuseMap
```
    The diffuse map of this PhongMaterial.
  - oldDiffuseMap
```
private Image oldDiffuseMap
```
  - specularMap
```
private <any> specularMap
```
    The specular map of this PhongMaterial.
  - oldSpecularMap
```
private Image oldSpecularMap
```
  - bumpMap
```
private <any> bumpMap
```
    The bump map of this PhongMaterial, which is a normal map stored as a RGB Image.
  - oldBumpMap
```
private Image oldBumpMap
```
  - selfIlluminationMap
```
private <any> 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)
```
    Sets the value of the property diffuseColor.
  - getDiffuseColor
```
public final Color getDiffuseColor()
```
    Gets the value of the property diffuseColor.
  - diffuseColorProperty
```
public final <any> diffuseColorProperty()
```
    The diffuse color of this PhongMaterial.
    
    See Also:
    
    getDiffuseColor(), setDiffuseColor(Color)
  - setSpecularColor
```
public final void setSpecularColor(Color value)
```
    Sets the value of the property specularColor.
  - getSpecularColor
```
public final Color getSpecularColor()
```
    Gets the value of the property specularColor.
  - specularColorProperty
```
public final <any> specularColorProperty()
```
    The specular color of this PhongMaterial.
    
    See Also:
    
    getSpecularColor(), setSpecularColor(Color)
  - setSpecularPower
```
public final void setSpecularPower(double value)
```
    Sets the value of the property specularPower.
  - getSpecularPower
```
public final double getSpecularPower()
```
    Gets the value of the property specularPower.
  - specularPowerProperty
```
public final DoubleProperty specularPowerProperty()
```
    The specular power of this PhongMaterial.
    
    See Also:
    
    getSpecularPower(), setSpecularPower(double)
  - setDiffuseMap
```
public final void setDiffuseMap(Image value)
```
    Sets the value of the property diffuseMap.
  - getDiffuseMap
```
public final Image getDiffuseMap()
```
    Gets the value of the property diffuseMap.
  - diffuseMapProperty
```
public final <any> diffuseMapProperty()
```
    The diffuse map of this PhongMaterial.
    
    See Also:
    
    getDiffuseMap(), setDiffuseMap(Image)
  - setSpecularMap
```
public final void setSpecularMap(Image value)
```
    Sets the value of the property specularMap.
  - getSpecularMap
```
public final Image getSpecularMap()
```
    Gets the value of the property specularMap.
  - specularMapProperty
```
public final <any> specularMapProperty()
```
    The specular map of this PhongMaterial.
    
    See Also:
    
    getSpecularMap(), setSpecularMap(Image)
  - setBumpMap
```
public final void setBumpMap(Image value)
```
    Sets the value of the property bumpMap.
  - getBumpMap
```
public final Image getBumpMap()
```
    Gets the value of the property bumpMap.
  - bumpMapProperty
```
public final <any> bumpMapProperty()
```
    The bump map of this PhongMaterial, which is a normal map stored as a RGB Image.
    
    See Also:
    
    getBumpMap(), setBumpMap(Image)
  - setSelfIlluminationMap
```
public final void setSelfIlluminationMap(Image value)
```
    Sets the value of the property selfIlluminationMap.
  - getSelfIlluminationMap
```
public final Image getSelfIlluminationMap()
```
    Gets the value of the property selfIlluminationMap.
  - selfIlluminationMapProperty
```
public final <any> selfIlluminationMapProperty()
```
    The self illumination map of this PhongMaterial.
    
    See Also:
    
    getSelfIlluminationMap(), setSelfIlluminationMap(Image)
  - setDirty
```
void setDirty(boolean value)
```
    Overrides:
    
    setDirty in class Material
  - getNGMaterial
```
NGPhongMaterial getNGMaterial()
```
    Specified by:
    
    getNGMaterial in class Material
  - updatePG
```
void updatePG()
```
    Specified by:
    
    updatePG in class Material
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object

Class PhongMaterial

Property Summary

Properties inherited from class javafx.scene.paint.Material

Field Summary

Constructor Summary

Method Summary

Methods inherited from class javafx.scene.paint.Material

Methods inherited from class java.lang.Object

Property Detail

diffuseColor

specularColor

specularPower

diffuseMap

specularMap

bumpMap

selfIlluminationMap

Field Detail

diffuseColorDirty

specularColorDirty

specularPowerDirty

diffuseMapDirty

specularMapDirty

bumpMapDirty

selfIlluminationMapDirty

diffuseColor

specularColor

specularPower

platformImageChangeListener

diffuseMap

oldDiffuseMap

specularMap

oldSpecularMap

bumpMap

oldBumpMap

selfIlluminationMap

oldSelfIlluminationMap

peer

Constructor Detail

PhongMaterial

PhongMaterial

PhongMaterial

Method Detail

setDiffuseColor

getDiffuseColor

diffuseColorProperty

setSpecularColor

getSpecularColor

specularColorProperty

setSpecularPower

getSpecularPower

specularPowerProperty

setDiffuseMap

getDiffuseMap

diffuseMapProperty

setSpecularMap

getSpecularMap

specularMapProperty

setBumpMap

getBumpMap

bumpMapProperty

setSelfIlluminationMap

getSelfIlluminationMap

selfIlluminationMapProperty

setDirty

getNGMaterial

updatePG

toString