Blender V5.3
manta_fluid_API.h
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2016 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
8
9#include <cstddef>
10
11namespace blender {
12
13struct MANTA;
14
15/* Fluid functions */
16struct MANTA *manta_init(int *res, struct FluidModifierData *fmd);
17void manta_free(struct MANTA *fluid);
18bool manta_ensure_obstacle(struct MANTA *fluid, struct FluidModifierData *fmd);
19bool manta_ensure_guiding(struct MANTA *fluid, struct FluidModifierData *fmd);
20bool manta_ensure_invelocity(struct MANTA *fluid, struct FluidModifierData *fmd);
21bool manta_ensure_outflow(struct MANTA *fluid, struct FluidModifierData *fmd);
22bool manta_write_config(struct MANTA *fluid, struct FluidModifierData *fmd, int framenr);
23bool manta_write_data(struct MANTA *fluid, struct FluidModifierData *fmd, int framenr);
24bool manta_write_noise(struct MANTA *fluid, struct FluidModifierData *fmd, int framenr);
25bool manta_read_config(struct MANTA *fluid, struct FluidModifierData *fmd, int framenr);
26bool manta_read_data(struct MANTA *fluid,
27 struct FluidModifierData *fmd,
28 int framenr,
29 bool resumable);
30bool manta_read_noise(struct MANTA *fluid,
31 struct FluidModifierData *fmd,
32 int framenr,
33 bool resumable);
34bool manta_read_mesh(struct MANTA *fluid, struct FluidModifierData *fmd, int framenr);
35bool manta_read_particles(struct MANTA *fluid,
36 struct FluidModifierData *fmd,
37 int framenr,
38 bool resumable);
39bool manta_read_guiding(struct MANTA *fluid,
40 struct FluidModifierData *fmd,
41 int framenr,
42 bool sourceDomain);
43bool manta_bake_data(struct MANTA *fluid, struct FluidModifierData *fmd, int framenr);
44bool manta_bake_noise(struct MANTA *fluid, struct FluidModifierData *fmd, int framenr);
45bool manta_bake_mesh(struct MANTA *fluid, struct FluidModifierData *fmd, int framenr);
46bool manta_bake_particles(struct MANTA *fluid, struct FluidModifierData *fmd, int framenr);
47bool manta_bake_guiding(struct MANTA *fluid, struct FluidModifierData *fmd, int framenr);
48bool manta_has_data(struct MANTA *fluid, struct FluidModifierData *fmd, int framenr);
49bool manta_has_noise(struct MANTA *fluid, struct FluidModifierData *fmd, int framenr);
50bool manta_has_mesh(struct MANTA *fluid, struct FluidModifierData *fmd, int framenr);
51bool manta_has_particles(struct MANTA *fluid, struct FluidModifierData *fmd, int framenr);
52bool manta_has_guiding(struct MANTA *fluid,
53 struct FluidModifierData *fmd,
54 int framenr,
55 bool domain);
56
57void manta_update_variables(struct MANTA *fluid, struct FluidModifierData *fmd);
58int manta_get_frame(struct MANTA *fluid);
59float manta_get_timestep(struct MANTA *fluid);
60void manta_adapt_timestep(struct MANTA *fluid);
61bool manta_needs_realloc(struct MANTA *fluid, struct FluidModifierData *fmd);
62void manta_update_pointers(struct MANTA *fluid, struct FluidModifierData *fmd, bool flush);
63
64/* Fluid accessors */
65size_t manta_get_index(int x, int max_x, int y, int max_y, int z /* , int max_z */);
66size_t manta_get_index2d(int x, int max_x, int y /* , int max_y, int z, int max_z */);
67float *manta_get_velocity_x(struct MANTA *fluid);
68float *manta_get_velocity_y(struct MANTA *fluid);
69float *manta_get_velocity_z(struct MANTA *fluid);
70float *manta_get_ob_velocity_x(struct MANTA *fluid);
71float *manta_get_ob_velocity_y(struct MANTA *fluid);
72float *manta_get_ob_velocity_z(struct MANTA *fluid);
73float *manta_get_guide_velocity_x(struct MANTA *fluid);
74float *manta_get_guide_velocity_y(struct MANTA *fluid);
75float *manta_get_guide_velocity_z(struct MANTA *fluid);
76float *manta_get_in_velocity_x(struct MANTA *fluid);
77float *manta_get_in_velocity_y(struct MANTA *fluid);
78float *manta_get_in_velocity_z(struct MANTA *fluid);
79float *manta_get_force_x(struct MANTA *fluid);
80float *manta_get_force_y(struct MANTA *fluid);
81float *manta_get_force_z(struct MANTA *fluid);
82float *manta_get_phiguide_in(struct MANTA *fluid);
83float *manta_get_num_obstacle(struct MANTA *fluid);
84float *manta_get_num_guide(struct MANTA *fluid);
85int manta_get_res_x(struct MANTA *fluid);
86int manta_get_res_y(struct MANTA *fluid);
87int manta_get_res_z(struct MANTA *fluid);
88float *manta_get_phi_in(struct MANTA *fluid);
89float *manta_get_phistatic_in(struct MANTA *fluid);
90float *manta_get_phiobs_in(struct MANTA *fluid);
91float *manta_get_phiobsstatic_in(struct MANTA *fluid);
92float *manta_get_phiout_in(struct MANTA *fluid);
93float *manta_get_phioutstatic_in(struct MANTA *fluid);
94float *manta_get_phi(struct MANTA *fluid);
95float *manta_get_pressure(struct MANTA *fluid);
96
97/* Smoke functions */
98bool manta_smoke_export_script(struct MANTA *smoke, struct FluidModifierData *fmd);
99void manta_smoke_get_rgba(struct MANTA *smoke, float *data, int sequential);
100void manta_noise_get_rgba(struct MANTA *smoke, float *data, int sequential);
101void manta_smoke_get_rgba_fixed_color(struct MANTA *smoke,
102 float color[3],
103 float *data,
104 int sequential);
105void manta_noise_get_rgba_fixed_color(struct MANTA *smoke,
106 float color[3],
107 float *data,
108 int sequential);
109bool manta_smoke_ensure_heat(struct MANTA *smoke, struct FluidModifierData *fmd);
110bool manta_smoke_ensure_fire(struct MANTA *smoke, struct FluidModifierData *fmd);
111bool manta_smoke_ensure_colors(struct MANTA *smoke, struct FluidModifierData *fmd);
112
113/* Smoke accessors */
114float *manta_smoke_get_density(struct MANTA *smoke);
115float *manta_smoke_get_fuel(struct MANTA *smoke);
116float *manta_smoke_get_react(struct MANTA *smoke);
117float *manta_smoke_get_heat(struct MANTA *smoke);
118float *manta_smoke_get_flame(struct MANTA *smoke);
119float *manta_smoke_get_shadow(struct MANTA *smoke);
120float *manta_smoke_get_color_r(struct MANTA *smoke);
121float *manta_smoke_get_color_g(struct MANTA *smoke);
122float *manta_smoke_get_color_b(struct MANTA *smoke);
123int *manta_smoke_get_flags(struct MANTA *smoke);
124float *manta_smoke_get_density_in(struct MANTA *smoke);
125float *manta_smoke_get_heat_in(struct MANTA *smoke);
126float *manta_smoke_get_color_r_in(struct MANTA *smoke);
127float *manta_smoke_get_color_g_in(struct MANTA *smoke);
128float *manta_smoke_get_color_b_in(struct MANTA *smoke);
129float *manta_smoke_get_fuel_in(struct MANTA *smoke);
130float *manta_smoke_get_react_in(struct MANTA *smoke);
131float *manta_smoke_get_emission_in(struct MANTA *smoke);
132bool manta_smoke_has_heat(struct MANTA *smoke);
133bool manta_smoke_has_fuel(struct MANTA *smoke);
134bool manta_smoke_has_colors(struct MANTA *smoke);
135float *manta_noise_get_density(struct MANTA *smoke);
136float *manta_noise_get_fuel(struct MANTA *smoke);
137float *manta_noise_get_react(struct MANTA *smoke);
138float *manta_noise_get_color_r(struct MANTA *smoke);
139float *manta_noise_get_color_g(struct MANTA *smoke);
140float *manta_noise_get_color_b(struct MANTA *smoke);
141float *manta_noise_get_texture_u(struct MANTA *smoke);
142float *manta_noise_get_texture_v(struct MANTA *smoke);
143float *manta_noise_get_texture_w(struct MANTA *smoke);
144float *manta_noise_get_texture_u2(struct MANTA *smoke);
145float *manta_noise_get_texture_v2(struct MANTA *smoke);
146float *manta_noise_get_texture_w2(struct MANTA *smoke);
147float *manta_noise_get_flame(struct MANTA *smoke);
148bool manta_noise_has_fuel(struct MANTA *smoke);
149bool manta_noise_has_colors(struct MANTA *smoke);
150void manta_noise_get_res(struct MANTA *smoke, int *res);
151int manta_noise_get_cells(struct MANTA *smoke);
152
153/* Liquid functions */
154bool manta_liquid_export_script(struct MANTA *liquid, struct FluidModifierData *fmd);
155bool manta_liquid_ensure_sndparts(struct MANTA *liquid, struct FluidModifierData *fmd);
156
157/* Liquid accessors */
158int manta_liquid_get_particle_res_x(struct MANTA *liquid);
159int manta_liquid_get_particle_res_y(struct MANTA *liquid);
160int manta_liquid_get_particle_res_z(struct MANTA *liquid);
161int manta_liquid_get_mesh_res_x(struct MANTA *liquid);
162int manta_liquid_get_mesh_res_y(struct MANTA *liquid);
163int manta_liquid_get_mesh_res_z(struct MANTA *liquid);
164int manta_liquid_get_particle_upres(struct MANTA *liquid);
165int manta_liquid_get_mesh_upres(struct MANTA *liquid);
166int manta_liquid_get_num_verts(struct MANTA *liquid);
167int manta_liquid_get_num_normals(struct MANTA *liquid);
168int manta_liquid_get_num_triangles(struct MANTA *liquid);
169float manta_liquid_get_vertex_x_at(struct MANTA *liquid, int i);
170float manta_liquid_get_vertex_y_at(struct MANTA *liquid, int i);
171float manta_liquid_get_vertex_z_at(struct MANTA *liquid, int i);
172float manta_liquid_get_normal_x_at(struct MANTA *liquid, int i);
173float manta_liquid_get_normal_y_at(struct MANTA *liquid, int i);
174float manta_liquid_get_normal_z_at(struct MANTA *liquid, int i);
175int manta_liquid_get_triangle_x_at(struct MANTA *liquid, int i);
176int manta_liquid_get_triangle_y_at(struct MANTA *liquid, int i);
177int manta_liquid_get_triangle_z_at(struct MANTA *liquid, int i);
178float manta_liquid_get_vertvel_x_at(struct MANTA *liquid, int i);
179float manta_liquid_get_vertvel_y_at(struct MANTA *liquid, int i);
180float manta_liquid_get_vertvel_z_at(struct MANTA *liquid, int i);
182int manta_liquid_get_num_snd_particles(struct MANTA *liquid);
183int manta_liquid_get_flip_particle_flag_at(struct MANTA *liquid, int i);
184int manta_liquid_get_snd_particle_flag_at(struct MANTA *liquid, int i);
185float manta_liquid_get_flip_particle_position_x_at(struct MANTA *liquid, int i);
186float manta_liquid_get_flip_particle_position_y_at(struct MANTA *liquid, int i);
187float manta_liquid_get_flip_particle_position_z_at(struct MANTA *liquid, int i);
188float manta_liquid_get_flip_particle_velocity_x_at(struct MANTA *liquid, int i);
189float manta_liquid_get_flip_particle_velocity_y_at(struct MANTA *liquid, int i);
190float manta_liquid_get_flip_particle_velocity_z_at(struct MANTA *liquid, int i);
191float manta_liquid_get_snd_particle_position_x_at(struct MANTA *liquid, int i);
192float manta_liquid_get_snd_particle_position_y_at(struct MANTA *liquid, int i);
193float manta_liquid_get_snd_particle_position_z_at(struct MANTA *liquid, int i);
194float manta_liquid_get_snd_particle_velocity_x_at(struct MANTA *liquid, int i);
195float manta_liquid_get_snd_particle_velocity_y_at(struct MANTA *liquid, int i);
196float manta_liquid_get_snd_particle_velocity_z_at(struct MANTA *liquid, int i);
197
198} // namespace blender
SIMD_FORCE_INLINE const btScalar & z() const
Return the z value.
Definition btQuadWord.h:117
BMesh Iterators.
int manta_liquid_get_snd_particle_flag_at(struct MANTA *liquid, int i)
int manta_liquid_get_particle_res_z(struct MANTA *liquid)
bool manta_read_noise(struct MANTA *fluid, struct FluidModifierData *fmd, int framenr, bool resumable)
bool manta_bake_mesh(struct MANTA *fluid, struct FluidModifierData *fmd, int framenr)
float * manta_get_ob_velocity_z(struct MANTA *fluid)
float * manta_get_guide_velocity_x(struct MANTA *fluid)
float manta_liquid_get_normal_y_at(struct MANTA *liquid, int i)
int manta_liquid_get_triangle_y_at(struct MANTA *liquid, int i)
float manta_liquid_get_vertex_x_at(struct MANTA *liquid, int i)
int manta_liquid_get_flip_particle_flag_at(struct MANTA *liquid, int i)
int manta_liquid_get_num_normals(struct MANTA *liquid)
bool manta_has_mesh(struct MANTA *fluid, struct FluidModifierData *fmd, int framenr)
float manta_liquid_get_normal_z_at(struct MANTA *liquid, int i)
float * manta_noise_get_texture_u2(struct MANTA *smoke)
int manta_liquid_get_particle_res_y(struct MANTA *liquid)
float * manta_noise_get_color_b(struct MANTA *smoke)
float * manta_smoke_get_react(struct MANTA *smoke)
float manta_liquid_get_flip_particle_position_y_at(struct MANTA *liquid, int i)
float * manta_get_in_velocity_x(struct MANTA *fluid)
float * manta_smoke_get_shadow(struct MANTA *smoke)
void manta_free(struct MANTA *fluid)
float * manta_noise_get_texture_w2(struct MANTA *smoke)
float manta_liquid_get_flip_particle_velocity_y_at(struct MANTA *liquid, int i)
int manta_get_res_y(struct MANTA *fluid)
float * manta_get_force_x(struct MANTA *fluid)
void manta_smoke_get_rgba(struct MANTA *smoke, float *data, int sequential)
void manta_smoke_get_rgba_fixed_color(struct MANTA *smoke, float color[3], float *data, int sequential)
float manta_liquid_get_snd_particle_position_z_at(struct MANTA *liquid, int i)
int manta_liquid_get_particle_res_x(struct MANTA *liquid)
size_t manta_get_index2d(int x, int max_x, int y)
float * manta_smoke_get_color_r_in(struct MANTA *smoke)
float * manta_get_phiout_in(struct MANTA *fluid)
float * manta_get_phi_in(struct MANTA *fluid)
float manta_liquid_get_snd_particle_position_y_at(struct MANTA *liquid, int i)
bool manta_has_particles(struct MANTA *fluid, struct FluidModifierData *fmd, int framenr)
float * manta_get_ob_velocity_x(struct MANTA *fluid)
float * manta_smoke_get_heat(struct MANTA *smoke)
bool manta_has_noise(struct MANTA *fluid, struct FluidModifierData *fmd, int framenr)
float manta_liquid_get_flip_particle_position_z_at(struct MANTA *liquid, int i)
bool manta_smoke_ensure_heat(struct MANTA *smoke, struct FluidModifierData *fmd)
int manta_liquid_get_num_snd_particles(struct MANTA *liquid)
int manta_liquid_get_num_triangles(struct MANTA *liquid)
float * manta_noise_get_density(struct MANTA *smoke)
float * manta_get_pressure(struct MANTA *fluid)
float * manta_get_guide_velocity_y(struct MANTA *fluid)
bool manta_smoke_has_colors(struct MANTA *smoke)
bool manta_bake_data(struct MANTA *fluid, struct FluidModifierData *fmd, int framenr)
float * manta_smoke_get_color_g_in(struct MANTA *smoke)
bool manta_ensure_obstacle(struct MANTA *fluid, struct FluidModifierData *fmd)
float * manta_get_phiobsstatic_in(struct MANTA *fluid)
float * manta_smoke_get_react_in(struct MANTA *smoke)
bool manta_read_config(struct MANTA *fluid, struct FluidModifierData *fmd, int framenr)
float * manta_noise_get_color_r(struct MANTA *smoke)
float * manta_get_phioutstatic_in(struct MANTA *fluid)
float manta_liquid_get_vertvel_z_at(struct MANTA *liquid, int i)
struct MANTA * manta_init(int *res, struct FluidModifierData *fmd)
bool manta_ensure_invelocity(struct MANTA *fluid, struct FluidModifierData *fmd)
int manta_liquid_get_num_verts(struct MANTA *liquid)
bool manta_ensure_outflow(struct MANTA *fluid, struct FluidModifierData *fmd)
float manta_liquid_get_flip_particle_velocity_z_at(struct MANTA *liquid, int i)
float * manta_get_num_guide(struct MANTA *fluid)
float * manta_get_velocity_z(struct MANTA *fluid)
int manta_liquid_get_triangle_z_at(struct MANTA *liquid, int i)
void manta_update_variables(struct MANTA *fluid, struct FluidModifierData *fmd)
float * manta_get_force_z(struct MANTA *fluid)
float * manta_get_in_velocity_y(struct MANTA *fluid)
float manta_liquid_get_flip_particle_position_x_at(struct MANTA *liquid, int i)
BMesh const char void * data
float manta_liquid_get_vertvel_x_at(struct MANTA *liquid, int i)
void manta_adapt_timestep(struct MANTA *fluid)
int manta_get_frame(struct MANTA *fluid)
float * manta_noise_get_color_g(struct MANTA *smoke)
bool manta_bake_guiding(struct MANTA *fluid, struct FluidModifierData *fmd, int framenr)
float * manta_smoke_get_color_r(struct MANTA *smoke)
bool manta_read_particles(struct MANTA *fluid, struct FluidModifierData *fmd, int framenr, bool resumable)
float * manta_get_phistatic_in(struct MANTA *fluid)
bool manta_liquid_ensure_sndparts(struct MANTA *liquid, struct FluidModifierData *fmd)
void manta_noise_get_res(struct MANTA *smoke, int *res)
float manta_liquid_get_normal_x_at(struct MANTA *liquid, int i)
float manta_liquid_get_snd_particle_position_x_at(struct MANTA *liquid, int i)
float manta_liquid_get_vertex_y_at(struct MANTA *liquid, int i)
bool manta_has_data(struct MANTA *fluid, struct FluidModifierData *fmd, int framenr)
float * manta_get_force_y(struct MANTA *fluid)
float manta_get_timestep(struct MANTA *fluid)
float * manta_noise_get_fuel(struct MANTA *smoke)
int manta_liquid_get_triangle_x_at(struct MANTA *liquid, int i)
float manta_liquid_get_vertvel_y_at(struct MANTA *liquid, int i)
float manta_liquid_get_snd_particle_velocity_x_at(struct MANTA *liquid, int i)
bool manta_ensure_guiding(struct MANTA *fluid, struct FluidModifierData *fmd)
bool manta_smoke_has_fuel(struct MANTA *smoke)
float * manta_smoke_get_fuel(struct MANTA *smoke)
float * manta_smoke_get_density(struct MANTA *smoke)
size_t manta_get_index(int x, int max_x, int y, int max_y, int z)
int manta_liquid_get_mesh_res_x(struct MANTA *liquid)
float * manta_smoke_get_heat_in(struct MANTA *smoke)
int * manta_smoke_get_flags(struct MANTA *smoke)
float manta_liquid_get_vertex_z_at(struct MANTA *liquid, int i)
int manta_get_res_z(struct MANTA *fluid)
float * manta_get_guide_velocity_z(struct MANTA *fluid)
float * manta_noise_get_flame(struct MANTA *smoke)
float * manta_get_ob_velocity_y(struct MANTA *fluid)
void manta_update_pointers(struct MANTA *fluid, struct FluidModifierData *fmd, bool flush)
float * manta_get_phi(struct MANTA *fluid)
bool manta_smoke_ensure_colors(struct MANTA *smoke, struct FluidModifierData *fmd)
bool manta_write_config(struct MANTA *fluid, struct FluidModifierData *fmd, int framenr)
float * manta_get_num_obstacle(struct MANTA *fluid)
float * manta_smoke_get_flame(struct MANTA *smoke)
bool manta_bake_particles(struct MANTA *fluid, struct FluidModifierData *fmd, int framenr)
float * manta_smoke_get_color_b_in(struct MANTA *smoke)
bool manta_needs_realloc(struct MANTA *fluid, struct FluidModifierData *fmd)
float * manta_smoke_get_density_in(struct MANTA *smoke)
float * manta_get_phiguide_in(struct MANTA *fluid)
float * manta_get_phiobs_in(struct MANTA *fluid)
void manta_noise_get_rgba(struct MANTA *smoke, float *data, int sequential)
int manta_liquid_get_num_flip_particles(struct MANTA *liquid)
float * manta_smoke_get_emission_in(struct MANTA *smoke)
bool manta_smoke_ensure_fire(struct MANTA *smoke, struct FluidModifierData *fmd)
float * manta_get_velocity_x(struct MANTA *fluid)
float manta_liquid_get_snd_particle_velocity_y_at(struct MANTA *liquid, int i)
int manta_liquid_get_mesh_res_z(struct MANTA *liquid)
int manta_liquid_get_mesh_res_y(struct MANTA *liquid)
bool manta_noise_has_fuel(struct MANTA *smoke)
float * manta_noise_get_react(struct MANTA *smoke)
bool manta_has_guiding(struct MANTA *fluid, struct FluidModifierData *fmd, int framenr, bool domain)
bool manta_read_mesh(struct MANTA *fluid, struct FluidModifierData *fmd, int framenr)
float * manta_noise_get_texture_v(struct MANTA *smoke)
int manta_liquid_get_particle_upres(struct MANTA *liquid)
float * manta_noise_get_texture_w(struct MANTA *smoke)
float * manta_smoke_get_fuel_in(struct MANTA *smoke)
float * manta_get_velocity_y(struct MANTA *fluid)
bool manta_liquid_export_script(struct MANTA *liquid, struct FluidModifierData *fmd)
float * manta_get_in_velocity_z(struct MANTA *fluid)
float * manta_smoke_get_color_b(struct MANTA *smoke)
bool manta_read_guiding(struct MANTA *fluid, struct FluidModifierData *fmd, int framenr, bool sourceDomain)
bool manta_bake_noise(struct MANTA *fluid, struct FluidModifierData *fmd, int framenr)
bool manta_write_noise(struct MANTA *fluid, struct FluidModifierData *fmd, int framenr)
int manta_get_res_x(struct MANTA *fluid)
bool manta_smoke_has_heat(struct MANTA *smoke)
bool manta_smoke_export_script(struct MANTA *smoke, struct FluidModifierData *fmd)
void manta_noise_get_rgba_fixed_color(struct MANTA *smoke, float color[3], float *data, int sequential)
float * manta_smoke_get_color_g(struct MANTA *smoke)
int manta_liquid_get_mesh_upres(struct MANTA *liquid)
float manta_liquid_get_flip_particle_velocity_x_at(struct MANTA *liquid, int i)
float * manta_noise_get_texture_u(struct MANTA *smoke)
bool manta_read_data(struct MANTA *fluid, struct FluidModifierData *fmd, int framenr, bool resumable)
int manta_noise_get_cells(struct MANTA *smoke)
float * manta_noise_get_texture_v2(struct MANTA *smoke)
bool manta_write_data(struct MANTA *fluid, struct FluidModifierData *fmd, int framenr)
float manta_liquid_get_snd_particle_velocity_z_at(struct MANTA *liquid, int i)
bool manta_noise_has_colors(struct MANTA *smoke)