Interface ProgressMonitor


public interface ProgressMonitor
Monitor the progress of an expensive terrain operation. Monitors are passed into the expensive operations, and those operations call the incrementProgress method whenever they determine that progress has changed. It is up to the monitor to determine if the increment is percentage or a unit of another measure, but anything calling it should use the setMonitorMax() method and make sure incrementProgress() match up in terms of units.
  • Method Summary

    Modifier and Type
    Method
    Description
    float
    The max value of the progress.
    void
    incrementProgress(float increment)
    Increment the progress by a unit.
    void
    The progress has completed
    void
    setMonitorMax(float max)
    The max value that when reached, the progress is at 100%.
  • Method Details

    • incrementProgress

      void incrementProgress(float increment)
      Increment the progress by a unit.
    • setMonitorMax

      void setMonitorMax(float max)
      The max value that when reached, the progress is at 100%.
    • getMonitorMax

      float getMonitorMax()
      The max value of the progress. When incrementProgress() reaches this value, progress is complete
    • progressComplete

      void progressComplete()
      The progress has completed