Merge branch 'blender2.7'
[blender.git] / source / blender / makesdna / DNA_cachefile_types.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) 2016 Blender Foundation.
19  * All rights reserved.
20  *
21  * Contributor(s): Kevin Dietrich.
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  */
25
26 /** \file DNA_cachefile_types.h
27  *  \ingroup DNA
28  */
29
30 #ifndef __DNA_CACHEFILE_TYPES_H__
31 #define __DNA_CACHEFILE_TYPES_H__
32
33 #include "DNA_ID.h"
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 /* CacheFile::flag */
40 enum {
41         CACHEFILE_DS_EXPAND = (1 << 0),
42         CACHEFILE_DIRTY     = (1 << 1),
43 };
44
45 /* CacheFile::draw_flag */
46 enum {
47         CACHEFILE_KEYFRAME_DRAWN = (1 << 0),
48 };
49
50 /* Representation of an object's path inside the Alembic file.
51  * Note that this is not a file path. */
52 typedef struct AlembicObjectPath {
53         struct AlembicObjectPath *next, *prev;
54
55         char path[4096];
56 } AlembicObjectPath;
57
58 typedef struct CacheFile {
59         ID id;
60         struct AnimData *adt;
61
62         struct AbcArchiveHandle *handle;
63         void *handle_mutex;
64
65         /** Paths of the objects inside of the Alembic archive referenced by this CacheFile. */
66         ListBase object_paths;
67
68         /** 1024 = FILE_MAX. */
69         char filepath[1024];
70
71         char is_sequence;
72         char forward_axis;
73         char up_axis;
74         char override_frame;
75
76         float scale;
77         /** The frame/time to lookup in the cache file. */
78         float frame;
79         /** The frame offset to subtract. */
80         float frame_offset;
81
82         /** Animation flag. */
83         short flag;
84         short draw_flag;
85
86         char padding[4];
87 } CacheFile;
88
89 #ifdef __cplusplus
90 }
91 #endif
92
93 #endif  /* __DNA_CACHEFILE_TYPES_H__ */