NullLightFilter (jMonkeyEngine3)

java.lang.Object

com.jme3.light.NullLightFilter

All Implemented Interfaces:: LightFilter

public class NullLightFilter extends Object implements LightFilter

NullLightFilter does nothing. Used when you want to disable the light filter

Constructor Summary

Constructors

Constructor

Description

NullLightFilter()
Method Summary

Modifier and Type

Method

Description

void

filterLights(Geometry geometry, LightList filteredLightList)

Determine which lights on the world light list are to be rendered.

void

setCamera(Camera camera)

Sets the camera for which future filtering is to be done against in LightFilter.filterLights(com.jme3.scene.Geometry, com.jme3.light.LightList).

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

Constructor Details
- NullLightFilter
  
  public NullLightFilter()
Method Details
- setCamera
  
  public void setCamera(Camera camera)
  
  Description copied from interface: LightFilter
  
  Sets the camera for which future filtering is to be done against in LightFilter.filterLights(com.jme3.scene.Geometry, com.jme3.light.LightList).
  
  Specified by:
  
  setCamera in interface LightFilter
  
  Parameters:
  
  camera - The camera to perform light filtering against.
- filterLights
  
  public void filterLights(Geometry geometry, LightList filteredLightList)
  
  Description copied from interface: LightFilter
  
  Determine which lights on the world light list are to be rendered.
  The simplest implementation (e.g. one that performs no filtering) would simply copy the contents of Spatial.getWorldLightList() to filteredLightList.
  An advanced implementation would determine if the light intersects the geometry's bounding volume and if the light intersects the frustum of the camera set in LightFilter.setCamera(com.jme3.renderer.Camera) as well as sort the lights according to some "influence" criteria - this will then provide an optimal set of lights that should be used for rendering.
  
  Specified by:
  
  filterLights in interface LightFilter
  
  Parameters:
  
  geometry - The geometry for which the light filtering is performed.
  
  filteredLightList - The results are to be stored here.