diff options
Diffstat (limited to 'source/blender/makesdna/DNA_cache_library_types.h')
| -rw-r--r-- | source/blender/makesdna/DNA_cache_library_types.h | 294 |
1 files changed, 294 insertions, 0 deletions
diff --git a/source/blender/makesdna/DNA_cache_library_types.h b/source/blender/makesdna/DNA_cache_library_types.h new file mode 100644 index 00000000000..0def355e7d5 --- /dev/null +++ b/source/blender/makesdna/DNA_cache_library_types.h @@ -0,0 +1,294 @@ +/* + * ***** BEGIN GPL LICENSE BLOCK ***** + * + * This program is free software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License + * as published by the Free Software Foundation; either version 2 + * of the License, or (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program; if not, write to the Free Software Foundation, + * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * + * The Original Code is Copyright (C) 2015 by Blender Foundation + * All rights reserved. + * + * The Original Code is: all of this file. + * + * Contributor(s): none yet. + * + * ***** END GPL LICENSE BLOCK ***** + */ + +/** \file DNA_cache_library_types.h + * \ingroup DNA + */ + +#ifndef __DNA_CACHE_LIBRARY_TYPES_H__ +#define __DNA_CACHE_LIBRARY_TYPES_H__ + +#include "DNA_defs.h" +#include "DNA_ID.h" +#include "DNA_listBase.h" + +#define MAX_CACHE_GROUP_LEVEL 8 + +typedef enum eCacheLibrary_SourceMode { + CACHE_LIBRARY_SOURCE_SCENE = 0, /* use generated scene data as input */ + CACHE_LIBRARY_SOURCE_CACHE = 1, /* use cached data as input*/ +} eCacheLibrary_SourceMode; + +typedef enum eCacheLibrary_DisplayMode { + CACHE_LIBRARY_DISPLAY_SOURCE = 0, /* display source data */ + CACHE_LIBRARY_DISPLAY_RESULT = 1, /* display result data */ + CACHE_LIBRARY_DISPLAY_MODIFIERS = 2, /* display input with modifiers */ +} eCacheLibrary_DisplayMode; + +typedef enum eCacheDataType { + CACHE_TYPE_OBJECT = (1 << 0), + CACHE_TYPE_DERIVED_MESH = (1 << 1), + CACHE_TYPE_HAIR = (1 << 2), + CACHE_TYPE_HAIR_PATHS = (1 << 3), + CACHE_TYPE_PARTICLES = (1 << 4), + + CACHE_TYPE_ALL = CACHE_TYPE_OBJECT | CACHE_TYPE_DERIVED_MESH | CACHE_TYPE_HAIR | CACHE_TYPE_HAIR_PATHS | CACHE_TYPE_PARTICLES, +} eCacheDataType; + +typedef enum eCacheReadSampleResult { + CACHE_READ_SAMPLE_INVALID = 0, /* no valid result can be retrieved */ + CACHE_READ_SAMPLE_EARLY = 1, /* request time before first sample */ + CACHE_READ_SAMPLE_LATE = 2, /* request time after last sample */ + CACHE_READ_SAMPLE_EXACT = 3, /* found sample for requested frame */ + CACHE_READ_SAMPLE_INTERPOLATED = 4, /* no exact sample, but found enclosing samples for interpolation */ +} eCacheReadSampleResult; + +typedef enum eCacheLibrary_Flag { + CACHE_LIBRARY_BAKING = (1 << 0), /* perform modifier evaluation when evaluating */ +} eCacheLibrary_Flag; + +typedef enum eCacheLibrary_DisplayFlag { + CACHE_LIBRARY_DISPLAY_MOTION = (1 << 0), /* display motion state result from simulation, if available */ + CACHE_LIBRARY_DISPLAY_CHILDREN = (1 << 1), /* display child strands, if available */ +} eCacheLibrary_DisplayFlag; + +typedef struct CacheLibrary { + ID id; + + int flag; + short eval_mode DNA_DEPRECATED; + short source_mode; + short display_mode; + short pad; + int display_flag; + int render_flag DNA_DEPRECATED; + int data_types; + struct Group *filter_group; + char description[256]; + + char input_filepath[1024]; /* 1024 = FILE_MAX */ + char output_filepath[1024]; /* 1024 = FILE_MAX */ + + ListBase modifiers; + + struct CacheArchiveInfo *archive_info; +} CacheLibrary; + +/* ========================================================================= */ + +/* These are runtime structs, included in DNA only for easier RNA parsing */ + +typedef struct CacheArchiveInfoNode { + struct CacheArchiveInfoNode *next, *prev; + + short type; + short flag; + int pad; + char name[256]; + + ListBase child_nodes; + + int64_t bytes_size; /* overall size of data stored in this node and children */ + + char datatype_name[64]; + short datatype_extent; + short pad2; + + int num_samples; + + /* array properties */ + int array_size; + int pad3; +} CacheArchiveInfoNode; + +typedef enum eCacheArchiveInfoNode_Flag { + eCacheArchiveInfoNode_Flag_Expand, +} eCacheArchiveInfoNode_Flag; + +typedef enum eCacheArchiveInfoNode_Type { + eCacheArchiveInfoNode_Type_Object, + eCacheArchiveInfoNode_Type_ScalarProperty, + eCacheArchiveInfoNode_Type_ArrayProperty, + eCacheArchiveInfoNode_Type_CompoundProperty, +} eCacheArchiveInfoNode_Type; + +typedef struct CacheArchiveInfo { + char filepath[1024]; /* FILE_MAX */ + + char app_name[64]; /* MAX_NAME */ + char date_written[64]; /* MAX_NAME */ + char description[256]; + + struct CacheArchiveInfoNode *root_node; +} CacheArchiveInfo; + +/* ========================================================================= */ + +/* XXX here be dragons ... + * stuff below is a production hack, + * should not be considered a permanent solution ... + */ +typedef struct CacheModifier { + struct CacheModifier *next, *prev; + + short type, pad; + int flag; + char name[64]; /* MAX_NAME */ +} CacheModifier; + +typedef enum eCacheModifier_Type { + eCacheModifierType_None = 0, + + eCacheModifierType_HairSimulation = 1, + eCacheModifierType_ForceField = 2, + eCacheModifierType_ShrinkWrap = 3, + eCacheModifierType_StrandsKey = 4, + eCacheModifierType_Haircut = 5, + + NUM_CACHE_MODIFIER_TYPES +} eCacheModifier_Type; + +typedef struct HairSimParams { + int flag; + float timescale; + int substeps; + int pad; + + struct EffectorWeights *effector_weights; + + float mass; + float drag; + float goal_stiffness, goal_damping; + struct CurveMapping *goal_stiffness_mapping; + float stretch_stiffness, stretch_damping; + float bend_stiffness, bend_damping; + struct CurveMapping *bend_stiffness_mapping; +} HairSimParams; + +typedef enum eHairSimParams_Flag { + eHairSimParams_Flag_UseGoalStiffnessCurve = (1 << 0), + eHairSimParams_Flag_UseBendStiffnessCurve = (1 << 1), + eHairSimParams_Flag_UseGoalDeflect = (1 << 2), +} eHairSimParams_Flag; + +typedef struct HairSimCacheModifier { + CacheModifier modifier; + + struct Object *object; + int hair_system; + int pad; + + HairSimParams sim_params; +} HairSimCacheModifier; + +/* cached mesh data for calculating velocities */ +typedef struct ForceFieldVertexCache { + float frame_prev; + int totvert; + float (*co_prev)[3]; + float (*vel)[3]; +} ForceFieldVertexCache; + +typedef struct ForceFieldCacheModifier { + CacheModifier modifier; + + struct Object *object; + + struct ForceFieldVertexCache *vertex_cache; + + int type; + int flag; + float strength; + float min_distance, max_distance; + float falloff; +} ForceFieldCacheModifier; + +typedef enum eForceFieldCacheModifier_Type { + eForceFieldCacheModifier_Type_Deflect = 0, + eForceFieldCacheModifier_Type_Drag = 1, +} eForceFieldCacheModifier_Type; + +typedef enum eForceFieldCacheModifier_Flag { + eForceFieldCacheModifier_Flag_DoubleSided = (1 << 0), +} eForceFieldCacheModifier_Flag; + +typedef struct ShrinkWrapCacheModifier { + CacheModifier modifier; + + struct Object *object; + int hair_system; + int flag; + + struct Object *target; +} ShrinkWrapCacheModifier; + +typedef enum eShrinkWrapCacheModifier_Flag { + eShrinkWrapCacheModifier_Flag_InternalTarget = (1 << 0), +} eShrinkWrapCacheModifier_Flag; + +typedef struct StrandsKeyCacheModifier { + CacheModifier modifier; + + struct Object *object; + int hair_system; + int flag; + + struct Key *key; + int shapenr; + int pad; + + struct BMEditStrands *edit; /* edit data (runtime) */ +} StrandsKeyCacheModifier; + +typedef enum eStrandsKeyCacheModifier_Flag { + eStrandsKeyCacheModifier_Flag_ShapeLock = (1 << 0), + eStrandsKeyCacheModifier_Flag_UseMotionState = (1 << 1), +} eStrandsKeyCacheModifier_Flag; + +typedef struct HaircutCacheModifier { + CacheModifier modifier; + + struct Object *object; + int hair_system; + int flag; + + short cut_mode; + short pad[3]; + + struct Object *target; +} HaircutCacheModifier; + +typedef enum eHaircutCacheModifier_Flag { + eHaircutCacheModifier_Flag_InternalTarget = (1 << 0), +} eHaircutCacheModifier_Flag; + +typedef enum eHaircutCacheModifier_CutMode { + eHaircutCacheModifier_CutMode_Enter = (1 << 0), + eHaircutCacheModifier_CutMode_Exit = (1 << 1), +} eHaircutCacheModifier_CutMode; + +#endif |