BGE: TrackTo actuator: increasing up & track axis options

This is related to Task T34861 to increase up & track axis options for TrackTo actuator. I've just added it to differential to facilitate an easier review.

With the patch applied you can select X, Y and Z axis for the Up axis, and X, Y, Z, -X, -Y and -Z for the track axis.

Related to the implementation I have used the algorithm from Trackto constrain placed in constrain.c but adapted to be used with MOTO library.

The wiki docs are here (http://wiki.blender.org/index.php/User:Lordloki/Doc:2.6/Manual/Game_Engine/Logic/Actuators/Edit_Object#Trackto_Actuator).

Test file is here: {F97623}

I have also uploaded 2 screenshots showing the UI modifications to the TrackTo actuator:

{F91992} {F91990}

Reviewers: moguri, dfelinto

Reviewed By: moguri

CC: Genome36

Differential Revision: https://developer.blender.org/D565

6 files changed, 79 insertions, 1 deletions

diff --git a/source/blender/blenkernel/BKE_blender.h b/source/blender/blenkernel/BKE_blender.h
index 0af45a147a4..19fa60f5827 100644
--- a/source/blender/blenkernel/BKE_blender.h
+++ b/source/blender/blenkernel/BKE_blender.h
@@ -42,7 +42,7 @@ extern "C" {
  * and keep comment above the defines.
  * Use STRINGIFY() rather than defining with quotes */
 #define BLENDER_VERSION         271
-#define BLENDER_SUBVERSION      1
+#define BLENDER_SUBVERSION      2
 /* 262 was the last editmesh release but it has compatibility code for bmesh data */
 #define BLENDER_MINVERSION      270
 #define BLENDER_MINSUBVERSION   5
diff --git a/source/blender/blenkernel/intern/sca.c b/source/blender/blenkernel/intern/sca.c
index 1310162483e..4be75344133 100644
--- a/source/blender/blenkernel/intern/sca.c
+++ b/source/blender/blenkernel/intern/sca.c
@@ -392,6 +392,7 @@ void init_actuator(bActuator *act)
 	bSteeringActuator *sta;
 	bArmatureActuator *arma;
 	bMouseActuator *ma;
+	bEditObjectActuator *eoa;
 	
 	if (act->data) MEM_freeN(act->data);
 	act->data= NULL;
@@ -430,6 +431,9 @@ void init_actuator(bActuator *act)
 		break;
 	case ACT_EDIT_OBJECT:
 		act->data= MEM_callocN(sizeof(bEditObjectActuator), "editobact");
+		eoa = act->data;
+		eoa->upflag= ACT_TRACK_UP_Z;
+		eoa->trackflag= ACT_TRACK_TRAXIS_Y;
 		break;
 	case ACT_CONSTRAINT:
 		act->data= MEM_callocN(sizeof(bConstraintActuator), "cons act");
diff --git a/source/blender/blenloader/intern/versioning_270.c b/source/blender/blenloader/intern/versioning_270.c
index 103f9b76ba7..dde16c8d44f 100644
--- a/source/blender/blenloader/intern/versioning_270.c
+++ b/source/blender/blenloader/intern/versioning_270.c
@@ -42,6 +42,7 @@
 #include "DNA_mesh_types.h"
 #include "DNA_modifier_types.h"
 #include "DNA_linestyle_types.h"
+#include "DNA_actuator_types.h"
 
 #include "DNA_genfile.h"
 
@@ -310,6 +311,29 @@ void blo_do_versions_270(FileData *fd, Library *UNUSED(lib), Main *main)
 		}
 	}
 
