com.jme3.shadow

Class SpotLightShadowFilter

java.lang.Object

com.jme3.post.Filter

com.jme3.shadow.AbstractShadowFilter<SpotLightShadowRenderer>

com.jme3.shadow.SpotLightShadowFilter

All Implemented Interfaces:

Savable, JmeCloneable, java.lang.Cloneable

public class SpotLightShadowFilter
extends AbstractShadowFilter<SpotLightShadowRenderer>

This Filter does basically the same as a SpotLightShadowRenderer 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

Modifier	Constructor and Description
protected	SpotLightShadowFilter() Used for serialization.
	SpotLightShadowFilter(AssetManager assetManager, int shadowMapSize) Creates a SpotLight Shadow Filter

Method Summary

Modifier and Type	Method and Description
SpotLight	getLight() return the light used to cast shadows
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	setLight(SpotLight 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

SpotLightShadowFilter

protected SpotLightShadowFilter()

Used for serialization. Use SpotLightShadowFilter#SpotLightShadowFilter(AssetManager assetManager, int shadowMapSize) instead.

SpotLightShadowFilter

public SpotLightShadowFilter(AssetManager assetManager,
                             int shadowMapSize)

Creates a SpotLight Shadow Filter

Parameters:

assetManager - the application asset manager

shadowMapSize - the size of the rendered shadowmaps (512,1024,2048, etc...) The more quality, the fewer fps.

Method Detail

getLight

public SpotLight getLight()

return the light used to cast shadows

Returns:

the SpotLight

setLight

public void setLight(SpotLight light)

Sets the light to use to cast shadows

Parameters:

light - a SpotLight

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<SpotLightShadowRenderer>

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<SpotLightShadowRenderer>

Throws:

java.io.IOException