doxygen: add newline after \file
[blender.git] / source / blender / blenkernel / BKE_outliner_treehash.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  */
16 #ifndef __BKE_OUTLINER_TREEHASH_H__
17 #define __BKE_OUTLINER_TREEHASH_H__
18
19 /** \file
20  * \ingroup bke
21  */
22
23 struct BLI_mempool;
24 struct ID;
25 struct TreeStoreElem;
26
27 /* create and fill hashtable with treestore elements */
28 void *BKE_outliner_treehash_create_from_treestore(struct BLI_mempool *treestore);
29
30 /* full rebuild for already allocated hashtable */
31 void *BKE_outliner_treehash_rebuild_from_treestore(void *treehash, struct BLI_mempool *treestore);
32
33 /* clear element usage flags */
34 void BKE_outliner_treehash_clear_used(void *treehash);
35
36 /* Add/remove hashtable elements */
37 void BKE_outliner_treehash_add_element(void *treehash, struct TreeStoreElem *elem);
38 void BKE_outliner_treehash_remove_element(void *treehash, struct TreeStoreElem *elem);
39
40 /* find first unused element with specific type, nr and id */
41 struct TreeStoreElem *BKE_outliner_treehash_lookup_unused(void *treehash, short type, short nr, struct ID *id);
42
43 /* find user or unused element with specific type, nr and id */
44 struct TreeStoreElem *BKE_outliner_treehash_lookup_any(void *treehash, short type, short nr, struct ID *id);
45
46 /* free treehash structure */
47 void BKE_outliner_treehash_free(void *treehash);
48
49 #endif