Package com.jme3.environment.util

Class LightsDebugState

java.lang.Object
com.jme3.app.state.BaseAppState
com.jme3.environment.util.LightsDebugState
All Implemented Interfaces:
AppState
public class LightsDebugState extends BaseAppState
A debug state that will display Light gizmos on screen. Still a wip and for now it only displays light probes.

  • Constructor Details

    • LightsDebugState

      public LightsDebugState()

  • Method Details

    • initialize

      protected void initialize(Application app)
      Description copied from class: BaseAppState
      Called during initialization once the app state is attached and before onEnable() is called.
      Specified by:
      initialize in class BaseAppState
      Parameters:
      app - the application

    • update

      public void update(float tpf)
      Description copied from interface: AppState
      Called to update the AppState. This method will be called every render pass if the AppState is both attached and enabled.
      Specified by:
      update in interface AppState
      Overrides:
      update in class BaseAppState
      Parameters:
      tpf - Time since the last call to update(), in seconds.

    • updateLights

      public void updateLights(Spatial scene)

    • setScene

      public void setScene(Spatial scene)
      Set the scenes for which to render light gizmos.
      Parameters:
      scene - the root of the desired scene (alias created)

    • render

      public void render(RenderManager rm)
      Description copied from interface: AppState
      Render the state. This method will be called every render pass if the AppState is both attached and enabled.
      Specified by:
      render in interface AppState
      Overrides:
      render in class BaseAppState
      Parameters:
      rm - RenderManager

    • getProbeScale

      public float getProbeScale()
      returns the scale of the probe's debug sphere
      Returns:
      the scale factor

    • setProbeScale

      public void setProbeScale(float probeScale)
      sets the scale of the probe's debug sphere
      Parameters:
      probeScale - the scale factor (default=1)

    • cleanup

      protected void cleanup(Application app)
      Description copied from class: BaseAppState
      Called after the app state is detached or during application shutdown if the state is still attached. onDisable() is called before this cleanup() method if the state is enabled at the time of cleanup.
      Specified by:
      cleanup in class BaseAppState
      Parameters:
      app - the application

    • onEnable

      protected void onEnable()
      Description copied from class: BaseAppState
      Called when the state is fully enabled, ie: is attached and isEnabled() is true or when the setEnabled() status changes after the state is attached.
      Specified by:
      onEnable in class BaseAppState

    • onDisable

      protected void onDisable()
      Description copied from class: BaseAppState
      Called when the state was previously enabled but is now disabled either because setEnabled(false) was called or the state is being cleaned up.
      Specified by:
      onDisable in class BaseAppState