Object Mode: move logic to 'object_modes.c'
authorCampbell Barton <ideasman42@gmail.com>
Fri, 2 Mar 2018 02:53:17 +0000 (13:53 +1100)
committerCampbell Barton <ideasman42@gmail.com>
Fri, 2 Mar 2018 03:00:47 +0000 (14:00 +1100)
Was mixed with edit-mode, centralize mode switching in a single file.

No functional changes.

source/blender/editors/animation/keyframing.c
source/blender/editors/armature/pose_edit.c
source/blender/editors/include/ED_object.h
source/blender/editors/object/CMakeLists.txt
source/blender/editors/object/object_edit.c
source/blender/editors/object/object_modes.c [new file with mode: 0644]
source/blender/editors/util/ed_util.c

index 94dc15278a18859d0f5b9ca22e720807910dcd98..9c30b6c30a041a56cf277845893be6e56c87e1cc 100644 (file)
@@ -1356,7 +1356,7 @@ static int insert_key_exec(bContext *C, wmOperator *op)
         * updated since the last switching to the edit mode will be keyframed correctly
         */
        if (obedit && ANIM_keyingset_find_id(ks, (ID *)obedit->data)) {
-               ED_object_toggle_modes(C, OB_MODE_EDIT);
+               ED_object_mode_toggle(C, OB_MODE_EDIT);
                ob_edit_mode = true;
        }
        
@@ -1367,7 +1367,7 @@ static int insert_key_exec(bContext *C, wmOperator *op)
        
        /* restore the edit mode if necessary */
        if (ob_edit_mode) {
-               ED_object_toggle_modes(C, OB_MODE_EDIT);
+               ED_object_mode_toggle(C, OB_MODE_EDIT);
        }
 
        /* report failure or do updates? */
index 2181a6d5ac9821ee87f7acc83f247222c1f6ee3a..2f536ebff6ec5c6a7be93c5bc131c5617384e547 100644 (file)
@@ -104,7 +104,7 @@ void ED_armature_enter_posemode(bContext *C, Base *base)
        }
        
        /* XXX: disabled as this would otherwise cause a nasty loop... */
-       //ED_object_toggle_modes(C, ob->mode);
+       //ED_object_mode_toggle(C, ob->mode);
 }
 
 void ED_armature_exit_posemode(bContext *C, Base *base)
