Merge branch 'blender2.7'
[blender.git] / source / blender / makesdna / DNA_collection_types.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  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 /** \file \ingroup DNA
21  *
22  * \brief Object groups, one object can be in many groups at once.
23  */
24
25 #ifndef __DNA_COLLECTION_TYPES_H__
26 #define __DNA_COLLECTION_TYPES_H__
27
28 #include "DNA_defs.h"
29 #include "DNA_listBase.h"
30 #include "DNA_ID.h"
31
32 struct Collection;
33 struct Object;
34
35 typedef struct CollectionObject {
36         struct CollectionObject *next, *prev;
37         struct Object *ob;
38 } CollectionObject;
39
40
41 typedef struct CollectionChild {
42         struct CollectionChild *next, *prev;
43         struct Collection *collection;
44 } CollectionChild;
45
46
47 typedef struct Collection {
48         ID id;
49
50         /** CollectionObject. */
51         ListBase gobject;
52         /** CollectionChild. */
53         ListBase children;
54
55         struct PreviewImage *preview;
56
57         unsigned int layer DNA_DEPRECATED;
58         float dupli_ofs[3];
59
60         short flag, pad[3];
61
62         /* Runtime. Cache of objects in this collection and all its
63          * children. This is created on demand when e.g. some physics
64          * simulation needs it, we don't want to have it for every
65          * collections due to memory usage reasons. */
66         ListBase object_cache;
67
68         /* Runtime. List of collections that are a parent of this
69          * datablock. */
70         ListBase parents;
71
72         /* Deprecated */
73         struct SceneCollection *collection DNA_DEPRECATED;
74         struct ViewLayer *view_layer DNA_DEPRECATED;
75 } Collection;
76
77 /* Collection->flag */
78 enum {
79         COLLECTION_RESTRICT_VIEW       = (1 << 0), /* Hidden in viewport. */
80         COLLECTION_RESTRICT_SELECT     = (1 << 1), /* Not selectable in viewport. */
81         COLLECTION_DISABLED_DEPRECATED = (1 << 2), /* Not used anymore */
82         COLLECTION_RESTRICT_RENDER     = (1 << 3), /* Hidden in renders. */
83         COLLECTION_HAS_OBJECT_CACHE    = (1 << 4), /* Runtime: object_cache is populated. */
84         COLLECTION_IS_MASTER           = (1 << 5), /* Is master collection embedded in the scene. */
85 };
86
87 #endif  /* __DNA_COLLECTION_TYPES_H__ */