source/gameengine/Ketsji/KX_IpoActuator.h

   1 /**
   2  * Do an object ipo
   3  *
   4  * $Id$
   5  *
   6  * ***** BEGIN GPL LICENSE BLOCK *****
   7  *
   8  * This program is free software; you can redistribute it and/or
   9  * modify it under the terms of the GNU General Public License
  10  * as published by the Free Software Foundation; either version 2
  11  * of the License, or (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License
  19  * along with this program; if not, write to the Free Software Foundation,
  20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  21  *
  22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
  23  * All rights reserved.
  24  *
  25  * The Original Code is: all of this file.
  26  *
  27  * Contributor(s): none yet.
  28  *
  29  * ***** END GPL LICENSE BLOCK *****
  30  */
  31
  32 #ifndef __KX_IPOACTUATOR
  33 #define __KX_IPOACTUATOR
  34
  35 #include "SCA_IActuator.h"
  36
  37 class KX_IpoActuator : public SCA_IActuator
  38 {
  39         Py_Header;
  40 private:
  41         /** Computes the IPO start time from the current time
  42             and the current frame. */
  43         void SetStartTime(float curtime);
  44         /** Computes the current frame from the current time
  45             and the IPO start time. */
  46         void SetLocalTime(float curtime);
  47         /** Ensures the current frame is between the start and
  48             end frames. */
  49         bool ClampLocalTime();
  50
  51 protected:
  52         bool    m_bNegativeEvent;
  53
  54         /** Begin frame of the ipo. */
  55         float   m_startframe;
  56
  57         /** End frame of the ipo. */
  58         float   m_endframe;
  59
  60         /** Include children in the transforms? */
  61         bool    m_recurse;
  62
  63         /** Current active frame of the ipo. */
  64         float   m_localtime;
  65
  66         /** The time this ipo started at. */
  67         float   m_starttime;
  68
  69         /** play backwards or forwards? (positive means forward). */
  70         float   m_direction;
  71
  72         /** Name of the property (only used in from_prop mode). */
  73         STR_String      m_propname;
  74
  75         /** Interpret the ipo as a force? */
  76         bool    m_ipo_as_force;
  77
  78         /** Add Ipo curve to current loc/rot/scale */
  79         bool    m_ipo_add;
  80
  81         /** The Ipo curve is applied in local coordinates */
  82         bool    m_ipo_local;
  83
  84         bool    m_bIpoPlaying;
  85
  86 public:
  87         enum IpoActType
  88         {
  89                 KX_ACT_IPO_NODEF = 0,
  90                 KX_ACT_IPO_PLAY,
  91                 KX_ACT_IPO_PINGPONG,
  92                 KX_ACT_IPO_FLIPPER,
  93                 KX_ACT_IPO_LOOPSTOP,
  94                 KX_ACT_IPO_LOOPEND,
  95                 KX_ACT_IPO_KEY2KEY,
  96                 KX_ACT_IPO_FROM_PROP,
  97                 KX_ACT_IPO_MAX
  98         };
  99
 100         static STR_String S_KX_ACT_IPO_PLAY_STRING;
 101         static STR_String S_KX_ACT_IPO_PINGPONG_STRING;
 102         static STR_String S_KX_ACT_IPO_FLIPPER_STRING;
 103         static STR_String S_KX_ACT_IPO_LOOPSTOP_STRING;
 104         static STR_String S_KX_ACT_IPO_LOOPEND_STRING;
 105         static STR_String S_KX_ACT_IPO_KEY2KEY_STRING;
 106         static STR_String S_KX_ACT_IPO_FROM_PROP_STRING;
 107
 108         IpoActType string2mode(char* modename);
 109
 110         IpoActType      m_type;
 111
 112         KX_IpoActuator(SCA_IObject* gameobj,
 113                                    const STR_String& propname,
 114                                    float starttime,
 115                                    float endtime,
 116                                    bool recurse,
 117                                    int acttype,
 118                                    bool ipo_as_force,
 119                                    bool ipo_add,
 120                                    bool ipo_local,
 121                                    PyTypeObject* T=&Type);
 122         virtual ~KX_IpoActuator() {};
 123
 124         virtual CValue* GetReplica() {
 125                 KX_IpoActuator* replica = new KX_IpoActuator(*this);//m_float,GetName());
 126                 replica->ProcessReplica();
 127                 // this will copy properties and so on...
 128                 CValue::AddDataToReplica(replica);
 129                 return replica;
 130         };
 131
 132         void            SetStart(float starttime);
 133         void            SetEnd(float endtime);
 134         virtual         bool Update(double curtime, bool frame);
 135
 136         /* --------------------------------------------------------------------- */
 137         /* Python interface ---------------------------------------------------- */
 138         /* --------------------------------------------------------------------- */
 139
 140         virtual PyObject* _getattr(const STR_String& attr);
 141         //KX_PYMETHOD_DOC
 142         KX_PYMETHOD_DOC(KX_IpoActuator,Set);
 143         KX_PYMETHOD_DOC(KX_IpoActuator,SetProperty);
 144 /*      KX_PYMETHOD_DOC(KX_IpoActuator,SetKey2Key); */
 145         KX_PYMETHOD_DOC(KX_IpoActuator,SetStart);
 146         KX_PYMETHOD_DOC_NOARGS(KX_IpoActuator,GetStart);
 147         KX_PYMETHOD_DOC(KX_IpoActuator,SetEnd);
 148         KX_PYMETHOD_DOC_NOARGS(KX_IpoActuator,GetEnd);
 149         KX_PYMETHOD_DOC(KX_IpoActuator,SetIpoAsForce);
 150         KX_PYMETHOD_DOC_NOARGS(KX_IpoActuator,GetIpoAsForce);
 151         KX_PYMETHOD_DOC(KX_IpoActuator,SetIpoAdd);
 152         KX_PYMETHOD_DOC_NOARGS(KX_IpoActuator,GetIpoAdd);
 153         KX_PYMETHOD_DOC(KX_IpoActuator,SetType);
 154         KX_PYMETHOD_DOC_NOARGS(KX_IpoActuator,GetType);
 155         KX_PYMETHOD_DOC(KX_IpoActuator,SetForceIpoActsLocal);
 156         KX_PYMETHOD_DOC_NOARGS(KX_IpoActuator,GetForceIpoActsLocal);
 157
 158 };
 159
 160 #endif //__KX_IPOACTUATOR
 161