Refactor: Rename Object->obmat to Object->object_to_world

Motivation is to disambiguate on the naming level what the matrix
actually means. It is very easy to understand the meaning backwards,
especially since in Python the name goes the opposite way (it is
called `world_matrix` in the Python API).

It is important to disambiguate the naming without making developers
to look into the comment in the header file (which is also not super
clear either). Additionally, more clear naming facilitates the unit
verification (or, in this case, space validation) when reading an
expression.

This patch calls the matrix `object_to_world` which makes it clear
from the local code what is it exactly going on. This is only done
on DNA level, and a lot of local variables still follow the old
naming.

A DNA rename is setup in a way that there is no change on the file
level, so there should be no regressions at all.

The possibility is to add `_matrix` or `_mat` suffix to the name
to make it explicit that it is a matrix. Although, not sure if it
really helps the readability, or is it something redundant.

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

4 files changed, 23 insertions, 23 deletions

diff --git a/source/blender/editors/curve/editcurve.c b/source/blender/editors/curve/editcurve.c
index 61e92f0a1c3..2b6cce25bb7 100644
--- a/source/blender/editors/curve/editcurve.c
+++ b/source/blender/editors/curve/editcurve.c
@@ -4999,7 +4999,7 @@ bool ed_editnurb_spin(
   invert_m3_m3(persinv, persmat);
 
   /* imat and center and size */
-  copy_m3_m4(bmat, obedit->obmat);
+  copy_m3_m4(bmat, obedit->object_to_world);
   invert_m3_m3(imat, bmat);
 
   axis_angle_to_mat3(cmat, axis, M_PI_4);
@@ -5095,7 +5095,7 @@ static int spin_exec(bContext *C, wmOperator *op)
       continue;
     }
 
