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.

1 files changed, 65 insertions, 22 deletions

diff --git a/source/gameengine/Ketsji/KX_IPO_SGController.cpp b/source/gameengine/Ketsji/KX_IPO_SGController.cpp
index 5303e9a9e85..d3aa924665e 100644
--- a/source/gameengine/Ketsji/KX_IPO_SGController.cpp
+++ b/source/gameengine/Ketsji/KX_IPO_SGController.cpp
@@ -55,7 +55,8 @@ typedef unsigned long uint_ptr;
 // start on another frame, the 1.0 should change.
 KX_IpoSGController::KX_IpoSGController() 
 : m_ipo_as_force(false),
-  m_force_ipo_acts_local(false),
+  m_ipo_add(false),
+  m_ipo_local(false),
   m_modified(true),
   m_ipo_start_initialized(false),
   m_ipotime(1.0)
@@ -75,8 +76,23 @@ void KX_IpoSGController::SetOption(
 		m_ipo_as_force = (value != 0);
 		m_modified = true;
 		break;
-	case SG_CONTR_IPO_FORCES_ACT_LOCAL:
-		m_force_ipo_acts_local = (value != 0);
+	case SG_CONTR_IPO_IPO_ADD:
+		m_ipo_add = (value != 0);
+		m_modified = true;
+		break;
+	case SG_CONTR_IPO_RESET:
+		if (m_ipo_start_initialized && value) {
+			m_ipo_start_initialized = false;
+			m_modified = true;
+		}
+		break;
+	case SG_CONTR_IPO_LOCAL:
+		if (value/* && ((SG_Node*)m_pObject)->GetSGParent() == NULL*/) {
+			// only accept local Ipo if the object has no parent
+			m_ipo_local = true;
+		} else {
+			m_ipo_local = false;
+		}
 		m_modified = true;
 		break;
 	default:
@@ -129,15 +145,19 @@ bool KX_IpoSGController::Update(double currentTime)
 			{
 				if (m_game_object && ob) 
 				{
-					m_game_object->GetPhysicsController()->ApplyForce(m_force_ipo_acts_local ?
+					m_game_object->GetPhysicsController()->ApplyForce(m_ipo_local ?
 						ob->GetWorldOrientation() * m_ipo_xform.GetPosition() :
 						m_ipo_xform.GetPosition(), false);
 				}
 			} 
 			else
 			{
-				//by default, leave object as it stands
-				MT_Point3 newPosition = ob->GetLocalPosition();
+				// Local ipo should be defined with the object position at (0,0,0)
+				// Local transform is applied to the object based on initial position
+				MT_Point3 newPosition(0.0,0.0,0.0);
+				
+				if (!m_ipo_add)
+					newPosition = ob->GetLocalPosition();
 				//apply separate IPO channels if there is any data in them
 				//Loc and dLoc act by themselves or are additive
 				//LocX and dLocX
@@ -145,23 +165,28 @@ bool KX_IpoSGController::Update(double currentTime)
 					newPosition[0] = (m_ipo_channels_active[OB_DLOC_X] ? m_ipo_xform.GetPosition()[0] + m_ipo_xform.GetDeltaPosition()[0] : m_ipo_xform.GetPosition()[0]);
 				}
 				else if (m_ipo_channels_active[OB_DLOC_X] && m_ipo_start_initialized) {
-					newPosition[0] = (m_ipo_start_point[0] + m_ipo_xform.GetDeltaPosition()[0]);
+					newPosition[0] = (((!m_ipo_add)?m_ipo_start_point[0]:0.0) + m_ipo_xform.GetDeltaPosition()[0]);
 				}
 				//LocY and dLocY
 				if (m_ipo_channels_active[OB_LOC_Y]) {
 					newPosition[1] = (m_ipo_channels_active[OB_DLOC_Y] ? m_ipo_xform.GetPosition()[1] + m_ipo_xform.GetDeltaPosition()[1] : m_ipo_xform.GetPosition()[1]);
 				}
 				else if (m_ipo_channels_active[OB_DLOC_Y] && m_ipo_start_initialized) {
-					newPosition[1] = (m_ipo_start_point[1] + m_ipo_xform.GetDeltaPosition()[1]);
+					newPosition[1] = (((!m_ipo_add)?m_ipo_start_point[1]:0.0) + m_ipo_xform.GetDeltaPosition()[1]);
 				}
 				//LocZ and dLocZ
 				if (m_ipo_channels_active[OB_LOC_Z]) {
 					newPosition[2] = (m_ipo_channels_active[OB_DLOC_Z] ? m_ipo_xform.GetPosition()[2] + m_ipo_xform.GetDeltaPosition()[2] : m_ipo_xform.GetPosition()[2]);
 				}
 				else if (m_ipo_channels_active[OB_DLOC_Z] && m_ipo_start_initialized) {
-					newPosition[2] = (m_ipo_start_point[2] + m_ipo_xform.GetDeltaPosition()[2]);
+					newPosition[2] = (((!m_ipo_add)?m_ipo_start_point[2]:0.0) + m_ipo_xform.GetDeltaPosition()[2]);
+				}
+				if (m_ipo_add) {
+					if (m_ipo_local)
+						newPosition = m_ipo_start_point + m_ipo_start_scale*(m_ipo_start_orient*newPosition);
+					else
+						newPosition = m_ipo_start_point + newPosition;
 				}
-				
 				ob->SetLocalPosition(newPosition);
 			}
 		}
