Page MenuHome
Differential D3860 Diff 20252 source/blender/makesdna/DNA_manta_types.h

Changeset View

Standalone View

View Options

source/blender/makesdna/DNA_manta_types.h

  • This file was added.
/*
* 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) 2006 by NaN Holding BV.
* All rights reserved.
*/
/** \file
* \ingroup DNA
*/
#ifndef __DNA_MANTA_TYPES_H__
#define __DNA_MANTA_TYPES_H__
/* Domain flags. */
enum {
FLUID_DOMAIN_USE_NOISE = (1 << 1), /* Use noise. */
FLUID_DOMAIN_USE_DISSOLVE = (1 << 2), /* Let smoke dissolve. */
FLUID_DOMAIN_USE_DISSOLVE_LOG = (1 << 3), /* Using 1/x for dissolve. */
#ifdef DNA_DEPRECATED
FLUID_DOMAIN_USE_HIGH_SMOOTH = (1 << 5), /* -- Deprecated -- */
#endif
FLUID_DOMAIN_FILE_LOAD = (1 << 6), /* Flag for file load. */
FLUID_DOMAIN_USE_ADAPTIVE_DOMAIN = (1 << 7),
FLUID_DOMAIN_USE_ADAPTIVE_TIME = (1 << 8), /* Adaptive time stepping in domain. */
FLUID_DOMAIN_USE_MESH = (1 << 9), /* Use mesh. */
FLUID_DOMAIN_USE_GUIDING = (1 << 10), /* Use guiding. */
FLUID_DOMAIN_USE_SPEED_VECTORS = (1 << 11), /* Generate mesh speed vectors. */
FLUID_DOMAIN_EXPORT_MANTA_SCRIPT = (1 << 12), /* Export mantaflow script during bake. */
FLUID_DOMAIN_USE_FRACTIONS = (1 << 13), /* Use second order obstacles. */
};
/* Border collisions. */
enum {
FLUID_DOMAIN_BORDER_FRONT = (1 << 1),
FLUID_DOMAIN_BORDER_BACK = (1 << 2),
FLUID_DOMAIN_BORDER_RIGHT = (1 << 3),
FLUID_DOMAIN_BORDER_LEFT = (1 << 4),
FLUID_DOMAIN_BORDER_TOP = (1 << 5),
FLUID_DOMAIN_BORDER_BOTTOM = (1 << 6),
};
/* Cache file formats. */
enum {
FLUID_DOMAIN_FILE_UNI = (1 << 0),
FLUID_DOMAIN_FILE_OPENVDB = (1 << 1),
FLUID_DOMAIN_FILE_RAW = (1 << 2),
FLUID_DOMAIN_FILE_OBJECT = (1 << 3),
FLUID_DOMAIN_FILE_BIN_OBJECT = (1 << 4),
};
/* Slice method. */
enum {
FLUID_DOMAIN_SLICE_VIEW_ALIGNED = 0,
FLUID_DOMAIN_SLICE_AXIS_ALIGNED = 1,
};
/* Axis aligned method. */
enum {
AXIS_SLICE_FULL = 0,
AXIS_SLICE_SINGLE = 1,
};
/* Single slice direction. */
enum {
SLICE_AXIS_AUTO = 0,
SLICE_AXIS_X = 1,
SLICE_AXIS_Y = 2,
SLICE_AXIS_Z = 3,
};
/* Axis aligned method. */
enum {
VOLUME_INTERP_LINEAR = 0,
VOLUME_INTERP_CUBIC = 1,
};
enum {
VECTOR_DRAW_NEEDLE = 0,
VECTOR_DRAW_STREAMLINE = 1,
};
enum {
SNDPARTICLE_BOUNDARY_DELETE = 0,
SNDPARTICLE_BOUNDARY_PUSHOUT = 1,
};
enum {
SNDPARTICLE_COMBINED_EXPORT_OFF = 0,
SNDPARTICLE_COMBINED_EXPORT_SPRAY_FOAM = 1,
SNDPARTICLE_COMBINED_EXPORT_SPRAY_BUBBLE = 2,
SNDPARTICLE_COMBINED_EXPORT_FOAM_BUBBLE = 3,
SNDPARTICLE_COMBINED_EXPORT_SPRAY_FOAM_BUBBLE = 4,
};
enum {
FLUID_DOMAIN_FIELD_DENSITY = 0,
FLUID_DOMAIN_FIELD_HEAT = 1,
FLUID_DOMAIN_FIELD_FUEL = 2,
FLUID_DOMAIN_FIELD_REACT = 3,
FLUID_DOMAIN_FIELD_FLAME = 4,
FLUID_DOMAIN_FIELD_VELOCITY_X = 5,
FLUID_DOMAIN_FIELD_VELOCITY_Y = 6,
FLUID_DOMAIN_FIELD_VELOCITY_Z = 7,
FLUID_DOMAIN_FIELD_COLOR_R = 8,
FLUID_DOMAIN_FIELD_COLOR_G = 9,
FLUID_DOMAIN_FIELD_COLOR_B = 10,
FLUID_DOMAIN_FIELD_FORCE_X = 11,
FLUID_DOMAIN_FIELD_FORCE_Y = 12,
FLUID_DOMAIN_FIELD_FORCE_Z = 13,
};
/* Fluid domain types. */
enum {
FLUID_DOMAIN_TYPE_GAS = 0,
FLUID_DOMAIN_TYPE_LIQUID = 1,
sergeyUnsubmitted
Done
Inline Actions

Use anonymous enum.

sergey: Use anonymous enum.
};
/* Smoke noise types. */
enum {
FLUID_NOISE_TYPE_WAVELET = (1 << 0),
};
/* Mesh levelset generator types. */
enum {
FLUID_DOMAIN_MESH_IMPROVED = 0,
FLUID_DOMAIN_MESH_UNION = 1,
};
/* Guiding velocity source. */
enum {
FLUID_DOMAIN_GUIDING_SRC_DOMAIN = 0,
FLUID_DOMAIN_GUIDING_SRC_EFFECTOR = 1,
};
/* Fluid data fields (active_fields). */
enum {
FLUID_DOMAIN_ACTIVE_HEAT = (1 << 0),
FLUID_DOMAIN_ACTIVE_FIRE = (1 << 1),
FLUID_DOMAIN_ACTIVE_COLORS = (1 << 2),
FLUID_DOMAIN_ACTIVE_COLOR_SET = (1 << 3),
FLUID_DOMAIN_ACTIVE_OBSTACLE = (1 << 4),
FLUID_DOMAIN_ACTIVE_GUIDING = (1 << 5),
FLUID_DOMAIN_ACTIVE_INVEL = (1 << 6),
FLUID_DOMAIN_ACTIVE_OUTFLOW = (1 << 7),
};
/* Particle types. */
enum {
FLUID_DOMAIN_PARTICLE_FLIP = (1 << 0),
FLUID_DOMAIN_PARTICLE_SPRAY = (1 << 1),
FLUID_DOMAIN_PARTICLE_BUBBLE = (1 << 2),
FLUID_DOMAIN_PARTICLE_FOAM = (1 << 3),
FLUID_DOMAIN_PARTICLE_TRACER = (1 << 4),
};
/* Liquid simulation methods. */
enum {
FLUID_DOMAIN_METHOD_FLIP = (1 << 0),
FLUID_DOMAIN_METHOD_APIC = (1 << 1),
};
/* Cache options. */
enum {
FLUID_DOMAIN_BAKING_DATA = (1 << 0),
FLUID_DOMAIN_BAKED_DATA = (1 << 1),
FLUID_DOMAIN_BAKING_NOISE = (1 << 2),
FLUID_DOMAIN_BAKED_NOISE = (1 << 3),
FLUID_DOMAIN_BAKING_MESH = (1 << 4),
FLUID_DOMAIN_BAKED_MESH = (1 << 5),
FLUID_DOMAIN_BAKING_PARTICLES = (1 << 6),
FLUID_DOMAIN_BAKED_PARTICLES = (1 << 7),
FLUID_DOMAIN_BAKING_GUIDING = (1 << 8),
FLUID_DOMAIN_BAKED_GUIDING = (1 << 9),
FLUID_DOMAIN_OUTDATED_DATA = (1 << 10),
FLUID_DOMAIN_OUTDATED_NOISE = (1 << 11),
FLUID_DOMAIN_OUTDATED_MESH = (1 << 12),
FLUID_DOMAIN_OUTDATED_PARTICLES = (1 << 13),
FLUID_DOMAIN_OUTDATED_GUIDING = (1 << 14),
};
#define FLUID_DOMAIN_DIR_DEFAULT "cache_fluid"
#define FLUID_DOMAIN_DIR_CONFIG "config"
#define FLUID_DOMAIN_DIR_DATA "data"
#define FLUID_DOMAIN_DIR_NOISE "noise"
#define FLUID_DOMAIN_DIR_MESH "mesh"
#define FLUID_DOMAIN_DIR_PARTICLES "particles"
#define FLUID_DOMAIN_DIR_GUIDING "guiding"
#define FLUID_DOMAIN_DIR_SCRIPT "script"
#define FLUID_DOMAIN_SMOKE_SCRIPT "smoke_script.py"
#define FLUID_DOMAIN_LIQUID_SCRIPT "liquid_script.py"
enum {
FLUID_DOMAIN_CACHE_REPLAY = 0,
FLUID_DOMAIN_CACHE_MODULAR = 1,
FLUID_DOMAIN_CACHE_FINAL = 2,
};
/* Deprecated values (i.e. all defines and enums below this line up until typedefs). */
/* Cache compression. */
enum {
SM_CACHE_LIGHT = 0,
sergeyUnsubmitted
Done
Inline Actions

This structure is either split entirely, or to be refactored in a way that it is clear what is a setting (aka, what user actually specifies in the interface and what is saved to disk) and what is a runtime-only fields.

This actually applies to other structures in this file.

sergey: This structure is either split entirely, or to be refactored in a way that it is clear what is…
sebbasAuthorUnsubmitted
Done
Inline Actions

The order of items in the structs was supposed to give an indication to this. I have added some comments to clarify which fields are being used internally and which are for the user to define.

Would this be sufficient?

sebbas: The order of items in the structs was supposed to give an indication to this. I have added some…
sergeyUnsubmitted
Done
Inline Actions

In other areas of DNA the convention is to have explicit field. See Object_Runtime as an example,

sergey: In other areas of DNA the convention is to have explicit field. See `Object_Runtime` as an…
SM_CACHE_HEAVY = 1,
};
/* High resolution sampling types. */
enum {
SM_HRES_NEAREST = 0,
SM_HRES_LINEAR = 1,
SM_HRES_FULLSAMPLE = 2,
};
enum {
VDB_COMPRESSION_BLOSC = 0,
VDB_COMPRESSION_ZIP = 1,
VDB_COMPRESSION_NONE = 2,
};
typedef struct FluidDomainVertexVelocity {
float vel[3];
} FluidDomainVertexVelocity;
typedef struct FluidDomainSettings {
/* -- Runtime-only fields (from here on). -- */
struct FluidModifierData *mmd; /* For fast RNA access. */
struct MANTA *fluid;
struct MANTA *fluid_old; /* Adaptive domain needs access to old fluid state. */
void *fluid_mutex;
struct Collection *fluid_group;
struct Collection *force_group; /* UNUSED */
struct Collection *effector_group; /* Effector objects group. */
struct GPUTexture *tex;
struct GPUTexture *tex_wt;
struct GPUTexture *tex_shadow;
struct GPUTexture *tex_flame;
struct GPUTexture *tex_flame_coba;
struct GPUTexture *tex_coba;
struct GPUTexture *tex_field;
struct GPUTexture *tex_velocity_x;
struct GPUTexture *tex_velocity_y;
struct GPUTexture *tex_velocity_z;
struct Object *guiding_parent;
struct FluidDomainVertexVelocity *mesh_velocities; /* Vertex velocities of simulated fluid mesh. */
struct EffectorWeights *effector_weights;
/* Domain object data. */
float
p0[3]; /* Start point of BB in local space (includes sub-cell shift for adaptive domain). */
float p1[3]; /* End point of BB in local space. */
float dp0[3]; /* Difference from object center to grid start point. */
float cell_size[3]; /* Size of simulation cell in local space. */
float global_size[3]; /* Global size of domain axises. */
float prev_loc[3];
int shift[3]; /* Current domain shift in simulation cells. */
float shift_f[3]; /* Exact domain shift. */
float obj_shift_f[3]; /* How much object has shifted since previous smoke frame (used to "lock"
* domain while drawing). */
float imat[4][4]; /* Domain object imat. */
float obmat[4][4]; /* Domain obmat. */
float fluidmat[4][4]; /* Low res fluid matrix. */
float fluidmat_wt[4][4]; /* High res fluid matrix. */
int base_res[3]; /* Initial "non-adapted" resolution. */
int res_min[3]; /* Cell min. */
int res_max[3]; /* Cell max. */
int res[3]; /* Data resolution (res_max-res_min). */
int total_cells;
float dx; /* 1.0f / res. */
float scale; /* Largest domain size. */
int boundary_width; /* Usually this is just 1. */
/* -- User-accesible fields (from here on). -- */
/* Adaptive domain options. */
int adapt_margin;
int adapt_res;
float adapt_threshold;
char _pad1[4]; /* Unused. */
/* Fluid domain options */
int maxres; /* Longest axis on the BB gets this resolution assigned. */
int solver_res; /* Dimension of manta solver, 2d or 3d. */
int border_collisions; /* How domain border collisions are handled. */
int flags; /* Use-mesh, use-noise, etc. */
float gravity[3];
int active_fields;
short type; /* Gas, liquid. */
char _pad2[6]; /* Unused. */
/* Smoke domain options. */
float alpha;
float beta;
int diss_speed; /* In frames. */
float vorticity;
float active_color[3]; /* Monitor smoke color. */
int highres_sampling;
/* Flame options. */
float burning_rate, flame_smoke, flame_vorticity;
float flame_ignition, flame_max_temp;
float flame_smoke_color[3];
/* Noise options. */
float noise_strength;
float noise_pos_scale;
float noise_time_anim;
int res_noise[3];
int noise_scale;
short noise_type; /* Noise type: wave, curl, anisotropic. */
char _pad3[2]; /* Unused. */
/* Liquid domain options. */
float particle_randomness;
int particle_number;
int particle_minimum;
int particle_maximum;
float particle_radius;
float particle_band_width;
float fractions_threshold;
float flip_ratio;
short simulation_method;
char _pad4[6];
/* Diffusion options. */
float surface_tension;
float viscosity_base;
int viscosity_exponent;
float domain_size;
/* Mesh options. */
float mesh_concave_upper;
float mesh_concave_lower;
float mesh_particle_radius;
int mesh_smoothen_pos;
int mesh_smoothen_neg;
int mesh_scale;
int totvert;
short mesh_generator;
char _pad5[2]; /* Unused. */
/* Secondary particle options. */
int particle_type;
int particle_scale;
float sndparticle_tau_min_wc;
float sndparticle_tau_max_wc;
float sndparticle_tau_min_ta;
float sndparticle_tau_max_ta;
float sndparticle_tau_min_k;
float sndparticle_tau_max_k;
int sndparticle_k_wc;
int sndparticle_k_ta;
float sndparticle_k_b;
float sndparticle_k_d;
float sndparticle_l_min;
float sndparticle_l_max;
int sndparticle_potential_radius;
int sndparticle_update_radius;
char sndparticle_boundary;
char sndparticle_combined_export;
char _pad6[6]; /* Unused. */
/* Fluid guiding options. */
float guiding_alpha; /* Guiding weight scalar (determines strength). */
int guiding_beta; /* Guiding blur radius (affects size of vortices). */
float guiding_vel_factor; /* Multiply guiding velocity by this factor. */
int guide_res[3]; /* Res for velocity guide grids - independent from base res. */
short guiding_source;
char _pad7[2]; /* Unused. */
/* Cache options. */
int cache_frame_start;
int cache_frame_end;
int cache_frame_pause_data;
int cache_frame_pause_noise;
int cache_frame_pause_mesh;
int cache_frame_pause_particles;
int cache_frame_pause_guiding;
int cache_flag;
char cache_mesh_format;
char cache_data_format;
char cache_particle_format;
char cache_noise_format;
char cache_directory[1024];
char error[64]; /* Bake error description. */
short cache_type;
char _pad8[2]; /* Unused. */
/* Time options. */
float dt;
float time_total;
float time_per_frame;
float frame_length;
float time_scale;
float cfl_condition;
int timesteps_minimum;
int timesteps_maximum;
/* Display options. */
char slice_method, axis_slice_method;
char slice_axis, draw_velocity;
float slice_per_voxel;
float slice_depth;
float display_thickness;
struct ColorBand *coba;
float vector_scale;
char vector_draw_type;
char use_coba;
char coba_field; /* Simulation field used for the color mapping. */
char interp_method;
/* -- Deprecated / unsed options (below). -- */
/* View options. */
int viewsettings;
char _pad9[4]; /* Unused. */
/* OpenVDB cache options. */
int openvdb_comp;
float clipping;
char data_depth;
char _pad10[7]; /* Unused. */
/* Pointcache options. */
/* Smoke uses only one cache from now on (index [0]), but keeping the array for now for reading
* old files. */
struct PointCache *point_cache[2]; /* Definition is in DNA_object_force_types.h. */
struct ListBase ptcaches[2];
int cache_comp;
int cache_high_comp;
char cache_file_format;
char _pad11[7]; /* Unused. */
} FluidDomainSettings;
/* Flow types. */
enum {
FLUID_FLOW_TYPE_SMOKE = 1,
FLUID_FLOW_TYPE_FIRE = 2,
FLUID_FLOW_TYPE_SMOKEFIRE = 3,
FLUID_FLOW_TYPE_LIQUID = 4,
};
/* Flow behavior types. */
enum {
FLUID_FLOW_BEHAVIOR_INFLOW = 0,
FLUID_FLOW_BEHAVIOR_OUTFLOW = 1,
FLUID_FLOW_BEHAVIOR_GEOMETRY = 2,
};
/* Flow source types. */
enum {
FLUID_FLOW_SOURCE_PARTICLES = 0,
FLUID_FLOW_SOURCE_MESH = 1,
};
/* Flow texture types. */
enum {
FLUID_FLOW_TEXTURE_MAP_AUTO = 0,
FLUID_FLOW_TEXTURE_MAP_UV = 1,
};
/* Flow flags. */
enum {
/* Old style emission. */
FLUID_FLOW_ABSOLUTE = (1 << 1),
sergeyUnsubmitted
Done
Inline Actions

temp is the worst variable name.

sergey: `temp` is the worst variable name.
sebbasAuthorUnsubmitted
Done
Inline Actions

Oh yes .. otherwise big fire hazard!

sebbas: Oh yes .. otherwise big fire hazard!
/* Passes particles speed to the smoke. */
FLUID_FLOW_INITVELOCITY = (1 << 2),
/* Use texture to control emission speed. */
FLUID_FLOW_TEXTUREEMIT = (1 << 3),
/* Use specific size for particles instead of closest cell. */
FLUID_FLOW_USE_PART_SIZE = (1 << 4),
/* Control when to apply inflow. */
FLUID_FLOW_USE_INFLOW = (1 << 5),
/* Control when to apply inflow. */
FLUID_FLOW_USE_PLANE_INIT = (1 << 6),
};
typedef struct FluidFlowSettings {
/* -- Runtime-only fields (from here on). -- */
/* For fast RNA access. */
struct FluidModifierData *mmd;
struct Mesh *mesh;
struct ParticleSystem *psys;
struct Tex *noise_texture;
/* Initial velocity. */
/* Previous vertex positions in domain space. */
float *verts_old;
int numverts;
float vel_multi; /* Multiplier for inherited velocity. */
float vel_normal;
float vel_random;
float vel_coord[3];
char _pad1[4];
/* -- User-accesible fields (from here on). -- */
/* Emission. */
float density;
float color[3];
float fuel_amount;
/* Delta temperature (temp - ambient temp). */
float temperature;
/* Density emitted within mesh volume. */
float volume_density;
/* Maximum emission distance from mesh surface. */
float surface_distance;
float particle_size;
int subframes;
/* Texture control. */
float texture_size;
float texture_offset;
char _pad2[4];
/* MAX_CUSTOMDATA_LAYER_NAME. */
char uvlayer_name[64];
short vgroup_density;
short type; /* Smoke, flames, both, outflow, liquid. */
short behavior; /* Inflow, outflow, static. */
short source;
short texture_type;
short _pad3[3];
int flags; /* Absolute emission etc. */
} FluidFlowSettings;
/* Effector types. */
enum {
FLUID_EFFECTOR_TYPE_COLLISION = 0,
FLUID_EFFECTOR_TYPE_GUIDE = 1,
};
/* Guiding velocity modes. */
enum {
FLUID_EFFECTOR_GUIDING_MAXIMUM = 0,
FLUID_EFFECTOR_GUIDING_MINIMUM = 1,
FLUID_EFFECTOR_GUIDING_OVERRIDE = 2,
FLUID_EFFECTOR_GUIDING_AVERAGED = 3,
};
/* Collision objects (filled with smoke). */
typedef struct FluidEffectorSettings {
/* -- Runtime-only fields (from here on). -- */
/* For fast RNA access. */
struct FluidModifierData *mmd;
struct Mesh *mesh;
float *verts_old;
int numverts;
/* -- User-accesible fields (from here on). -- */
float surface_distance; /* Thickness of mesh surface, used in obstacle sdf. */
int flags;
short type;
char _pad1[2];
/* Guiding options. */
float vel_multi; /* Multiplier for object velocity. */
short guiding_mode;
char _pad2[2];
} FluidEffectorSettings;
#endif