engine/src/terrain/com/jme3/terrain/ProgressMonitor.java

/*
 * Copyright (c) 2009-2010 jMonkeyEngine
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 * * Redistributions of source code must retain the above copyright
 *   notice, this list of conditions and the following disclaimer.
 *
 * * Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 *
 * * Neither the name of 'jMonkeyEngine' nor the names of its contributors
 *   may be used to endorse or promote products derived from this software
 *   without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package com.jme3.terrain;

/**
 * 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.
 *
 * @author Brent Owens
 */
public interface ProgressMonitor {

    /**
     * Increment the progress by a unit.
     */
    public void incrementProgress(float increment);

    /**
     * The max value that when reached, the progress is at 100%.
     */
    public void setMonitorMax(float max);

    /**
     * The max value of the progress. When incrementProgress()
     * reaches this value, progress is complete
     */
    public float getMonitorMax();

    /**
     * The progress has completed
     */
    public void progressComplete();
}