com.jme3.shadow

Class DirectionalLightShadowFilter

java.lang.Object

com.jme3.post.Filter

com.jme3.shadow.AbstractShadowFilter<DirectionalLightShadowRenderer>

com.jme3.shadow.DirectionalLightShadowFilter

All Implemented Interfaces:

Savable, JmeCloneable, java.lang.Cloneable

public class DirectionalLightShadowFilter
extends AbstractShadowFilter<DirectionalLightShadowRenderer>

This Filter does basically the same as a DirectionalLightShadowRenderer except it renders the post shadow pass as a fullscreen quad pass instead of a geometry pass. It's mostly faster than PssmShadowRenderer as long as you have more than about ten shadow receiving objects. The expense is the drawback that the shadow Receive mode set on spatial is ignored. So basically all and only objects that render depth in the scene receive shadows. See this post for more details http://jmonkeyengine.org/groups/general-2/forum/topic/silly-question-about-shadow-rendering/#post-191599 API is basically the same as the PssmShadowRenderer;

Nested Class Summary

Nested classes/interfaces inherited from class com.jme3.post.Filter

Filter.Pass

Field Summary

Fields inherited from class com.jme3.shadow.AbstractShadowFilter

shadowRenderer, viewPort

Fields inherited from class com.jme3.post.Filter

defaultPass, enabled, material, postRenderPasses, processor

Constructor Summary

Constructors

Constructor and Description
DirectionalLightShadowFilter() Used for serialzation.
DirectionalLightShadowFilter(AssetManager assetManager, int shadowMapSize, int nbSplits) Creates a DirectionalLightShadowFilter Shadow Filter More info on the technique at http://http.developer.nvidia.com/GPUGems3/gpugems3_ch10.html

Method Summary

Modifier and Type	Method and Description
float	getLambda() returns the lambda parameter
DirectionalLight	getLight() return the light used to cast shadows
boolean	isEnabledStabilization() returns true if stabilization is enabled
void	read(JmeImporter im) Override this method if you want to load extra properties when the filter is loaded else only basic properties of the filter will be loaded This method should always begin by super.read(im);
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 usually goes from 0.0 to 1.0 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.
void	setLight(DirectionalLight light) Sets the light to use to cast shadows
void	write(JmeExporter ex) Override this method if you want to save extra properties when the filter is saved else only basic properties of the filter will be saved This method should always begin by super.write(ex);

Methods inherited from class com.jme3.shadow.AbstractShadowFilter

cloneFields, getEdgeFilteringMode, getEdgesThickness, getMaterial, getNumShadowMaps, getPreShadowForcedRenderState, getShadowCompareMode, getShadowIntensity, getShadowMapSize, getShadowMaterial, getShadowZExtend, getShadowZFadeLength, initFilter, isFlushQueues, isRenderBackFacesShadows, isRequiresDepthTexture, jmeClone, postFrame, postQueue, preFrame, setEdgeFilteringMode, setEdgesThickness, setRenderBackFacesShadows, setShadowCompareMode, setShadowIntensity, setShadowZExtend, setShadowZFadeLength

Methods inherited from class com.jme3.post.Filter

cleanup, cleanUpFilter, getDefaultPassDepthFormat, getDefaultPassTextureFormat, getName, getPostRenderPasses, getRenderedTexture, getRenderFrameBuffer, init, isEnabled, isRequiresBilinear, isRequiresSceneTexture, postFilter, setDepthTexture, setEnabled, setName, setProcessor, setRenderedTexture, setRenderFrameBuffer

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectionalLightShadowFilter

public DirectionalLightShadowFilter()

Used for serialzation. Use DirectionalLightShadowFilter#DirectionalLightShadowFilter (AssetManager assetManager, int shadowMapSize, int nbSplits) instead.

DirectionalLightShadowFilter

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

Creates a DirectionalLightShadowFilter Shadow Filter More info on the technique at http://http.developer.nvidia.com/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

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

getLambda

public float getLambda()

returns the lambda parameter

Returns:

lambda

See Also:

setLambda(float lambda)

setLambda

public void setLambda(float lambda)

Adjust the repartition of the different shadow maps in the shadow extend usually goes from 0.0 to 1.0 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 set to 0.65f (theoretic optimal value).

Parameters:

lambda - the lambda value.

isEnabledStabilization

public boolean isEnabledStabilization()

returns true if stabilization is enabled

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

write

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

Description copied from class: Filter

Override this method if you want to save extra properties when the filter is saved else only basic properties of the filter will be saved This method should always begin by super.write(ex);

Specified by:

write in interface Savable

Overrides:

write in class AbstractShadowFilter<DirectionalLightShadowRenderer>

Parameters:

ex - the exporter (not null)

Throws:

java.io.IOException - from the exporter

read

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

Description copied from class: Filter

Override this method if you want to load extra properties when the filter is loaded else only basic properties of the filter will be loaded This method should always begin by super.read(im);

Specified by:

read in interface Savable

Overrides:

read in class AbstractShadowFilter<DirectionalLightShadowRenderer>

Throws:

java.io.IOException