source/blender/editors/space_outliner/outliner_intern.h

   1 /*
   2  * ***** BEGIN GPL LICENSE BLOCK *****
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public License
   6  * as published by the Free Software Foundation; either version 2
   7  * of the License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program; if not, write to the Free Software Foundation,
  16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  17  *
  18  * The Original Code is Copyright (C) 2008 Blender Foundation.
  19  * All rights reserved.
  20  *
  21  *
  22  * Contributor(s): Blender Foundation
  23  *
  24  * ***** END GPL LICENSE BLOCK *****
  25  */
  26
  27 /** \file blender/editors/space_outliner/outliner_intern.h
  28  *  \ingroup spoutliner
  29  */
  30
  31
  32 #ifndef ED_OUTLINER_INTERN_H
  33 #define ED_OUTLINER_INTERN_H
  34
  35 #include "RNA_types.h"
  36
  37 /* internal exports only */
  38
  39 struct wmWindowManager;
  40 struct wmOperatorType;
  41 struct TreeStoreElem;
  42 struct bContext;
  43 struct Scene;
  44 struct ARegion;
  45 struct ID;
  46 struct Object;
  47
  48 typedef struct TreeElement {
  49         struct TreeElement *next, *prev, *parent;
  50         ListBase subtree;
  51         float xs, ys;           // do selection
  52         int store_index;        // offset in tree store
  53         short flag;                     // flag for non-saved stuff
  54         short index;            // index for data arrays
  55         short idcode;           // from TreeStore id
  56         short xend;                     // width of item display, for select
  57         const char *name;
  58         void *directdata;       // Armature Bones, Base, Sequence, Strip...
  59         PointerRNA rnaptr;      // RNA Pointer
  60 }  TreeElement;
  61
  62 /* TreeElement->flag */
  63 #define TE_ACTIVE               1
  64 #define TE_ICONROW              2
  65 #define TE_LAZY_CLOSED  4
  66 #define TE_FREE_NAME    8
  67
  68 /* TreeStoreElem types */
  69 #define TSE_NLA                         1
  70 #define TSE_NLA_ACTION          2
  71 #define TSE_DEFGROUP_BASE       3
  72 #define TSE_DEFGROUP            4
  73 #define TSE_BONE                        5
  74 #define TSE_EBONE                       6
  75 #define TSE_CONSTRAINT_BASE     7
  76 #define TSE_CONSTRAINT          8
  77 #define TSE_MODIFIER_BASE       9
  78 #define TSE_MODIFIER            10
  79 #define TSE_LINKED_OB           11
  80 #define TSE_SCRIPT_BASE         12
  81 #define TSE_POSE_BASE           13
  82 #define TSE_POSE_CHANNEL        14
  83 #define TSE_ANIM_DATA           15
  84 #define TSE_DRIVER_BASE         16
  85 #define TSE_DRIVER                      17
  86
  87 #define TSE_PROXY                       18
  88 #define TSE_R_LAYER_BASE        19
  89 #define TSE_R_LAYER                     20
  90 #define TSE_R_PASS                      21
  91 #define TSE_LINKED_MAT          22
  92 /* NOTE, is used for light group */
  93 #define TSE_LINKED_LAMP         23
  94 #define TSE_POSEGRP_BASE        24
  95 #define TSE_POSEGRP                     25
  96 #define TSE_SEQUENCE            26
  97 #define TSE_SEQ_STRIP           27
  98 #define TSE_SEQUENCE_DUP        28
  99 #define TSE_LINKED_PSYS     29
 100 #define TSE_RNA_STRUCT          30
 101 #define TSE_RNA_PROPERTY        31
 102 #define TSE_RNA_ARRAY_ELEM      32
 103 #define TSE_NLA_TRACK           33
 104 #define TSE_KEYMAP                      34
 105 #define TSE_KEYMAP_ITEM         35
 106
 107 /* button events */
 108 #define OL_NAMEBUTTON           1
 109
 110 /* get TreeStoreElem associated with a TreeElement
 111  * < a: (TreeElement) tree element to find stored element for
 112  */
 113 #define TREESTORE(a) ((a)?soops->treestore->data+(a)->store_index:NULL)
 114
 115 /* size constants */
 116 #define OL_Y_OFFSET     2
 117
 118 #define OL_TOG_RESTRICT_VIEWX   (UI_UNIT_X*3)
 119 #define OL_TOG_RESTRICT_SELECTX (UI_UNIT_X*2)
 120 #define OL_TOG_RESTRICT_RENDERX UI_UNIT_X
 121
 122 #define OL_TOGW OL_TOG_RESTRICT_VIEWX
 123
 124 #define OL_RNA_COLX                     (UI_UNIT_X*15)
 125 #define OL_RNA_COL_SIZEX        (UI_UNIT_X*7.5f)
 126 #define OL_RNA_COL_SPACEX       (UI_UNIT_X*2.5f)
 127
 128
 129 /* Outliner Searching --
 130
 131    Are we looking for something in the outliner?
 132    If so finding matches in child items makes it more useful
 133
 134          - We want to flag parents to act as being open to filter child matches
 135          - and also flag matches so we can highlight them
 136          - Flags are stored in TreeStoreElem->flag
 137          - Flag options defined in DNA_outliner_types.h
 138          - SO_SEARCH_RECURSIVE defined in DNA_space_types.h
 139
 140          - NOT in datablocks view - searching all datablocks takes way too long
 141                 to be useful
 142          - not searching into RNA items helps but isn't the complete solution
 143         */
 144
 145 #define SEARCHING_OUTLINER(sov)   (sov->search_flags & SO_SEARCH_RECURSIVE)
 146
 147 /* is the currrent element open? if so we also show children */
 148 #define TSELEM_OPEN(telm,sv)    ( (telm->flag & TSE_CLOSED)==0 || (SEARCHING_OUTLINER(sv) && (telm->flag & TSE_CHILDSEARCH)) )
 149
 150 /* outliner_tree.c ----------------------------------------------- */
 151
 152 void outliner_free_tree(ListBase *lb);
 153 void outliner_cleanup_tree(struct SpaceOops *soops);
 154
 155 TreeElement *outliner_find_tse(struct SpaceOops *soops, TreeStoreElem *tse);
 156 TreeElement *outliner_find_id(struct SpaceOops *soops, ListBase *lb, struct ID *id);
 157 struct ID *outliner_search_back(SpaceOops *soops, TreeElement *te, short idcode);
 158
 159 void outliner_build_tree(struct Main *mainvar, struct Scene *scene, struct SpaceOops *soops);
 160
 161 /* outliner_draw.c ---------------------------------------------- */
 162
 163 void draw_outliner(const struct bContext *C);
 164 void restrictbutton_gr_restrict_flag(void *poin, void *poin2, int flag);
 165
 166 /* outliner_select.c -------------------------------------------- */
 167 int tree_element_type_active(struct bContext *C, struct Scene *scene, struct SpaceOops *soops, TreeElement *te, TreeStoreElem *tselem, int set);
 168 int tree_element_active(struct bContext *C, struct Scene *scene, SpaceOops *soops, TreeElement *te, int set);
 169
 170 /* outliner_edit.c ---------------------------------------------- */
 171
 172 void outliner_do_object_operation(struct bContext *C, struct Scene *scene, struct SpaceOops *soops, struct ListBase *lb,
 173                                                                   void (*operation_cb)(struct bContext *C, struct Scene *scene, struct TreeElement *, struct TreeStoreElem *, TreeStoreElem *));
 174
 175 int common_restrict_check(struct bContext *C, struct Object *ob);
 176
 177 int outliner_has_one_flag(struct SpaceOops *soops, ListBase *lb, short flag, short curlevel);
 178 void outliner_set_flag(struct SpaceOops *soops, ListBase *lb, short flag, short set);
 179
 180 void object_toggle_visibility_cb(struct bContext *C, struct Scene *scene, TreeElement *te, struct TreeStoreElem *tsep, struct TreeStoreElem *tselem);
 181 void object_toggle_selectability_cb(struct bContext *C, struct Scene *scene, TreeElement *te, struct TreeStoreElem *tsep, struct TreeStoreElem *tselem);
 182 void object_toggle_renderability_cb(struct bContext *C, struct Scene *scene, TreeElement *te, struct TreeStoreElem *tsep, struct TreeStoreElem *tselem);
 183
 184
 185 void group_toggle_visibility_cb(struct bContext *C, struct Scene *scene, TreeElement *te, struct TreeStoreElem *tsep, struct TreeStoreElem *tselem);
 186 void group_toggle_selectability_cb(struct bContext *C, struct Scene *scene, TreeElement *te, struct TreeStoreElem *tsep, struct TreeStoreElem *tselem);
 187 void group_toggle_renderability_cb(struct bContext *C, struct Scene *scene, TreeElement *te, struct TreeStoreElem *tsep, struct TreeStoreElem *tselem);
 188
 189 void item_rename_cb(struct bContext *C, struct Scene *scene, TreeElement *te, struct TreeStoreElem *tsep, struct TreeStoreElem *tselem);
 190
 191 /* ...................................................... */
 192
 193 void OUTLINER_OT_item_activate(struct wmOperatorType *ot);
 194 void OUTLINER_OT_item_openclose(struct wmOperatorType *ot);
 195 void OUTLINER_OT_item_rename(struct wmOperatorType *ot);
 196
 197 void OUTLINER_OT_show_one_level(struct wmOperatorType *ot);
 198 void OUTLINER_OT_show_active(struct wmOperatorType *ot);
 199 void OUTLINER_OT_show_hierarchy(struct wmOperatorType *ot);
 200
 201 void OUTLINER_OT_selected_toggle(struct wmOperatorType *ot);
 202 void OUTLINER_OT_expanded_toggle(struct wmOperatorType *ot);
 203
 204 void OUTLINER_OT_scroll_page(struct wmOperatorType *ot);
 205
 206 void OUTLINER_OT_renderability_toggle(struct wmOperatorType *ot);
 207 void OUTLINER_OT_selectability_toggle(struct wmOperatorType *ot);
 208 void OUTLINER_OT_visibility_toggle(struct wmOperatorType *ot);
 209
 210 void OUTLINER_OT_keyingset_add_selected(struct wmOperatorType *ot);
 211 void OUTLINER_OT_keyingset_remove_selected(struct wmOperatorType *ot);
 212
 213 void OUTLINER_OT_drivers_add_selected(struct wmOperatorType *ot);
 214 void OUTLINER_OT_drivers_delete_selected(struct wmOperatorType *ot);
 215
 216 /* outliner_tools.c ---------------------------------------------- */
 217
 218 void OUTLINER_OT_operation(struct wmOperatorType *ot);
 219 void OUTLINER_OT_object_operation(struct wmOperatorType *ot);
 220 void OUTLINER_OT_group_operation(struct wmOperatorType *ot);
 221 void OUTLINER_OT_id_operation(struct wmOperatorType *ot);
 222 void OUTLINER_OT_data_operation(struct wmOperatorType *ot);
 223 void OUTLINER_OT_animdata_operation(struct wmOperatorType *ot);
 224 void OUTLINER_OT_action_set(struct wmOperatorType *ot);
 225
 226 /* ---------------------------------------------------------------- */
 227
 228 /* outliner_ops.c */
 229 void outliner_operatortypes(void);
 230 void outliner_keymap(struct wmKeyConfig *keyconf);
 231
 232 #endif /* ED_OUTLINER_INTERN_H */