+	if (!MAIN_VERSION_ATLEAST(main, 271, 2)) {
+		/* init up & track axis property of trackto actuators */
+		Object *ob;
+
+		for (ob = main->object.first; ob; ob = ob->id.next) {
+			bActuator *act;
+			for (act = ob->actuators.first; act; act = act->next) {
+				if (act->type == ACT_EDIT_OBJECT) {
+					bEditObjectActuator *eoact = act->data;
+					eoact->trackflag = ob->trackflag;
+					/* if trackflag is pointing +-Z axis then upflag should point Y axis.
+					 * Rest of trackflag cases, upflag should be point z axis */
+					if ((ob->trackflag == OB_POSZ) || (ob->trackflag == OB_NEGZ)) {
+						eoact->upflag = 1;
+					}
+					else {
+						eoact->upflag = 2;
+					}
+				}
+			}
+		}
+	}
+
 	if (!DNA_struct_elem_find(fd->filesdna, "RenderData", "int", "preview_start_resolution")) {
 		Scene *scene;
 		for (scene = main->scene.first; scene; scene = scene->id.next) {
diff --git a/source/blender/editors/space_logic/logic_window.c b/source/blender/editors/space_logic/logic_window.c
index b52d6265800..c3a3dda2c47 100644
--- a/source/blender/editors/space_logic/logic_window.c
+++ b/source/blender/editors/space_logic/logic_window.c
@@ -1720,6 +1720,12 @@ static void draw_actuator_edit_object(uiLayout *layout, PointerRNA *ptr)
 			sub = uiLayoutSplit(split, 0.7f, false);
 			uiItemR(sub, ptr, "time", 0, NULL, ICON_NONE);
 			uiItemR(sub, ptr, "use_3d_tracking", UI_ITEM_R_TOGGLE, NULL, ICON_NONE);
+
+			row = uiLayoutRow(layout, false);
+			uiItemR(row, ptr, "up_axis", 0, NULL, ICON_NONE);
+
+			row = uiLayoutRow(layout, false);
+			uiItemR(row, ptr, "track_axis", 0, NULL, ICON_NONE);
 			break;
 		case ACT_EDOB_DYNAMICS:
 			if (ob->type != OB_MESH) {
diff --git a/source/blender/makesdna/DNA_actuator_types.h b/source/blender/makesdna/DNA_actuator_types.h
index 5ab799a75e5..7698d671117 100644
--- a/source/blender/makesdna/DNA_actuator_types.h
+++ b/source/blender/makesdna/DNA_actuator_types.h
@@ -97,6 +97,8 @@ typedef struct bEditObjectActuator {
 	float mass;
 	short localflag; /* flag for the lin & ang. vel: apply locally   */
 	short dyn_operation;
+	short upflag, trackflag; /* flag for up axis and track axis */
+	int pad;
 } bEditObjectActuator;
 
 typedef struct bSceneActuator {
@@ -439,6 +441,19 @@ typedef struct bActuator {
 /* editObjectActuator->flag */
 #define ACT_TRACK_3D			1
 
+/* editObjectActuator->upflag */
+#define ACT_TRACK_UP_X			0
+#define ACT_TRACK_UP_Y			1
+#define ACT_TRACK_UP_Z			2
+
+/* editObjectActuator->trackflag */
+#define ACT_TRACK_TRAXIS_X			0
+#define ACT_TRACK_TRAXIS_Y			1
+#define ACT_TRACK_TRAXIS_Z			2
+#define ACT_TRACK_TRAXIS_NEGX		3
+#define ACT_TRACK_TRAXIS_NEGY		4
+#define ACT_TRACK_TRAXIS_NEGZ		5
+
 /* editObjectActuator->flag for replace mesh actuator */
 #define ACT_EDOB_REPLACE_MESH_NOGFX		2 /* use for replace mesh actuator */
 #define ACT_EDOB_REPLACE_MESH_PHYS		4
diff --git a/source/blender/makesrna/intern/rna_actuator.c b/source/blender/makesrna/intern/rna_actuator.c
index 62e681d1374..9d26978d098 100644
--- a/source/blender/makesrna/intern/rna_actuator.c
+++ b/source/blender/makesrna/intern/rna_actuator.c
@@ -1369,6 +1369,23 @@ static void rna_def_edit_object_actuator(BlenderRNA *brna)
 		{0, NULL, 0, NULL, NULL}
 	};
 
+	static EnumPropertyItem prop_track_axis_items[] = {
+		{ACT_TRACK_TRAXIS_X, "TRACKAXISX", 0, "X axis", ""},
+		{ACT_TRACK_TRAXIS_Y, "TRACKAXISY", 0, "Y axis", ""},
+		{ACT_TRACK_TRAXIS_Z, "TRACKAXISZ", 0, "Z axis", ""},
+		{ACT_TRACK_TRAXIS_NEGX, "TRACKAXISNEGX", 0, "-X axis", ""},
+		{ACT_TRACK_TRAXIS_NEGY, "TRACKAXISNEGY", 0, "-Y axis", ""},
+		{ACT_TRACK_TRAXIS_NEGZ, "TRACKAXISNEGZ", 0, "-Z axis", ""},
+		{0, NULL, 0, NULL, NULL}
+	};
+
+	static EnumPropertyItem prop_up_axis_items[] = {
+		{ACT_TRACK_UP_X, "UPAXISX", 0, "X axis", ""},
+		{ACT_TRACK_UP_Y, "UPAXISY", 0, "Y axis", ""},
+		{ACT_TRACK_UP_Z, "UPAXISZ", 0, "Z axis", ""},
+		{0, NULL, 0, NULL, NULL}
+	};
+
 	srna = RNA_def_struct(brna, "EditObjectActuator", "Actuator");
 	RNA_def_struct_ui_text(srna, "Edit Object Actuator", "Actuator used to edit objects");
 	RNA_def_struct_sdna_from(srna, "bEditObjectActuator", "data");
@@ -1385,6 +1402,18 @@ static void rna_def_edit_object_actuator(BlenderRNA *brna)
 	RNA_def_property_ui_text(prop, "Dynamic Operation", "");
 	RNA_def_property_update(prop, NC_LOGIC, NULL);
 
+	prop = RNA_def_property(srna, "up_axis", PROP_ENUM, PROP_NONE);
+	RNA_def_property_enum_sdna(prop, NULL, "upflag");
+	RNA_def_property_enum_items(prop, prop_up_axis_items);
+	RNA_def_property_ui_text(prop, "Up Axis", "The axis that points upward");
+	RNA_def_property_update(prop, NC_LOGIC, NULL);
+
+	prop = RNA_def_property(srna, "track_axis", PROP_ENUM, PROP_NONE);
+	RNA_def_property_enum_sdna(prop, NULL, "trackflag");
+	RNA_def_property_enum_items(prop, prop_track_axis_items);
+	RNA_def_property_ui_text(prop, "Track Axis", "The axis that points to the target object");
+	RNA_def_property_update(prop, NC_LOGIC, NULL);
+
 	prop = RNA_def_property(srna, "object", PROP_POINTER, PROP_NONE);
 	RNA_def_property_struct_type(prop, "Object");
 	RNA_def_property_pointer_sdna(prop, NULL, "ob");