|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.jme3.post.Filter
com.jme3.post.filters.LightScatteringFilter
public class LightScatteringFilter
LightScattering filters creates rays comming from a light sources This is often reffered as god rays.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.jme3.post.Filter |
---|
Filter.Pass |
Field Summary |
---|
Fields inherited from class com.jme3.post.Filter |
---|
defaultPass, enabled, material, postRenderPasses, processor |
Constructor Summary | |
---|---|
LightScatteringFilter()
creates a lightScaterring filter |
|
LightScatteringFilter(Vector3f lightPosition)
Creates a lightScatteringFilter |
Method Summary | |
---|---|
float |
getBlurStart()
returns the blur start of the scattering see setBlurStart(float blurStart) |
float |
getBlurWidth()
returns the blur width see setBlurWidth(float blurWidth) |
float |
getLightDensity()
retiurns the light density see setLightDensity(float lightDensity) |
Vector3f |
getLightPosition()
returns the light position |
protected Material |
getMaterial()
Must return the material used for this filter. |
int |
getNbSamples()
returns the nmber of samples for the radial blur |
protected void |
initFilter(AssetManager manager,
RenderManager renderManager,
ViewPort vp,
int w,
int h)
Initialization of sub classes filters This method is called once when the filter is added to the FilterPostProcessor It should contain Material initializations and extra passes initialization |
protected boolean |
isRequiresDepthTexture()
Override this method and return true if your Filter needs the depth texture |
protected void |
postQueue(RenderManager renderManager,
ViewPort viewPort)
Override this method if you want to make a pre pass, before the actual rendering of the frame |
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 |
setBlurStart(float blurStart)
sets the blur start at which distance from the light source the effect starts default is 0.02 |
void |
setBlurWidth(float blurWidth)
sets the blur width default is 0.9 |
void |
setLightDensity(float lightDensity)
sets how much the effect is visible over the rendered scene default is 1.4 |
void |
setLightPosition(Vector3f lightPosition)
sets the light position |
void |
setNbSamples(int nbSamples)
sets the number of samples for the radial blur default is 50 the higher the value the higher the quality, but the slower the performances. |
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.post.Filter |
---|
cleanup, cleanUpFilter, getDefaultPassDepthFormat, getDefaultPassTextureFormat, getName, getPostRenderPasses, getRenderedTexture, getRenderFrameBuffer, init, isEnabled, isRequiresSceneTexture, postFrame, preFrame, 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 |
---|
public LightScatteringFilter()
public LightScatteringFilter(Vector3f lightPosition)
lightPosition
- Method Detail |
---|
protected boolean isRequiresDepthTexture()
Filter
isRequiresDepthTexture
in class Filter
protected Material getMaterial()
Filter
getMaterial
in class Filter
protected void postQueue(RenderManager renderManager, ViewPort viewPort)
Filter
postQueue
in class Filter
protected void initFilter(AssetManager manager, RenderManager renderManager, ViewPort vp, int w, int h)
Filter
initFilter
in class Filter
manager
- the assetManagerrenderManager
- the renderManagervp
- the viewPort where this filter is renderedw
- the width of the filterh
- the height of the filterpublic float getBlurStart()
setBlurStart(float blurStart)
public void setBlurStart(float blurStart)
blurStart
- public float getBlurWidth()
setBlurWidth(float blurWidth)
public void setBlurWidth(float blurWidth)
blurWidth
- public float getLightDensity()
setLightDensity(float lightDensity)
public void setLightDensity(float lightDensity)
lightDensity
- public Vector3f getLightPosition()
public void setLightPosition(Vector3f lightPosition)
lightPosition
- public int getNbSamples()
public void setNbSamples(int nbSamples)
nbSamples
- public void write(JmeExporter ex) throws java.io.IOException
Filter
write
in interface Savable
write
in class Filter
java.io.IOException
public void read(JmeImporter im) throws java.io.IOException
Filter
read
in interface Savable
read
in class Filter
java.io.IOException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |