blender/source/gameengine/Ketsji/KX_IpoActuator.h

155 lines
4.3 KiB
C
Raw Normal View History

/*
* ***** BEGIN GPL LICENSE BLOCK *****
2002-10-12 11:37:38 +00:00
*
* 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 2
* of the License, or (at your option) any later version.
2002-10-12 11:37:38 +00:00
*
* 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, write to the Free Software Foundation,
2010-02-12 13:34:04 +00:00
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
2002-10-12 11:37:38 +00:00
*
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
* All rights reserved.
*
* The Original Code is: all of this file.
*
* Contributor(s): none yet.
*
* ***** END GPL LICENSE BLOCK *****
2002-10-12 11:37:38 +00:00
*/
/** \file KX_IpoActuator.h
* \ingroup ketsji
* \brief Do an object ipo
*/
#ifndef __KX_IPOACTUATOR_H__
#define __KX_IPOACTUATOR_H__
2002-10-12 11:37:38 +00:00
#include "SCA_IActuator.h"
class KX_IpoActuator : public SCA_IActuator
{
Py_Header
private:
/** Computes the IPO start time from the current time
2012-03-09 18:28:30 +00:00
* and the current frame. */
void SetStartTime(float curtime);
/** Computes the current frame from the current time
2012-03-09 18:28:30 +00:00
* and the IPO start time. */
void SetLocalTime(float curtime);
2004-11-03 10:48:02 +00:00
/** Ensures the current frame is between the start and
2012-03-09 18:28:30 +00:00
* end frames. */
2004-11-03 10:48:02 +00:00
bool ClampLocalTime();
protected:
2002-10-12 11:37:38 +00:00
bool m_bNegativeEvent;
/** Begin frame of the ipo. */
float m_startframe;
2002-10-12 11:37:38 +00:00
/** End frame of the ipo. */
float m_endframe;
2002-10-12 11:37:38 +00:00
/** Include children in the transforms? */
bool m_recurse;
/** Current active frame of the ipo. */
float m_localtime;
2004-11-03 10:48:02 +00:00
/** The time this ipo started at. */
float m_starttime;
2002-10-12 11:37:38 +00:00
/** play backwards or forwards? (positive means forward). */
float m_direction;
/** Name of the property (only used in from_prop mode). */
STR_String m_propname;
/** Name of the property where we write the current frame number */
STR_String m_framepropname;
2002-10-12 11:37:38 +00:00
/** Interpret the ipo as a force? */
bool m_ipo_as_force;
BGE logic patch: new "Add" mode for Ipo actuator, several corrections in state system. New Add mode for Ipo actuator ============================= A new Add button, mutually exclusive with Force button, is available in the Ipo actuator. When selected, it activates the Add mode that consists in adding the Ipo curve to the current object situation in world coordinates, or parent coordinates if the object has a parent. Scale Ipo curves are multiplied instead of added to the object current scale. If the local flag is selected, the Ipo curve is added (multiplied) in the object's local coordinates. Delta Ipo curves are handled identically to normal Ipo curve and there is no need to work with Delta Ipo curves provided that you make sure that the Ipo curve starts from origin. Origin means location 0 for Location Ipo curve, rotation 0 for Rotation Ipo curve and scale 1 for Scale Ipo curve. The "current object situation" means the object's location, rotation and scale at the start of the Ipo curve. For Loop Stop and Loop End Ipo actuators, this means at the start of each loop. This initial state is used as a base during the execution of the Ipo Curve but when the Ipo curve is restarted (later or immediately in case of Loop mode), the object current situation at that time is used as the new base. For reference, here is the exact operation of the Add mode for each type of Ipo curve (oLoc, oRot, oScale, oMat: object's loc/rot/scale and orientation matrix at the start of the curve; iLoc, iRot, iScale, iMat: Ipo curve loc/rot/scale and orientation matrix resulting from the rotation). Location Local=false: newLoc = oLoc+iLoc Local=true : newLoc = oLoc+oScale*(oMat*iLoc) Rotation Local=false: newMat = iMat*oMat Local=true : newMat = oMat*iMat Scale Local=false: newScale = oScale*iScale Local=true : newScale = oScale*iScale Add+Local mode is very useful to have dynamic object executing complex movement relative to their current location/orientation. Of cource, dynamics should be disabled during the execution of the curve. Several corrections in state system =================================== - Object initial state is taken into account when adding object dynamically - Fix bug with link count when adding object dynamically - Fix false on-off detection for Actuator sensor when actuator is trigged on negative event. - Fix Parent actuator false activation on negative event - Loop Ipo curve not restarting at correct frame when start frame is different from one.
2008-07-08 12:18:43 +00:00
/** Add Ipo curve to current loc/rot/scale */
bool m_ipo_add;
/** The Ipo curve is applied in local coordinates */
bool m_ipo_local;
2002-10-12 11:37:38 +00:00
bool m_bIpoPlaying;
/** Reset/Update the start time*/
void ResetStartTime();
2002-10-12 11:37:38 +00:00
public:
enum IpoActType
{
KX_ACT_IPO_NODEF = 0,
KX_ACT_IPO_PLAY,
KX_ACT_IPO_PINGPONG,
KX_ACT_IPO_FLIPPER,
KX_ACT_IPO_LOOPSTOP,
KX_ACT_IPO_LOOPEND,
KX_ACT_IPO_KEY2KEY,
KX_ACT_IPO_FROM_PROP,
KX_ACT_IPO_MAX
};
#ifdef WITH_PYTHON
static PyObject* pyattr_get_frame_start(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
static int pyattr_set_frame_start(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
static PyObject* pyattr_get_frame_end(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef);
static int pyattr_set_frame_end(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef, PyObject *value);
#endif
static const char *S_KX_ACT_IPO_PLAY_STRING;
static const char *S_KX_ACT_IPO_PINGPONG_STRING;
static const char *S_KX_ACT_IPO_FLIPPER_STRING;
static const char *S_KX_ACT_IPO_LOOPSTOP_STRING;
static const char *S_KX_ACT_IPO_LOOPEND_STRING;
static const char *S_KX_ACT_IPO_KEY2KEY_STRING;
static const char *S_KX_ACT_IPO_FROM_PROP_STRING;
2002-10-12 11:37:38 +00:00
int string2mode(const char *modename);
2002-10-12 11:37:38 +00:00
int m_type;
2002-10-12 11:37:38 +00:00
KX_IpoActuator(SCA_IObject* gameobj,
const STR_String& propname,
const STR_String& framePropname,
float starttime,
float endtime,
bool recurse,
int acttype,
bool ipo_as_force,
bool ipo_add,
bool ipo_local);
2002-10-12 11:37:38 +00:00
virtual ~KX_IpoActuator() {};
virtual CValue* GetReplica() {
KX_IpoActuator* replica = new KX_IpoActuator(*this);//m_float,GetName());
replica->ProcessReplica();
return replica;
};
void SetStart(float starttime);
void SetEnd(float endtime);
virtual bool Update(double curtime, bool frame);
2002-10-12 11:37:38 +00:00
/* --------------------------------------------------------------------- */
/* Python interface ---------------------------------------------------- */
/* --------------------------------------------------------------------- */
2002-10-12 11:37:38 +00:00
};
#endif //__KX_IPOACTUATOR_H__