Move custom transform orientations to workspace

This commit moves the list of transform orientations from scenes to workspaces.
Main reasons for this are:
* Transform orientations are UI data and should not be stored in the scene.
* Introducion of workspaces caused some (expected) glitches with transform orientations. Mainly when removing one.
* Improves code.

More technically speaking, this commit does:
* Move list of custom transform orientations from Scene to WorkSpace struct.
* Store active transform orientation index separate from View3D.twmode (twmode can only be set to preprocessor defined values now).
* Display custom transform orientation name in header when transforming in it (used to show "global" which isn't really correct).

1 files changed, 44 insertions, 55 deletions

diff --git a/source/blender/editors/transform/transform_orientations.c b/source/blender/editors/transform/transform_orientations.c
index 2ba640500c7..5aa391f1f0b 100644
--- a/source/blender/editors/transform/transform_orientations.c
+++ b/source/blender/editors/transform/transform_orientations.c
@@ -52,6 +52,7 @@
 #include "BKE_report.h"
 #include "BKE_main.h"
 #include "BKE_screen.h"
+#include "BKE_workspace.h"
 
 #include "BLT_translation.h"
 
@@ -63,14 +64,16 @@
 
 void BIF_clearTransformOrientation(bContext *C)
 {
+	WorkSpace *workspace = CTX_wm_workspace(C);
+	ListBase *transform_orientations = BKE_workspace_transform_orientations_get(workspace);
 	View3D *v3d = CTX_wm_view3d(C);
 
-	ListBase *transform_spaces = &CTX_data_scene(C)->transform_spaces;
-	BLI_freelistN(transform_spaces);
+	BLI_freelistN(transform_orientations);
 	
 	// Need to loop over all view3d
-	if (v3d && v3d->twmode >= V3D_MANIP_CUSTOM) {
-		v3d->twmode = V3D_MANIP_GLOBAL; /* fallback to global	*/
+	if (v3d && v3d->twmode == V3D_MANIP_CUSTOM) {
+		v3d->twmode = V3D_MANIP_GLOBAL; /* fallback to global */
+		v3d->custom_orientation_index = -1;
 	}
 }
 
@@ -318,23 +321,24 @@ void BIF_createTransformOrientation(bContext *C, ReportList *reports,
 TransformOrientation *addMatrixSpace(bContext *C, float mat[3][3],
                                      const char *name, const bool overwrite)
 {
-	ListBase *transform_spaces = &CTX_data_scene(C)->transform_spaces;
 	TransformOrientation *ts = NULL;
+	WorkSpace *workspace = CTX_wm_workspace(C);
+	ListBase *transform_orientations = BKE_workspace_transform_orientations_get(workspace);
 	char name_unique[sizeof(ts->name)];
 
 	if (overwrite) {
-		ts = findOrientationName(transform_spaces, name);
+		ts = findOrientationName(transform_orientations, name);
 	}
 	else {
 		BLI_strncpy(name_unique, name, sizeof(name_unique));
-		uniqueOrientationName(transform_spaces, name_unique);
+		uniqueOrientationName(transform_orientations, name_unique);
 		name = name_unique;
 	}
 
 	/* if not, create a new one */
 	if (ts == NULL) {
 		ts = MEM_callocN(sizeof(TransformOrientation), "UserTransSpace from matrix");
-		BLI_addtail(transform_spaces, ts);
+		BLI_addtail(transform_orientations, ts);
 		BLI_strncpy(ts->name, name, sizeof(ts->name));
 	}
 
@@ -346,72 +350,55 @@ TransformOrientation *addMatrixSpace(bContext *C, float mat[3][3],
 
 void BIF_removeTransformOrientation(bContext *C, TransformOrientation *target)
 {
-	Scene *scene = CTX_data_scene(C);
-	ListBase *transform_spaces = &scene->transform_spaces;
-	const int i = BLI_findindex(transform_spaces, target);
-
-	if (i != -1) {
-		Main *bmain = CTX_data_main(C);
-		BKE_screen_view3d_main_twmode_remove(&bmain->screen, scene, i);
-		BLI_freelinkN(transform_spaces, target);
-	}
+	BKE_workspace_transform_orientation_remove(CTX_wm_workspace(C), target);
 }
 
 void BIF_removeTransformOrientationIndex(bContext *C, int index)
 {
-	ListBase *transform_spaces = &CTX_data_scene(C)->transform_spaces;
-	TransformOrientation *ts = BLI_findlink(transform_spaces, index);
-
-	if (ts) {
-		BIF_removeTransformOrientation(C, ts);
-	}
+	TransformOrientation *target = BKE_workspace_transform_orientation_find(CTX_wm_workspace(C), index);
+	BIF_removeTransformOrientation(C, target);
 }
 
 void BIF_selectTransformOrientation(bContext *C, TransformOrientation *target)
 {
-	ListBase *transform_spaces = &CTX_data_scene(C)->transform_spaces;
-	const int i = BLI_findindex(transform_spaces, target);
+	int index = BKE_workspace_transform_orientation_get_index(CTX_wm_workspace(C), target);
+	View3D *v3d = CTX_wm_view3d(C);
 
-	if (i != -1) {
-		View3D *v3d = CTX_wm_view3d(C);
-		v3d->twmode = V3D_MANIP_CUSTOM + i;
-	}
+	BLI_assert(index != -1);
+
+	v3d->twmode = V3D_MANIP_CUSTOM;
+	v3d->custom_orientation_index = index;
 }
 
-void BIF_selectTransformOrientationValue(bContext *C, int orientation)
+/**
+ * Activate a transform orientation in a 3D view based on an enum value.
+ *
+ * \param orientation: If this is #V3D_MANIP_CUSTOM or greater, the custom transform orientation
+ *                     with index \a orientation - #V3D_MANIP_CUSTOM gets activated.
+ */
+void BIF_selectTransformOrientationValue(View3D *v3d, int orientation)
 {
-	View3D *v3d = CTX_wm_view3d(C);
+	const bool is_custom = orientation >= V3D_MANIP_CUSTOM;
 
-	if (v3d) { /* currently using generic poll */
-		v3d->twmode = orientation;
-	}
+	v3d->twmode = is_custom ? V3D_MANIP_CUSTOM : orientation;
+	v3d->custom_orientation_index = is_custom ? (orientation - V3D_MANIP_CUSTOM) : -1;
 }
 
 int BIF_countTransformOrientation(const bContext *C)
 {
-	ListBase *transform_spaces = &CTX_data_scene(C)->transform_spaces;
-	return BLI_listbase_count(transform_spaces);
+	WorkSpace *workspace = CTX_wm_workspace(C);
+	ListBase *transform_orientations = BKE_workspace_transform_orientations_get(workspace);
+	return BLI_listbase_count(transform_orientations);
 }
 
-bool applyTransformOrientation(const bContext *C, float mat[3][3], char *r_name, int index)
+bool applyTransformOrientation(const TransformOrientation *ts, float r_mat[3][3], char *r_name)
 {
-	ListBase *transform_spaces = &CTX_data_scene(C)->transform_spaces;
-	TransformOrientation *ts = BLI_findlink(transform_spaces, index);
-
-	BLI_assert(index >= 0);
-
-	if (ts) {
-		if (r_name) {
-			BLI_strncpy(r_name, ts->name, MAX_NAME);
-		}
-
-		copy_m3_m3(mat, ts->mat);
-		return true;
-	}
-	else {
-		/* invalid index, can happen sometimes */
-		return false;
+	if (r_name) {
+		BLI_strncpy(r_name, ts->name, MAX_NAME);
 	}
+	copy_m3_m3(r_mat, ts->mat);
+
+	return true;
 }
 
 static int count_bone_select(bArmature *arm, ListBase *lb, const bool do_it)
@@ -494,8 +481,10 @@ void initTransformOrientation(bContext *C, TransInfo *t)
 				unit_m3(t->spacemtx);
 			}
 			break;
-		default: /* V3D_MANIP_CUSTOM */
-			if (applyTransformOrientation(C, t->spacemtx, t->spacename, t->current_orientation - V3D_MANIP_CUSTOM)) {
+		case V3D_MANIP_CUSTOM:
+			BLI_strncpy(t->spacename, t->custom_orientation->name, sizeof(t->spacename));
+
+			if (applyTransformOrientation(t->custom_orientation, t->spacemtx, t->spacename)) {
 				/* pass */
 			}
 			else {