@@ -170,21 +195,23 @@ bool KX_IpoSGController::Update(double currentTime)
 			if (m_ipo_as_force) {
 				
 				if (m_game_object && ob) {
-					m_game_object->ApplyTorque(m_force_ipo_acts_local ?
+					m_game_object->ApplyTorque(m_ipo_local ?
 						ob->GetWorldOrientation() * m_ipo_xform.GetEulerAngles() :
 						m_ipo_xform.GetEulerAngles(), false);
 				}
 			} else {
-				double yaw, pitch,  roll;	//final Euler angles
+				double yaw=0, pitch=0,  roll=0;	//final Euler angles
 				double tempYaw=0, tempPitch=0, tempRoll=0;	//temp holders
-				ob->GetLocalOrientation().getEuler(yaw, pitch, roll);
+				if (!m_ipo_add)
+					ob->GetLocalOrientation().getEuler(yaw, pitch, roll);
 
 				//RotX and dRotX
 				if (m_ipo_channels_active[OB_ROT_X]) {
 					yaw = (m_ipo_channels_active[OB_DROT_X] ? (m_ipo_xform.GetEulerAngles()[0] + m_ipo_xform.GetDeltaEulerAngles()[0]) : m_ipo_xform.GetEulerAngles()[0] );
 				}
 				else if (m_ipo_channels_active[OB_DROT_X] && m_ipo_start_initialized) {
-					m_ipo_start_orient.getEuler(tempYaw, tempPitch, tempRoll);
+					if (!m_ipo_add)
+						m_ipo_start_orient.getEuler(tempYaw, tempPitch, tempRoll);
 					yaw = tempYaw + m_ipo_xform.GetDeltaEulerAngles()[0];
 				}
 
@@ -193,7 +220,8 @@ bool KX_IpoSGController::Update(double currentTime)
 					pitch = (m_ipo_channels_active[OB_DROT_Y] ? (m_ipo_xform.GetEulerAngles()[1] + m_ipo_xform.GetDeltaEulerAngles()[1]) : m_ipo_xform.GetEulerAngles()[1] );
 				}
 				else if (m_ipo_channels_active[OB_DROT_Y] && m_ipo_start_initialized) {
-					m_ipo_start_orient.getEuler(tempYaw, tempPitch, tempRoll);
+					if (!m_ipo_add)
+						m_ipo_start_orient.getEuler(tempYaw, tempPitch, tempRoll);
 					pitch = tempPitch + m_ipo_xform.GetDeltaEulerAngles()[1];
 				}
 				
@@ -202,23 +230,34 @@ bool KX_IpoSGController::Update(double currentTime)
 					roll = (m_ipo_channels_active[OB_DROT_Z] ? (m_ipo_xform.GetEulerAngles()[2] + m_ipo_xform.GetDeltaEulerAngles()[2]) : m_ipo_xform.GetEulerAngles()[2] );
 				}
 				else if (m_ipo_channels_active[OB_DROT_Z] && m_ipo_start_initialized) {
-					m_ipo_start_orient.getEuler(tempYaw, tempPitch, tempRoll);
+					if (!m_ipo_add)
+						m_ipo_start_orient.getEuler(tempYaw, tempPitch, tempRoll);
 					roll = tempRoll + m_ipo_xform.GetDeltaEulerAngles()[2];
 				}
