Camera tracking integration
[blender.git] / source / blender / blenkernel / BKE_context.h
index 5af97a7d8d5e9aff4f984951c3f95ee3a7097498..1c82468dffc9345dbae3d8a689e30bc965b27d8c 100644 (file)
@@ -1,4 +1,4 @@
-/**
+/*
  * $Id$
  *
  * ***** BEGIN GPL LICENSE BLOCK *****
@@ -15,7 +15,7 @@
  *
  * 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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  *
  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
  * All rights reserved.
 #ifndef BKE_CONTEXT_H
 #define BKE_CONTEXT_H
 
+/** \file BKE_context.h
+ *  \ingroup bke
+ */
+
+#include "DNA_listBase.h"
+#include "RNA_types.h"
+
 #ifdef __cplusplus
 extern "C" {
 #endif
 
-#include "DNA_listBase.h"
-
 struct ARegion;
 struct bScreen;
 struct EditMesh;
@@ -50,11 +55,16 @@ struct RegionView3D;
 struct StructRNA;
 struct ToolSettings;
 struct Image;
+struct Text;
 struct ImBuf;
 struct EditBone;
 struct bPoseChannel;
 struct wmWindow;
 struct wmWindowManager;
+struct SpaceText;
+struct SpaceImage;
+struct SpaceClip;
+struct ID;
 
 /* Structs */
 
@@ -64,62 +74,63 @@ typedef struct bContext bContext;
 struct bContextDataResult;
 typedef struct bContextDataResult bContextDataResult;
 
-enum {
-       CTX_DATA_MAIN,
-       CTX_DATA_SCENE,
-       CTX_DATA_TOOL_SETTINGS,
-
-       CTX_DATA_SELECTED_OBJECTS,
-       CTX_DATA_SELECTED_BASES,
-       CTX_DATA_SELECTED_EDITABLE_OBJECTS,
-       CTX_DATA_SELECTED_EDITABLE_BASES,
-       CTX_DATA_VISIBLE_OBJECTS,
-       CTX_DATA_VISIBLE_BASES,
+typedef int (*bContextDataCallback)(const bContext *C,
+       const char *member, bContextDataResult *result);
 
-       CTX_DATA_ACTIVE_OBJECT,
-       CTX_DATA_ACTIVE_BASE,
-       CTX_DATA_EDIT_OBJECT,
+typedef struct bContextStoreEntry {
+       struct bContextStoreEntry *next, *prev;
 
-       CTX_DATA_EDIT_IMAGE,
-       CTX_DATA_EDIT_IMAGE_BUFFER,
+       char name[128];
+       PointerRNA ptr;
+} bContextStoreEntry;
 
-       CTX_DATA_SELECTED_NODES,
-       
-       CTX_DATA_SELECTED_BONES,
-       CTX_DATA_SELECTED_EDITABLE_BONES,
-       CTX_DATA_SELECTED_PCHANS,
-       
-       CTX_DATA_ACTIVE_BONE,
-       CTX_DATA_ACTIVE_PCHAN,
-};
+typedef struct bContextStore {
+       struct bContextStore *next, *prev;
 
-typedef int bContextDataMember;
+       ListBase entries;
+       int used;
+} bContextStore;
 
-typedef int (*bContextDataCallback)(const bContext *C,
-       bContextDataMember member, bContextDataResult *result);
+/* for the conrtext's rna mode enum
+ * keep aligned with data_mode_strings in context.c */
+enum {
+       CTX_MODE_EDIT_MESH = 0,
+       CTX_MODE_EDIT_CURVE,
+       CTX_MODE_EDIT_SURFACE,
+       CTX_MODE_EDIT_TEXT,
+       CTX_MODE_EDIT_ARMATURE,
+       CTX_MODE_EDIT_METABALL,
+       CTX_MODE_EDIT_LATTICE,
+       CTX_MODE_POSE,
+       CTX_MODE_SCULPT,
+       CTX_MODE_PAINT_WEIGHT,
+       CTX_MODE_PAINT_VERTEX,
+       CTX_MODE_PAINT_TEXTURE,
+       CTX_MODE_PARTICLE,
+       CTX_MODE_OBJECT
+};
 
 /* Context */
 
 bContext *CTX_create(void);
 void CTX_free(bContext *C);
 
-bContext *CTX_copy(const bContext *C, int thread);
-int CTX_thread(const bContext *C);
+bContext *CTX_copy(const bContext *C);
 
-/* Context Task and Reports */
+/* Stored Context */
 
-typedef enum bContextTask {
-       CTX_DRAWING = 0,
-       CTX_EDITING = 1,
-       CTX_EVALUATING = 2,
-       CTX_UNDEFINED = 3
-} bContextTask;
+bContextStore *CTX_store_add(ListBase *contexts, const char *name, PointerRNA *ptr);
+void CTX_store_set(bContext *C, bContextStore *store);
+bContextStore *CTX_store_copy(bContextStore *store);
+void CTX_store_free(bContextStore *store);
+void CTX_store_free_list(ListBase *contexts);
 
-bContextTask CTX_task(const bContext *C);
-void CTX_task_set(bContext *C, bContextTask task);
+/* need to store if python is initialized or not */
+int CTX_py_init_get(bContext *C);
+void CTX_py_init_set(bContext *C, int value);
 
-struct ReportList *CTX_reports(const bContext *C);
-void CTX_reports_set(bContext *C, struct ReportList *reports);
+void *CTX_py_dict_get(const bContext *C);
+void CTX_py_dict_set(bContext *C, void *value);
 
 /* Window Manager Context */
 
@@ -128,34 +139,81 @@ struct wmWindow *CTX_wm_window(const bContext *C);
 struct bScreen *CTX_wm_screen(const bContext *C);
 struct ScrArea *CTX_wm_area(const bContext *C);
 struct SpaceLink *CTX_wm_space_data(const bContext *C);
-struct View3D *CTX_wm_view3d(const bContext *C);
-struct RegionView3D *CTX_wm_region_view3d(const bContext *C);
 struct ARegion *CTX_wm_region(const bContext *C);
 void *CTX_wm_region_data(const bContext *C);
-struct uiBlock *CTX_wm_ui_block(const bContext *C);
+struct ARegion *CTX_wm_menu(const bContext *C);
+struct ReportList *CTX_wm_reports(const bContext *C);
+
+struct View3D *CTX_wm_view3d(const bContext *C);
+struct RegionView3D *CTX_wm_region_view3d(const bContext *C);
+struct SpaceText *CTX_wm_space_text(const bContext *C);
+struct SpaceImage *CTX_wm_space_image(const bContext *C);
+struct SpaceConsole *CTX_wm_space_console(const bContext *C);
+struct SpaceButs *CTX_wm_space_buts(const bContext *C);
+struct SpaceFile *CTX_wm_space_file(const bContext *C);
+struct SpaceSeq *CTX_wm_space_seq(const bContext *C);
+struct SpaceOops *CTX_wm_space_outliner(const bContext *C);
+struct SpaceNla *CTX_wm_space_nla(const bContext *C);
+struct SpaceTime *CTX_wm_space_time(const bContext *C);
+struct SpaceNode *CTX_wm_space_node(const bContext *C);
+struct SpaceLogic *CTX_wm_space_logic(const bContext *C);
+struct SpaceIpo *CTX_wm_space_graph(const bContext *C);
+struct SpaceAction *CTX_wm_space_action(const bContext *C);
+struct SpaceInfo *CTX_wm_space_info(const bContext *C);
+struct SpaceUserPref *CTX_wm_space_userpref(const bContext *C);
+struct SpaceClip *CTX_wm_space_clip(const bContext *C);
 
 void CTX_wm_manager_set(bContext *C, struct wmWindowManager *wm);
 void CTX_wm_window_set(bContext *C, struct wmWindow *win);
 void CTX_wm_screen_set(bContext *C, struct bScreen *screen); /* to be removed */
-void CTX_wm_area_set(bContext *C, struct ScrArea *win);
-void CTX_wm_region_set(bContext *C, struct ARegion *win);
-void CTX_wm_ui_block_set(bContext *C, struct uiBlock *block, bContextDataCallback cb);
+void CTX_wm_area_set(bContext *C, struct ScrArea *sa);
+void CTX_wm_region_set(bContext *C, struct ARegion *region);
+void CTX_wm_menu_set(bContext *C, struct ARegion *menu);
+const char *CTX_wm_operator_poll_msg_get(struct bContext *C);
+void CTX_wm_operator_poll_msg_set(struct bContext *C, const char *msg);
 
 /* Data Context
 
-   - note: listbases consist of LinkData items and must be
-     freed with BLI_freelistN! */
+   - listbases consist of CollectionPointerLink items and must be
+        freed with BLI_freelistN!
+   - the dir listbase consits of LinkData items */
+
+/* data type, needed so we can tell between a NULL pointer and an empty list */
+enum {
+       CTX_DATA_TYPE_POINTER = 0,
+       CTX_DATA_TYPE_COLLECTION
+};
+
+PointerRNA CTX_data_pointer_get(const bContext *C, const char *member);
+PointerRNA CTX_data_pointer_get_type(const bContext *C, const char *member, StructRNA *type);
+ListBase CTX_data_collection_get(const bContext *C, const char *member);
+ListBase CTX_data_dir_get(const bContext *C);
+int CTX_data_get(const bContext *C, const char *member, PointerRNA *r_ptr, ListBase *r_lb, short *r_type);
+
+void CTX_data_id_pointer_set(bContextDataResult *result, struct ID *id);
+void CTX_data_pointer_set(bContextDataResult *result, struct ID *id, StructRNA *type, void *data);
+
+void CTX_data_id_list_add(bContextDataResult *result, struct ID *id);
+void CTX_data_list_add(bContextDataResult *result, struct ID *id, StructRNA *type, void *data);
+
+void CTX_data_dir_set(bContextDataResult *result, const char **member);
 
-void CTX_data_pointer_set(bContextDataResult *result, void *data);
-void CTX_data_list_add(bContextDataResult *result, void *data);
+void CTX_data_type_set(struct bContextDataResult *result, short type);
+short CTX_data_type_get(struct bContextDataResult *result);
+
+int CTX_data_equals(const char *member, const char *str);
+int CTX_data_dir(const char *member);
+
+/*void CTX_data_pointer_set(bContextDataResult *result, void *data);
+void CTX_data_list_add(bContextDataResult *result, void *data);*/
 
 #define CTX_DATA_BEGIN(C, Type, instance, member) \
        { \
                ListBase ctx_data_list; \
-               LinkData *link; \
+               CollectionPointerLink *ctx_link; \
                CTX_data_##member(C, &ctx_data_list); \
-               for(link=ctx_data_list.first; link; link=link->next) { \
-                       Type instance= link->data;
+               for(ctx_link=ctx_data_list.first; ctx_link; ctx_link=ctx_link->next) { \
+                       Type instance= ctx_link->ptr.data;
 
 #define CTX_DATA_END \
                } \
@@ -173,6 +231,9 @@ struct Main *CTX_data_main(const bContext *C);
 struct Scene *CTX_data_scene(const bContext *C);
 struct ToolSettings *CTX_data_tool_settings(const bContext *C);
 
+const char *CTX_data_mode_string(const bContext *C);
+int CTX_data_mode_enum(const bContext *C);
+
 void CTX_data_main_set(bContext *C, struct Main *bmain);
 void CTX_data_scene_set(bContext *C, struct Scene *bmain);
 
@@ -185,28 +246,29 @@ int CTX_data_selected_bases(const bContext *C, ListBase *list);
 int CTX_data_visible_objects(const bContext *C, ListBase *list);
 int CTX_data_visible_bases(const bContext *C, ListBase *list);
 
+int CTX_data_selectable_objects(const bContext *C, ListBase *list);
+int CTX_data_selectable_bases(const bContext *C, ListBase *list);
+
 struct Object *CTX_data_active_object(const bContext *C);
 struct Base *CTX_data_active_base(const bContext *C);
 struct Object *CTX_data_edit_object(const bContext *C);
 
 struct Image *CTX_data_edit_image(const bContext *C);
-struct ImBuf *CTX_data_edit_image_buffer(const bContext *C);
+
+struct Text *CTX_data_edit_text(const bContext *C);
+struct MovieClip *CTX_data_edit_movieclip(const bContext *C);
 
 int CTX_data_selected_nodes(const bContext *C, ListBase *list);
 
 struct EditBone *CTX_data_active_bone(const bContext *C);
 int CTX_data_selected_bones(const bContext *C, ListBase *list);
 int CTX_data_selected_editable_bones(const bContext *C, ListBase *list);
+int CTX_data_visible_bones(const bContext *C, ListBase *list);
+int CTX_data_editable_bones(const bContext *C, ListBase *list);
 
-struct bPoseChannel *CTX_data_active_pchan(const bContext *C);
-int CTX_data_selected_pchans(const bContext *C, ListBase *list);
-
-/* Data Evaluation Context */
-
-float CTX_eval_frame(const bContext *C);
-
-int CTX_eval_render_resolution(const bContext *C);
-void CTX_eval_render_resolution_set(bContext *C, int render);
+struct bPoseChannel *CTX_data_active_pose_bone(const bContext *C);
+int CTX_data_selected_pose_bones(const bContext *C, ListBase *list);
+int CTX_data_visible_pose_bones(const bContext *C, ListBase *list);
 
 #ifdef __cplusplus
 }