index 4baec6a58eff5ebe62864c4fe9c63ae201f79510..91b931028144339f41548c5dcfd954117d77ccc0 100644 (file)
@@ -111,9 +111,6 @@ struct Base *ED_object_add_duplicate(struct Main *bmain, struct Scene *scene, st
 
 void ED_object_parent(struct Object *ob, struct Object *parent, const int type, const char *substr);
 
-bool ED_object_mode_compat_set(struct bContext *C, struct Object *ob, eObjectMode mode, struct ReportList *reports);
-void ED_object_toggle_modes(struct bContext *C, eObjectMode mode);
-
 /* bitflags for enter/exit editmode */
 #define EM_FREEDATA     1
 #define EM_FREEUNDO     2
@@ -199,6 +196,11 @@ void undo_push_lattice(struct bContext *C, const char *name);
 
 void ED_lattice_flags_set(struct Object *obedit, int flag);
 
+/* object_modes.c */
+bool ED_object_mode_compat_test(const struct Object *ob, eObjectMode mode);
+bool ED_object_mode_compat_set(struct bContext *C, struct Object *ob, eObjectMode mode, struct ReportList *reports);
+void ED_object_mode_toggle(struct bContext *C, eObjectMode mode);
+
 /* object_modifier.c */
 enum {
        MODIFIER_APPLY_DATA = 1,
index b3d02d45e13231ea1e6b26a8d3962fd5ecfedb4d..a2d3a3ede07b37138a226122e893858b77918f65 100644 (file)
@@ -50,6 +50,7 @@ set(SRC
        object_hook.c
        object_lattice.c
        object_lod.c
+       object_modes.c
        object_modifier.c
        object_ops.c
        object_random.c
index dc010ac40ec0fb5b14f3e3a0a1b9ec34b816ba35..84808817b94be36ade06b936cfa262bb0baec3dc 100644 (file)
@@ -553,7 +553,7 @@ void ED_object_editmode_enter(bContext *C, int flag)
        /* note, when switching scenes the object can have editmode data but
         * not be scene->obedit: bug 22954, this avoids calling self eternally */
        if ((ob->restore_mode & OB_MODE_EDIT) == 0)
-               ED_object_toggle_modes(C, ob->mode);
+               ED_object_mode_toggle(C, ob->mode);
 
        ob->mode = OB_MODE_EDIT;
 
@@ -1670,91 +1670,6 @@ static const EnumPropertyItem *object_mode_set_itemsf(
        return item;
 }
 
-static const char *object_mode_op_string(eObjectMode mode)
-{
-       if (mode & OB_MODE_EDIT)
-               return "OBJECT_OT_editmode_toggle";
-       if (mode == OB_MODE_SCULPT)
-               return "SCULPT_OT_sculptmode_toggle";
-       if (mode == OB_MODE_VERTEX_PAINT)
-               return "PAINT_OT_vertex_paint_toggle";
-       if (mode == OB_MODE_WEIGHT_PAINT)
-               return "PAINT_OT_weight_paint_toggle";
-       if (mode == OB_MODE_TEXTURE_PAINT)
-               return "PAINT_OT_texture_paint_toggle";
-       if (mode == OB_MODE_PARTICLE_EDIT)
-               return "PARTICLE_OT_particle_edit_toggle";
-       if (mode == OB_MODE_POSE)
-               return "OBJECT_OT_posemode_toggle";
-       if (mode == OB_MODE_GPENCIL)
-               return "GPENCIL_OT_editmode_toggle";
-       return NULL;
-}
-
-/* checks the mode to be set is compatible with the object
- * should be made into a generic function
- */
-static bool object_mode_compat_test(Object *ob, eObjectMode mode)
-{
-       if (ob) {
-               if (mode == OB_MODE_OBJECT)
-                       return true;
-               else if (mode == OB_MODE_GPENCIL)
-                       return true; /* XXX: assume this is the case for now... */
-
-               switch (ob->type) {
-                       case OB_MESH:
-                               if (mode & (OB_MODE_EDIT | OB_MODE_SCULPT | OB_MODE_VERTEX_PAINT | OB_MODE_WEIGHT_PAINT |
-                                           OB_MODE_TEXTURE_PAINT | OB_MODE_PARTICLE_EDIT))
-                               {
-                                       return true;
-                               }
-                               break;
-                       case OB_CURVE:
-                       case OB_SURF:
-                       case OB_FONT:
-                       case OB_MBALL:
-                               if (mode & (OB_MODE_EDIT))
-                                       return true;
-                               break;
-                       case OB_LATTICE:
-                               if (mode & (OB_MODE_EDIT | OB_MODE_WEIGHT_PAINT))
-                                       return true;
-                               break;
-                       case OB_ARMATURE:
-                               if (mode & (OB_MODE_EDIT | OB_MODE_POSE))
-                                       return true;
-                               break;
-               }
-       }
-
-       return false;
-}
-
-/**
- * Sets the mode to a compatible state (use before entering the mode).
- *
- * This is so each mode's exec function can call
- */
-bool ED_object_mode_compat_set(bContext *C, Object *ob, eObjectMode mode, ReportList *reports)
-{
-       bool ok;
-       if (!ELEM(ob->mode, mode, OB_MODE_OBJECT)) {
-               const char *opstring = object_mode_op_string(ob->mode);
-               WM_operator_name_call(C, opstring, WM_OP_EXEC_REGION_WIN, NULL);
-               ok = ELEM(ob->mode, mode, OB_MODE_OBJECT);
-               if (!ok) {
-                       wmOperatorType *ot = WM_operatortype_find(opstring, false);
-                       BKE_reportf(reports, RPT_ERROR, "Unable to execute '%s', error changing modes", ot->name);
-               }
-       }
-       else {
-               ok = true;
-       }
-
-       return ok;
-}
-
 static int object_mode_set_poll(bContext *C)
 {
        /* Since Grease Pencil editmode is also handled here,
@@ -1794,7 +1709,7 @@ static int object_mode_set_exec(bContext *C, wmOperator *op)
                }
        }
        
-       if (!ob || !object_mode_compat_test(ob, mode))
+       if (!ob || !ED_object_mode_compat_test(ob, mode))
                return OPERATOR_PASS_THROUGH;
 
        if (ob->mode != mode) {
@@ -1805,20 +1720,20 @@ static int object_mode_set_exec(bContext *C, wmOperator *op)
        /* Exit current mode if it's not the mode we're setting */
        if (mode != OB_MODE_OBJECT && (ob->mode != mode || toggle)) {
                /* Enter new mode */
-               ED_object_toggle_modes(C, mode);
+               ED_object_mode_toggle(C, mode);
        }
 
        if (toggle) {
                /* Special case for Object mode! */
                if (mode == OB_MODE_OBJECT && restore_mode == OB_MODE_OBJECT && ob->restore_mode != OB_MODE_OBJECT) {
-                       ED_object_toggle_modes(C, ob->restore_mode);
+                       ED_object_mode_toggle(C, ob->restore_mode);
                }
                else if (ob->mode == mode) {
                        /* For toggling, store old mode so we know what to go back to */
                        ob->restore_mode = restore_mode;
                }
                else if (ob->restore_mode != OB_MODE_OBJECT && ob->restore_mode != mode) {
-                       ED_object_toggle_modes(C, ob->restore_mode);
+                       ED_object_mode_toggle(C, ob->restore_mode);
                }
        }
 
@@ -1850,16 +1765,6 @@ void OBJECT_OT_mode_set(wmOperatorType *ot)
        RNA_def_property_flag(prop, PROP_SKIP_SAVE);
 }
 
-void ED_object_toggle_modes(bContext *C, eObjectMode mode)
-{
-       if (mode != OB_MODE_OBJECT) {
-               const char *opstring = object_mode_op_string(mode);
-               if (opstring) {
-                       WM_operator_name_call(C, opstring, WM_OP_EXEC_REGION_WIN, NULL);
-               }
-       }
-}
-
 /************************ Game Properties ***********************/
 
 static int game_property_new_exec(bContext *C, wmOperator *op)
diff --git a/source/blender/editors/object/object_modes.c b/source/blender/editors/object/object_modes.c
new file mode 100644 (file)
index 0000000..fda342f
--- /dev/null
@@ -0,0 +1,138 @@
+/*
+ * ***** BEGIN GPL LICENSE BLOCK *****
+ *
+ * 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.
+ *
+ * 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,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ *
+ * Contributor(s): Blender Foundation, 2002-2008 full recode
+ *
+ * ***** END GPL LICENSE BLOCK *****
+ */
+
+/** \file blender/editors/object/object_modes.c
+ *  \ingroup edobj
+ *
+ * General utils to handle mode switching,
+ * actual mode switching logic is per-object type.
+ */
+
+#include "DNA_object_types.h"
+#include "DNA_scene_types.h"
+
+#include "BLI_utildefines.h"
+
+#include "BKE_context.h"
+#include "BKE_report.h"
+
+#include "WM_api.h"
+#include "WM_types.h"
+
+#include "ED_object.h"
+
+static const char *object_mode_op_string(eObjectMode mode)
+{
+       if (mode & OB_MODE_EDIT)
+               return "OBJECT_OT_editmode_toggle";
+       if (mode == OB_MODE_SCULPT)
+               return "SCULPT_OT_sculptmode_toggle";
+       if (mode == OB_MODE_VERTEX_PAINT)
+               return "PAINT_OT_vertex_paint_toggle";
+       if (mode == OB_MODE_WEIGHT_PAINT)
+               return "PAINT_OT_weight_paint_toggle";
+       if (mode == OB_MODE_TEXTURE_PAINT)
+               return "PAINT_OT_texture_paint_toggle";
+       if (mode == OB_MODE_PARTICLE_EDIT)
+               return "PARTICLE_OT_particle_edit_toggle";
+       if (mode == OB_MODE_POSE)
+               return "OBJECT_OT_posemode_toggle";
+       if (mode == OB_MODE_GPENCIL)
+               return "GPENCIL_OT_editmode_toggle";
+       return NULL;
+}
+
+/**
+ * Checks the mode to be set is compatible with the object
+ * should be made into a generic function
+ */
+bool ED_object_mode_compat_test(const Object *ob, eObjectMode mode)
+{
+       if (ob) {
+               if (mode == OB_MODE_OBJECT)
+                       return true;
+               else if (mode == OB_MODE_GPENCIL)
+                       return true; /* XXX: assume this is the case for now... */
+
+               switch (ob->type) {
+                       case OB_MESH:
+                               if (mode & (OB_MODE_EDIT | OB_MODE_SCULPT | OB_MODE_VERTEX_PAINT | OB_MODE_WEIGHT_PAINT |
+                                           OB_MODE_TEXTURE_PAINT | OB_MODE_PARTICLE_EDIT))
+                               {
+                                       return true;
+                               }
+                               break;
+                       case OB_CURVE:
+                       case OB_SURF:
+                       case OB_FONT:
+                       case OB_MBALL:
+                               if (mode & (OB_MODE_EDIT))
+                                       return true;
+                               break;
+                       case OB_LATTICE:
+                               if (mode & (OB_MODE_EDIT | OB_MODE_WEIGHT_PAINT))
+                                       return true;
+                               break;
+                       case OB_ARMATURE:
+                               if (mode & (OB_MODE_EDIT | OB_MODE_POSE))
+                                       return true;
+                               break;
+               }
+       }
+
+       return false;
+}
+
+
+/**
+ * Sets the mode to a compatible state (use before entering the mode).
+ *
+ * This is so each mode's exec function can call
+ */
+bool ED_object_mode_compat_set(bContext *C, Object *ob, eObjectMode mode, ReportList *reports)
+{
+       bool ok;
+       if (!ELEM(ob->mode, mode, OB_MODE_OBJECT)) {
+               const char *opstring = object_mode_op_string(ob->mode);
+               WM_operator_name_call(C, opstring, WM_OP_EXEC_REGION_WIN, NULL);
+               ok = ELEM(ob->mode, mode, OB_MODE_OBJECT);
+               if (!ok) {
+                       wmOperatorType *ot = WM_operatortype_find(opstring, false);
+                       BKE_reportf(reports, RPT_ERROR, "Unable to execute '%s', error changing modes", ot->name);
+               }
+       }
+       else {
+               ok = true;
+       }
+
+       return ok;
+}
+
+void ED_object_mode_toggle(bContext *C, eObjectMode mode)
+{
+       if (mode != OB_MODE_OBJECT) {
+               const char *opstring = object_mode_op_string(mode);
+               if (opstring) {
+                       WM_operator_name_call(C, opstring, WM_OP_EXEC_REGION_WIN, NULL);
+               }
+       }
+}
index b34605f6af3f03064681f077e46880291e6b4ee3..57ff8b6db01d17dd3f46f2aca3a558e1d96d39e1 100644 (file)
@@ -106,7 +106,7 @@ void ED_editors_init(bContext *C)
                        data = ob->data;
 
                        if (ob == obact && !ID_IS_LINKED(ob) && !(data && ID_IS_LINKED(data)))
-                               ED_object_toggle_modes(C, mode);
+                               ED_object_mode_toggle(C, mode);
                }
        }