/******************************************************************************

  * AnimateEventMove.java - Manage the dice move animation.

  * $Id$

  * 

  * BuckoFIBS - Backgammon by BuckoSoft

  * Copyright© 2011 - Dick Balaska - BuckoSoft, Corp.

  * 

  * $Log$

  * Revision 1.3  2013/09/10 00:22:54  dick

  * Spline2D and Flasher move MoveSpline2D and MoveFlasher

  *

  * Revision 1.2  2011/06/02 19:13:34  dick

  * Need to define isGui().

  *

  * Revision 1.1  2011/05/22 22:56:09  dick

  * c.b.f.B.g.boardTab.board becomes c.b.f.B.g.boardTab.boardPane .

  *

  * Revision 1.4  2011/05/17 22:50:04  dick

  * AnimateEvent moves to c.b.f.B.g.b.b which is where it is used.

  *

  * Revision 1.3  2011/05/16 21:21:29  dick

  * Add passthrues for getCheckerYOnBar() and getCheckerYInHome().

  *

  * Revision 1.2  2011/05/16 11:42:02  dick

  * Offset moves to the base class.

  *

  * Revision 1.1  2011/05/15 02:17:54  dick

  * Move the AnimateEvents to their own package.

  *

  * Revision 1.4  2011/05/13 18:25:46  dick

  * Whitespace.

  *

  * Revision 1.3  2011/05/13 14:55:44  dick

  * Javadoc.

  *

  * Revision 1.2  2011/05/13 14:25:09  dick

  * Base class for the animation motion algorithms.

  *

  */

 /* 

  * This program is free software: you can redistribute it and/or modify

  * it under the terms of the GNU General Public License as published by

  * the Free Software Foundation, either version 3 of the License, or

  * (at your option) any later version.

  *

  * This program is distributed in the hope that it will be useful,

  * but WITHOUT ANY WARRANTY; without even the implied warranty of

  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

  * GNU General Public License for more details.

  *

  * You should have received a copy of the GNU General Public License

  * along with this program.  If not, see <http://www.gnu.org/licenses/>.

  *

  * The Original Code is BuckoFIBS, <http://www.buckosoft.com/BuckoFIBS/>.

  * The Initial Developer of the Original Code is Dick Balaska and BuckoSoft, Corp.

  * 

  */

 package com.buckosoft.fibs.BuckoFIBS.gui.boardTab.boardPane;

 import java.awt.Color;

 import com.buckosoft.fibs.BuckoFIBS.gui.boardTab.boardPane.BoardPane.BoardSpecs;

 import com.buckosoft.fibs.BuckoFIBS.gui.boardTab.boardPane.animateType.MoveFlasher;

 import com.buckosoft.fibs.BuckoFIBS.gui.boardTab.boardPane.animateType.MoveSpline2D;

 /** Run the dice move animation.

  * @author Dick Balaska

  * @since 2011/05/12

  * @version $Revision$ <br> $Date$

  * @see <a href="http://cvs.buckosoft.com/Projects/BuckoFIBS/BuckoFIBS/src/main/java/com/buckosoft/fibs/BuckoFIBS/gui/boardTab/boardPane/AnimateEventMove.java">cvs AnimateEventMove.java</a>

  */

 public abstract class AnimateEventMove extends AnimateEvent {

         /** Define an index that is a {@link MoveFlasher} */

         public final static int ANIMATE_FLASHER  = 0;

         /** Define an index that is a {@link MoveSpline2D} */

         public final static int ANIMATE_SPLINE2D = 1;

         protected double        x[] = new double[6];

         protected double        y[] = new double[6];

         protected        BoardPane                boardPane;

         public                BoardSpecs                bs;

         protected        int        pointNumberStart;

         protected        int        checkerNumberStart;

         protected        int        pointNumberEnd;

         protected        int        checkerNumberEnd;

         abstract public        void        calculate();

         abstract public int[]        getXY(double offset);

         abstract public        Color        getColor(double offset); 

         @Override

         public Type getType() {

                 return(Type.Move);

         }

         /** Default 1000ms for a Move

          */

         @Override

         public int getDuration() {

                 return 1000;

         }

         @Override

         public boolean isGui() {

                 return false;

         }

         public        void setBoardPane(BoardPane boardPane) {

                 this.boardPane = boardPane;

                 this.bs = boardPane.bs;

         }

         public void setStartPointAndOffset(int pointNumber, int checkerNumber) {

                 this.pointNumberStart = pointNumber;

                 this.checkerNumberStart = checkerNumber;

         }

         public void setEndPointAndOffset(int pointNumber, int checkerNumber) {

                 this.pointNumberEnd = pointNumber;

                 this.checkerNumberEnd = checkerNumber;

         }

         protected int getPointX(int point) {

                 return(boardPane.getPointX(point));

         }

         protected int getNthCheckerY(int point, int checker) {

                 return(boardPane.getNthCheckerY(point, checker));

         }

         protected int getCheckerYOnBar(int who, int checker) {

                 return(boardPane.getCheckerYOnBar(who, checker));

         }

         protected int getCheckerYInHome(int who, int checker) {

                 return(boardPane.getCheckerYInHome(who, checker));

         }

 }