gov/nasa/worldwind/view/ViewStateIterator.java

   1 /*
   2 Copyright (C) 2001, 2006 United States Government as represented by
   3 the Administrator of the National Aeronautics and Space Administration.
   4 All Rights Reserved.
   5 */
   6 package gov.nasa.worldwind.view;
   7
   8 /**
   9  * An iteration over <code>View</code> state changes.
  10  *
  11  * @author dcollins
  12  * @version $Id: ViewStateIterator.java 2422 2007-07-25 23:07:49Z tgaskins $
  13  * @see View
  14  */
  15 public interface ViewStateIterator
  16 {
  17     /**
  18      * If possible, merges this <code>ViewStateIterator</code> with <code>stateIterator</code> and returns the result.
  19      *
  20      * @param view          the <code>View</code> context.
  21      * @param stateIterator the <code>ViewStateIterator</code> to merge with.
  22      * @return the merged <code>ViewStateIterator</code>.
  23      * @throws IllegalArgumentException if <code>view</code> or <code>stateIterator</code> are null.
  24      */
  25     ViewStateIterator coalesceWith(View view, ViewStateIterator stateIterator);
  26
  27     /**
  28      * Returns true if <code>ViewStateIterator</code> has more state changes.
  29      *
  30      * @param view the <code>View</code> context.
  31      * @return true if <code>ViewStateIterator</code> has more state changes; false otherwise.
  32      */
  33     boolean hasNextState(View view);
  34
  35     /**
  36      * Applies the the next viewing state change to <code>view</code>.
  37      *
  38      * @param view the <code>View</code> context.
  39      */
  40     void nextState(View view);
  41 }