com.jme3.shadow

Class DirectionalLightShadowRenderer

java.lang.Object

com.jme3.shadow.AbstractShadowRenderer

com.jme3.shadow.DirectionalLightShadowRenderer

All Implemented Interfaces:

Savable, SceneProcessor, JmeCloneable, java.lang.Cloneable

Direct Known Subclasses:

VRDirectionalLightShadowRenderer

public class DirectionalLightShadowRenderer
extends AbstractShadowRenderer

DirectionalLightShadowRenderer renderer use Parallel Split Shadow Mapping technique (pssm)
It splits the view frustum in several parts and compute a shadow map for each one.
splits are distributed so that the closer they are from the camera, the smaller they are to maximize the resolution used of the shadow map.
This results in a better quality shadow than standard shadow mapping.
for more information on this read https://developer.nvidia.com/gpugems/GPUGems3/gpugems3_ch10.html

Field Summary

Fields

Modifier and Type	Field and Description
protected float	lambda
protected DirectionalLight	light
protected Vector3f[]	points
protected Camera	shadowCam
protected ColorRGBA	splits
protected float[]	splitsArray

Fields inherited from class com.jme3.shadow.AbstractShadowRenderer

assetManager, debug, dispPic, dummyTex, edgeFilteringMode, edgesThickness, fadeInfo, fadeLength, forcedRenderState, frustumCam, lightReceivers, lightViewProjectionsMatrices, logger, matCache, nbShadowMaps, needsfallBackMaterial, postshadowMat, postTechniqueName, preshadowMat, prof, renderBackFacesShadows, renderManager, shadowCompareMode, shadowFB, shadowIntensity, shadowMapOccluders, shadowMaps, shadowMapSize, skipPostPass, viewPort, zFarOverride

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DirectionalLightShadowRenderer() Used for serialization use DirectionalLightShadowRenderer#DirectionalLightShadowRenderer(AssetManager assetManager, int shadowMapSize, int nbSplits)
	DirectionalLightShadowRenderer(AssetManager assetManager, int shadowMapSize, int nbSplits) Create a DirectionalLightShadowRenderer More info on the technique at https://developer.nvidia.com/gpugems/GPUGems3/gpugems3_ch10.html

Method Summary

Modifier and Type	Method and Description
protected boolean	checkCulling(Camera viewCam) Directional light are always in the view frustum
protected void	clearMaterialParameters(Material material) This method is called once per frame and is responsible for clearing any material parameters that subclasses may need to clear on the post material.
void	cloneFields(Cloner cloner, java.lang.Object original) Implemented to perform deep cloning for this object, resolving local cloned references using the specified cloner.
protected void	doDisplayFrustumDebug(int shadowMapIndex) responsible for displaying the frustum of the shadow cam for debug purpose
float	getLambda() returns the lambda parameter see #setLambda(float lambda)
DirectionalLight	getLight() return the light used to cast shadows
protected GeometryList	getOccludersToRender(int shadowMapIndex, GeometryList shadowMapOccluders) Returns a subclass-specific geometryList containing the occluders to be rendered in the shadow map
protected void	getReceivers(GeometryList lightReceivers)
protected Camera	getShadowCam(int shadowMapIndex) return the shadow camera to use for rendering the shadow map according the given index
protected void	initFrustumCam() delegates the initialization of the frustum cam to child renderers
boolean	isEnabledStabilization()
void	read(JmeImporter im) De-serialize this instance, for example when loading from a J3O file.
void	setEnabledStabilization(boolean stabilize) Enables the stabilization of the shadow's edges.
void	setLambda(float lambda) Adjust the repartition of the different shadow maps in the shadow extend.
void	setLight(DirectionalLight light) Sets the light to use to cast shadows
protected void	setMaterialParameters(Material material) This method is called once per frame and is responsible for setting any material parameters that subclasses may need to set on the post material.
protected void	updateShadowCams(Camera viewCam) Invoked once per frame to update the shadow cams according to the light view.
void	write(JmeExporter ex) Serialize this instance, for example when saving to a J3O file.

Methods inherited from class com.jme3.shadow.AbstractShadowRenderer

cleanup, createFrustum, displayDebug, displayFrustum, displayShadowMap, getEdgeFilteringMode, getEdgesThickness, getNumShadowMaps, getPreShadowForcedRenderState, getShadowCompareMode, getShadowIntensity, getShadowMapSize, getShadowZExtend, getShadowZFadeLength, initForcedRenderState, initialize, isFlushQueues, isInitialized, isRenderBackFacesShadows, jmeClone, postFrame, postQueue, preFrame, renderShadowMap, reshape, setEdgeFilteringMode, setEdgesThickness, setPostShadowMaterial, setPostShadowParams, setProfiler, setRenderBackFacesShadows, setShadowCompareMode, setShadowIntensity, setShadowZExtend, setShadowZFadeLength

Methods inherited from class java.lang.Object

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

Field Detail

lambda

protected float lambda

shadowCam

protected Camera shadowCam

splits

protected ColorRGBA splits

splitsArray

protected float[] splitsArray

light

protected DirectionalLight light

points

protected Vector3f[] points

Constructor Detail

DirectionalLightShadowRenderer

protected DirectionalLightShadowRenderer()

Used for serialization use DirectionalLightShadowRenderer#DirectionalLightShadowRenderer(AssetManager assetManager, int shadowMapSize, int nbSplits)

DirectionalLightShadowRenderer

public DirectionalLightShadowRenderer(AssetManager assetManager,
                                      int shadowMapSize,
                                      int nbSplits)

Create a DirectionalLightShadowRenderer More info on the technique at https://developer.nvidia.com/gpugems/GPUGems3/gpugems3_ch10.html

