IAnimatedOutput.java

/** 
 * IAnimatedOutput.java
 *
 * @author Martin Klöckner, Daniel Höpfl
 *
 * @see IOutput
 */

package SpringerPack;


import java.awt.Polygon;
import java.awt.Point;

/** 
 * These function of the abstract class (interface) IAnimatedOutput
 * have to be implemented additionaly by an Board, which supports Animation
 * of the Results.
 */
public abstract class IAnimatedOutput extends IOutput
{
   private boolean mAnimated = true;

   /**
    * @return   returns whether this Boards provides Animation or not.
    * This function is always left untouched.
    */
   public boolean isAnimated() { return mAnimated; }
   
   /**
    * returns the height of a field
    *
    * @param inP   Postion of the field (e.g. 1,2)
    */
   public abstract int getFieldHeight( Point inP );
   
   /**
    * returns the absolute coordinates of a field
    *
    * @param inP   Position of the field (e.g. 1,2)
    */
   public abstract Point getFieldMiddle( Point inP );
   
   /**
    * returns the width of a field 
    *
    * @param inP   Position of the field
    */
   public abstract int getFieldWidth( Point inP );
   
   /** 
    * returns the size of the board
    */
   public abstract int getFieldSize();
}