-
-				ob->SetLocalOrientation(MT_Vector3(yaw, pitch, roll));
+				if (m_ipo_add) {
+					MT_Matrix3x3 rotation(MT_Vector3(yaw, pitch, roll));
+					if (m_ipo_local)
+						rotation = m_ipo_start_orient * rotation;
+					else
+						rotation = rotation * m_ipo_start_orient;
+					ob->SetLocalOrientation(rotation);
+				} else {
+					ob->SetLocalOrientation(MT_Vector3(yaw, pitch, roll));
+				}
 			}
 		}
 		//modifies scale?
 		if (m_ipo_channels_active[OB_SIZE_X] || m_ipo_channels_active[OB_SIZE_Y] || m_ipo_channels_active[OB_SIZE_Z] || m_ipo_channels_active[OB_DSIZE_X] || m_ipo_channels_active[OB_DSIZE_Y] || m_ipo_channels_active[OB_DSIZE_Z]) {
 			//default is no scale change
-			MT_Vector3 newScale = ob->GetLocalScale();
+			MT_Vector3 newScale(1.0,1.0,1.0);
+			if (!m_ipo_add)
+				newScale = ob->GetLocalScale();
 
 			if (m_ipo_channels_active[OB_SIZE_X]) {
 				newScale[0] = (m_ipo_channels_active[OB_DSIZE_X] ? (m_ipo_xform.GetScaling()[0] + m_ipo_xform.GetDeltaScaling()[0]) : m_ipo_xform.GetScaling()[0]);
 			}
 			else if (m_ipo_channels_active[OB_DSIZE_X] && m_ipo_start_initialized) {
-				newScale[0] = (m_ipo_xform.GetDeltaScaling()[0] + m_ipo_start_scale[0]);
+				newScale[0] = (m_ipo_xform.GetDeltaScaling()[0] + ((!m_ipo_add)?m_ipo_start_scale[0]:0.0));
 			}
 
 			//RotY dRotY
@@ -226,7 +265,7 @@ bool KX_IpoSGController::Update(double currentTime)
 				newScale[1] = (m_ipo_channels_active[OB_DSIZE_Y] ? (m_ipo_xform.GetScaling()[1] + m_ipo_xform.GetDeltaScaling()[1]): m_ipo_xform.GetScaling()[1]);
 			}
 			else if (m_ipo_channels_active[OB_DSIZE_Y] && m_ipo_start_initialized) {
-				newScale[1] = (m_ipo_xform.GetDeltaScaling()[1] + m_ipo_start_scale[1]);
+				newScale[1] = (m_ipo_xform.GetDeltaScaling()[1] + ((!m_ipo_add)?m_ipo_start_scale[1]:0.0));
 			}
 			
 			//RotZ and dRotZ
@@ -234,7 +273,11 @@ bool KX_IpoSGController::Update(double currentTime)
 				newScale[2] = (m_ipo_channels_active[OB_DSIZE_Z] ? (m_ipo_xform.GetScaling()[2] + m_ipo_xform.GetDeltaScaling()[2]) : m_ipo_xform.GetScaling()[2]);
 			}
 			else if (m_ipo_channels_active[OB_DSIZE_Z] && m_ipo_start_initialized) {
-				newScale[2] = (m_ipo_xform.GetDeltaScaling()[2] + m_ipo_start_scale[2]);
+				newScale[2] = (m_ipo_xform.GetDeltaScaling()[2] + ((!m_ipo_add)?m_ipo_start_scale[2]:1.0));
+			}
+
+			if (m_ipo_add) {
+				newScale = m_ipo_start_scale * newScale;
 			}
 
 			ob->SetLocalScale(newScale);