Parameters:

assetManager - the application asset manager

shadowMapSize - the size of the rendered shadowmaps (512,1024,2048, etc...)

nbSplits - the number of shadow maps rendered (the more shadow maps the more quality, the less fps).

Method Detail

initFrustumCam

protected void initFrustumCam()

Description copied from class: AbstractShadowRenderer

delegates the initialization of the frustum cam to child renderers

Specified by:

initFrustumCam in class AbstractShadowRenderer

getLight

public DirectionalLight getLight()

return the light used to cast shadows

Returns:

the DirectionalLight

setLight

public void setLight(DirectionalLight light)

Sets the light to use to cast shadows

Parameters:

light - a DirectionalLight

updateShadowCams

protected void updateShadowCams(Camera viewCam)

Description copied from class: AbstractShadowRenderer

Invoked once per frame to update the shadow cams according to the light view.

Specified by:

updateShadowCams in class AbstractShadowRenderer

Parameters:

viewCam - the scene cam

getOccludersToRender

protected GeometryList getOccludersToRender(int shadowMapIndex,
                                            GeometryList shadowMapOccluders)

Description copied from class: AbstractShadowRenderer

Returns a subclass-specific geometryList containing the occluders to be rendered in the shadow map

Specified by:

getOccludersToRender in class AbstractShadowRenderer

Parameters:

shadowMapIndex - the index of the shadow map being rendered

shadowMapOccluders - the list of occluders

Returns:

the geometryList

getReceivers

protected void getReceivers(GeometryList lightReceivers)

Specified by:

getReceivers in class AbstractShadowRenderer

getShadowCam

protected Camera getShadowCam(int shadowMapIndex)

Description copied from class: AbstractShadowRenderer

return the shadow camera to use for rendering the shadow map according the given index

Specified by:

getShadowCam in class AbstractShadowRenderer

Parameters:

shadowMapIndex - the index of the shadow map being rendered

Returns:

the shadowCam

doDisplayFrustumDebug

protected void doDisplayFrustumDebug(int shadowMapIndex)

Description copied from class: AbstractShadowRenderer

responsible for displaying the frustum of the shadow cam for debug purpose

Overrides:

doDisplayFrustumDebug in class AbstractShadowRenderer

Parameters:

shadowMapIndex - the index of the shadow map

setMaterialParameters

protected void setMaterialParameters(Material material)

Description copied from class: AbstractShadowRenderer

This method is called once per frame and is responsible for setting any material parameters that subclasses may need to set on the post material.

Specified by:

setMaterialParameters in class AbstractShadowRenderer

Parameters:

material - the material to use for the post shadow pass

clearMaterialParameters

protected void clearMaterialParameters(Material material)

Description copied from class: AbstractShadowRenderer

This method is called once per frame and is responsible for clearing any material parameters that subclasses may need to clear on the post material.

Specified by:

clearMaterialParameters in class AbstractShadowRenderer

Parameters:

material - the material that was used for the post shadow pass

getLambda

public float getLambda()

returns the lambda parameter see #setLambda(float lambda)

Returns:

lambda

setLambda

public void setLambda(float lambda)

Adjust the repartition of the different shadow maps in the shadow extend. Lambda is usually between 0 and 1. A low value give a more linear repartition resulting in a constant quality in the shadow over the extends, but near shadows could look very jagged. A high value give a more logarithmic repartition resulting in a high quality for near shadows, but the quality quickly decrease over the extend. The default value is 0.65 (the theoretical optimum).

Parameters:

lambda - the lambda value.

isEnabledStabilization

public boolean isEnabledStabilization()

Returns:

true if stabilization is enabled

setEnabledStabilization

public void setEnabledStabilization(boolean stabilize)

Enables the stabilization of the shadow's edges. (default is true) This prevents shadow edges from flickering when the camera moves. However it can lead to some shadow quality loss in some particular scenes.

Parameters:

stabilize - true to stabilize, false to disable stabilization

cloneFields

public void cloneFields(Cloner cloner,
                        java.lang.Object original)

Description copied from interface: JmeCloneable

Implemented to perform deep cloning for this object, resolving local cloned references using the specified cloner. The object can call cloner.clone(fieldValue) to deep clone any of its fields.

Note: during normal clone operations the original object will not be needed as the clone has already had all of the fields shallow copied.

Specified by:

cloneFields in interface JmeCloneable

Overrides:

cloneFields in class AbstractShadowRenderer

Parameters:

cloner - The cloner that is performing the cloning operation. The cloneFields method can call back into the cloner to make clones of its subordinate fields.

original - The original object from which this object was cloned. This is provided for the very rare case that this object needs to refer to its original for some reason. In general, all of the relevant values should have been transferred during the shallow clone and this object need merely clone what it wants.

read

public void read(JmeImporter im)
          throws java.io.IOException

Description copied from class: AbstractShadowRenderer

De-serialize this instance, for example when loading from a J3O file.

Specified by:

read in interface Savable

Overrides:

read in class AbstractShadowRenderer

Parameters:

im - importer (not null)

Throws:

java.io.IOException - from the importer

write

public void write(JmeExporter ex)
           throws java.io.IOException

Description copied from class: AbstractShadowRenderer

Serialize this instance, for example when saving to a J3O file.

Specified by:

write in interface Savable

Overrides:

write in class AbstractShadowRenderer

Parameters:

ex - exporter (not null)

Throws:

java.io.IOException - from the exporter

checkCulling

protected boolean checkCulling(Camera viewCam)

Directional light are always in the view frustum

Specified by:

checkCulling in class AbstractShadowRenderer

Parameters:

viewCam - a Camera to define the view frustum

Returns:

true