-    invert_m4_m4(obedit->imat, obedit->obmat);
+    invert_m4_m4(obedit->imat, obedit->object_to_world);
     mul_m4_v3(obedit->imat, cent);
 
     if (!ed_editnurb_spin(viewmat, v3d, obedit, axis, cent)) {
@@ -5574,7 +5574,7 @@ static int add_vertex_exec(bContext *C, wmOperator *op)
 
   RNA_float_get_array(op->ptr, "location", location);
 
-  invert_m4_m4(imat, obedit->obmat);
+  invert_m4_m4(imat, obedit->object_to_world);
   mul_m4_v3(imat, location);
 
   if (ed_editcurve_addvert(cu, editnurb, v3d, location)) {
@@ -5614,10 +5614,10 @@ static int add_vertex_invoke(bContext *C, wmOperator *op, const wmEvent *event)
     ED_curve_nurb_vert_selected_find(cu, vc.v3d, &nu, &bezt, &bp);
 
     if (bezt) {
-      mul_v3_m4v3(location, vc.obedit->obmat, bezt->vec[1]);
+      mul_v3_m4v3(location, vc.obedit->object_to_world, bezt->vec[1]);
     }
     else if (bp) {
-      mul_v3_m4v3(location, vc.obedit->obmat, bp->vec);
+      mul_v3_m4v3(location, vc.obedit->object_to_world, bp->vec);
     }
     else {
       copy_v3_v3(location, vc.scene->cursor.location);
@@ -5662,8 +5662,8 @@ static int add_vertex_invoke(bContext *C, wmOperator *op, const wmEvent *event)
       /* get the plane */
       float plane[4];
       /* only normalize to avoid precision errors */
-      normalize_v3_v3(plane, vc.obedit->obmat[2]);
-      plane[3] = -dot_v3v3(plane, vc.obedit->obmat[3]);
+      normalize_v3_v3(plane, vc.obedit->object_to_world[2]);
+      plane[3] = -dot_v3v3(plane, vc.obedit->object_to_world[3]);
 
       if (fabsf(dot_v3v3(view_dir, plane)) < eps) {
         /* can't project on an aligned plane. */
@@ -6924,7 +6924,7 @@ int ED_curve_join_objects_exec(bContext *C, wmOperator *op)
 
   /* Inverse transform for all selected curves in this object,
    * See #object_join_exec for detailed comment on why the safe version is used. */
-  invert_m4_m4_safe_ortho(imat, ob_active->obmat);
+  invert_m4_m4_safe_ortho(imat, ob_active->object_to_world);
 
   Curve *cu_active = ob_active->data;
 
@@ -6936,7 +6936,7 @@ int ED_curve_join_objects_exec(bContext *C, wmOperator *op)
 
         if (cu->nurb.first) {
           /* watch it: switch order here really goes wrong */
-          mul_m4_m4m4(cmat, imat, ob_iter->obmat);
+          mul_m4_m4m4(cmat, imat, ob_iter->object_to_world);
 
           /* Compensate for different bevel depth. */
           bool do_radius = false;
diff --git a/source/blender/editors/curve/editcurve_paint.c b/source/blender/editors/curve/editcurve_paint.c
index 7632f1b1e64..1e91e2f48fc 100644
--- a/source/blender/editors/curve/editcurve_paint.c
+++ b/source/blender/editors/curve/editcurve_paint.c
@@ -148,7 +148,7 @@ static void stroke_elem_pressure_set(const struct CurveDrawData *cdd,
     const float adjust = stroke_elem_radius_from_pressure(cdd, pressure) -
                          stroke_elem_radius_from_pressure(cdd, selem->pressure);
     madd_v3_v3fl(selem->location_local, selem->normal_local, adjust);
-    mul_v3_m4v3(selem->location_world, cdd->vc.obedit->obmat, selem->location_local);
+    mul_v3_m4v3(selem->location_world, cdd->vc.obedit->object_to_world, selem->location_local);
   }
   selem->pressure = pressure;
 }
@@ -249,7 +249,7 @@ static bool stroke_elem_project_fallback(const struct CurveDrawData *cdd,
 
   if (!is_zero_v3(r_normal_world)) {
     copy_v3_v3(r_normal_local, r_normal_world);
-    mul_transposed_mat3_m4_v3(cdd->vc.obedit->obmat, r_normal_local);
+    mul_transposed_mat3_m4_v3(cdd->vc.obedit->object_to_world, r_normal_local);
     normalize_v3(r_normal_local);
   }
   else {
@@ -367,7 +367,7 @@ static void curve_draw_stroke_3d(const struct bContext *UNUSED(C),
 
     /* scale to edit-mode space */
     GPU_matrix_push();
-    GPU_matrix_mul(obedit->obmat);
+    GPU_matrix_mul(obedit->object_to_world);
 
     BLI_mempool_iternew(cdd->stroke_elem_pool, &iter);
     for (selem = BLI_mempool_iterstep(&iter); selem; selem = BLI_mempool_iterstep(&iter)) {
@@ -445,7 +445,7 @@ static void curve_draw_event_add(wmOperator *op, const wmEvent *event)
   struct CurveDrawData *cdd = op->customdata;
   Object *obedit = cdd->vc.obedit;
 
-  invert_m4_m4(obedit->imat, obedit->obmat);
+  invert_m4_m4(obedit->imat, obedit->object_to_world);
 
   struct StrokeElem *selem = BLI_mempool_calloc(cdd->stroke_elem_pool);
 
@@ -758,7 +758,7 @@ static int curve_draw_exec(bContext *C, wmOperator *op)
   int stroke_len = BLI_mempool_len(cdd->stroke_elem_pool);
 
   const bool is_3d = (cu->flag & CU_3D) != 0;
-  invert_m4_m4(obedit->imat, obedit->obmat);
+  invert_m4_m4(obedit->imat, obedit->object_to_world);
 
   if (BLI_mempool_len(cdd->stroke_elem_pool) == 0) {
     curve_draw_stroke_from_operator(op);
@@ -1073,8 +1073,8 @@ static int curve_draw_invoke(bContext *C, wmOperator *op, const wmEvent *event)
 
     if (CU_IS_2D(cu)) {
       /* 2D overrides other options */
-      plane_co = obedit->obmat[3];
-      plane_no = obedit->obmat[2];
+      plane_co = obedit->object_to_world[3];
+      plane_no = obedit->object_to_world[2];
       cdd->project.use_plane = true;
     }
     else {
diff --git a/source/blender/editors/curve/editcurve_pen.c b/source/blender/editors/curve/editcurve_pen.c
index f71173f951e..b57ce6fc7cf 100644
--- a/source/blender/editors/curve/editcurve_pen.c
+++ b/source/blender/editors/curve/editcurve_pen.c
@@ -152,8 +152,8 @@ static void update_location_for_2d_curve(const ViewContext *vc, float location[3
     /* Get the plane. */
     float plane[4];
     /* Only normalize to avoid precision errors. */
-    normalize_v3_v3(plane, vc->obedit->obmat[2]);
-    plane[3] = -dot_v3v3(plane, vc->obedit->obmat[3]);
+    normalize_v3_v3(plane, vc->obedit->object_to_world[2]);
+    plane[3] = -dot_v3v3(plane, vc->obedit->object_to_world[3]);
 
     if (fabsf(dot_v3v3(view_dir, plane)) < eps) {
       /* Can't project on an aligned plane. */
@@ -173,7 +173,7 @@ static void update_location_for_2d_curve(const ViewContext *vc, float location[3
   }
 
   float imat[4][4];
-  invert_m4_m4(imat, vc->obedit->obmat);
+  invert_m4_m4(imat, vc->obedit->object_to_world);
   mul_m4_v3(imat, location);
 
   if (CU_IS_2D(cu)) {
@@ -186,7 +186,7 @@ static void screenspace_to_worldspace(const ViewContext *vc,
                                       const float depth[3],
                                       float r_pos_3d[3])
 {
-  mul_v3_m4v3(r_pos_3d, vc->obedit->obmat, depth);
+  mul_v3_m4v3(r_pos_3d, vc->obedit->object_to_world, depth);
   ED_view3d_win_to_3d(vc->v3d, vc->region, r_pos_3d, pos_2d, r_pos_3d);
   update_location_for_2d_curve(vc, r_pos_3d);
 }
@@ -1082,7 +1082,7 @@ static void extrude_points_from_selected_vertices(const ViewContext *vc,
 
   float location[3];
   if (sel_exists) {
-    mul_v3_m4v3(location, vc->obedit->obmat, center);
+    mul_v3_m4v3(location, vc->obedit->object_to_world, center);
   }
   else {
     copy_v3_v3(location, vc->scene->cursor.location);
diff --git a/source/blender/editors/curve/editcurve_select.c b/source/blender/editors/curve/editcurve_select.c
index 9c0c580f699..da742dd0c61 100644
--- a/source/blender/editors/curve/editcurve_select.c
+++ b/source/blender/editors/curve/editcurve_select.c
@@ -1517,7 +1517,7 @@ static void nurb_bezt_direction_worldspace_get(Object *ob,
 {
   float rsmat[3][3];
   BKE_nurb_bezt_calc_normal(nu, bezt, r_dir);
-  copy_m3_m4(rsmat, ob->obmat);
+  copy_m3_m4(rsmat, ob->object_to_world);
   mul_m3_v3(rsmat, r_dir);
   normalize_v3(r_dir);
 }
@@ -1526,7 +1526,7 @@ static void nurb_bpoint_direction_worldspace_get(Object *ob, Nurb *nu, BPoint *b
 {
   float rsmat[3][3];
   BKE_nurb_bpoint_calc_normal(nu, bp, r_dir);
-  copy_m3_m4(rsmat, ob->obmat);
+  copy_m3_m4(rsmat, ob->object_to_world);
   mul_m3_v3(rsmat, r_dir);
   normalize_v3(r_dir);
 }