Merge branch 'master' into blender2.8
[blender.git] / source / blender / blenkernel / BKE_outliner_treehash.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  * Contributor(s): Blender Foundation 2013
19  *
20  * ***** END GPL LICENSE BLOCK *****
21  */
22 #ifndef __BKE_OUTLINER_TREEHASH_H__
23 #define __BKE_OUTLINER_TREEHASH_H__
24
25 /** \file BKE_outliner_treehash.h
26  *  \ingroup bke
27  */
28
29 struct ID;
30 struct BLI_mempool;
31 struct TreeStoreElem;
32
33 /* create and fill hashtable with treestore elements */
34 void *BKE_outliner_treehash_create_from_treestore(struct BLI_mempool *treestore);
35
36 /* full rebuild for already allocated hashtable */
37 void *BKE_outliner_treehash_rebuild_from_treestore(void *treehash, struct BLI_mempool *treestore);
38
39 /* Add/remove hashtable elements */
40 void BKE_outliner_treehash_add_element(void *treehash, struct TreeStoreElem *elem);
41 void BKE_outliner_treehash_remove_element(void *treehash, struct TreeStoreElem *elem);
42
43 /* find first unused element with specific type, nr and id */
44 struct TreeStoreElem *BKE_outliner_treehash_lookup_unused(void *treehash, short type, short nr, struct ID *id);
45
46 /* find user or unused element with specific type, nr and id */
47 struct TreeStoreElem *BKE_outliner_treehash_lookup_any(void *treehash, short type, short nr, struct ID *id);
48
49 /* free treehash structure */
50 void BKE_outliner_treehash_free(void *treehash);
51
52 #endif