1 /* 2 * Copyright (c) 2009-2010 jMonkeyEngine 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions are 7 * met: 8 * 9 * * Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 12 * * Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * * Neither the name of 'jMonkeyEngine' nor the names of its contributors 17 * may be used to endorse or promote products derived from this software 18 * without specific prior written permission. 19 * 20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 21 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 22 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 23 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 24 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 25 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 26 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 27 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 28 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 29 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 30 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 31 */ 32 package com.jme3.terrain; 33 34 /** 35 * Monitor the progress of an expensive terrain operation. 36 * 37 * Monitors are passed into the expensive operations, and those operations 38 * call the incrementProgress method whenever they determine that progress 39 * has changed. It is up to the monitor to determine if the increment is 40 * percentage or a unit of another measure, but anything calling it should 41 * use the setMonitorMax() method and make sure incrementProgress() match up 42 * in terms of units. 43 * 44 * @author Brent Owens 45 */ 46 public interface ProgressMonitor { 47 48 /** 49 * Increment the progress by a unit. 50 */ 51 public void incrementProgress(float increment); 52 53 /** 54 * The max value that when reached, the progress is at 100%. 55 */ 56 public void setMonitorMax(float max); 57 58 /** 59 * The max value of the progress. When incrementProgress() 60 * reaches this value, progress is complete 61 */ 62 public float getMonitorMax(); 63 64 /** 65 * The progress has completed 66 */ 67 public void progressComplete(); 68 } 69
