rna_smoke.c

Go to the documentation of this file.

/*
 * ***** 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.
 *
 * Contributor(s): Daniel Genrich
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#include <stdlib.h>
#include <limits.h>

#include "RNA_define.h"

#include "rna_internal.h"

#include "BKE_modifier.h"
#include "BKE_smoke.h"

#include "DNA_modifier_types.h"
#include "DNA_object_force.h"
#include "DNA_object_types.h"
#include "DNA_scene_types.h"
#include "DNA_smoke_types.h"

#include "WM_types.h"


#ifdef RNA_RUNTIME

#include "BKE_context.h"
#include "BKE_depsgraph.h"
#include "BKE_particle.h"


static void rna_Smoke_update(Main *UNUSED(bmain), Scene *UNUSED(scene), PointerRNA *ptr)
{
    DAG_id_tag_update(ptr->id.data, OB_RECALC_DATA);
}

static void rna_Smoke_dependency_update(Main *bmain, Scene *scene, PointerRNA *ptr)
{
    rna_Smoke_update(bmain, scene, ptr);
    DAG_scene_sort(bmain, scene);
}

static void rna_Smoke_reset(Main *bmain, Scene *scene, PointerRNA *ptr)
{
    SmokeDomainSettings *settings = (SmokeDomainSettings*)ptr->data;

    smokeModifier_reset(settings->smd);

    if(settings->smd && settings->smd->domain)
        settings->point_cache[0]->flag |= PTCACHE_OUTDATED;

    rna_Smoke_update(bmain, scene, ptr);
}

static void rna_Smoke_reset_dependancy(Main *bmain, Scene *scene, PointerRNA *ptr)
{
    SmokeDomainSettings *settings = (SmokeDomainSettings*)ptr->data;

    smokeModifier_reset(settings->smd);

    if(settings->smd && settings->smd->domain)
        settings->smd->domain->point_cache[0]->flag |= PTCACHE_OUTDATED;

    rna_Smoke_dependency_update(bmain, scene, ptr);
}

static char *rna_SmokeDomainSettings_path(PointerRNA *ptr)
{
    SmokeDomainSettings *settings = (SmokeDomainSettings*)ptr->data;
    ModifierData *md= (ModifierData *)settings->smd;

    return BLI_sprintfN("modifiers[\"%s\"].domain_settings", md->name);
}

static char *rna_SmokeFlowSettings_path(PointerRNA *ptr)
{
    SmokeFlowSettings *settings = (SmokeFlowSettings*)ptr->data;
    ModifierData *md= (ModifierData *)settings->smd;

    return BLI_sprintfN("modifiers[\"%s\"].flow_settings", md->name);
}

static char *rna_SmokeCollSettings_path(PointerRNA *ptr)
{
    SmokeCollSettings *settings = (SmokeCollSettings*)ptr->data;
    ModifierData *md= (ModifierData *)settings->smd;

    return BLI_sprintfN("modifiers[\"%s\"].coll_settings", md->name);
}

#else

static void rna_def_smoke_domain_settings(BlenderRNA *brna)
{
    StructRNA *srna;
    PropertyRNA *prop;

    static EnumPropertyItem prop_noise_type_items[] = {
                {MOD_SMOKE_NOISEWAVE, "NOISEWAVE", 0, "Wavelet", ""},
#ifdef WITH_FFTW3
                {MOD_SMOKE_NOISEFFT, "NOISEFFT", 0, "FFT", ""}, 
#endif
            /*  {MOD_SMOKE_NOISECURL, "NOISECURL", 0, "Curl", ""}, */
                {0, NULL, 0, NULL, NULL}};

    static EnumPropertyItem smoke_cache_comp_items[] = {
        {SM_CACHE_LIGHT, "CACHELIGHT", 0, "Light", "Fast but not so effective compression"},
        {SM_CACHE_HEAVY, "CACHEHEAVY", 0, "Heavy", "Effective but slow compression"},
        {0, NULL, 0, NULL, NULL}};

    static EnumPropertyItem smoke_domain_colli_items[] = {
        {SM_BORDER_OPEN, "BORDEROPEN", 0, "Open", "Smoke doesn't collide with any border"},
        {SM_BORDER_VERTICAL, "BORDERVERTICAL", 0, "Vertically Open", "Smoke doesn't collide with top and bottom sides"},
        {SM_BORDER_CLOSED, "BORDERCLOSED", 0, "Collide All", "Smoke collides with every side"},
        {0, NULL, 0, NULL, NULL}};

    srna = RNA_def_struct(brna, "SmokeDomainSettings", NULL);
    RNA_def_struct_ui_text(srna, "Domain Settings", "Smoke domain settings");
    RNA_def_struct_sdna(srna, "SmokeDomainSettings");
    RNA_def_struct_path_func(srna, "rna_SmokeDomainSettings_path");

    prop= RNA_def_property(srna, "resolution_max", PROP_INT, PROP_NONE);
    RNA_def_property_int_sdna(prop, NULL, "maxres");
    RNA_def_property_range(prop, 24, 512);
    RNA_def_property_ui_range(prop, 24, 512, 2, 0);
    RNA_def_property_ui_text(prop, "Max Res", "Maximal resolution used in the fluid domain");
    RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset");

    prop= RNA_def_property(srna, "amplify", PROP_INT, PROP_NONE);
    RNA_def_property_int_sdna(prop, NULL, "amplify");
    RNA_def_property_range(prop, 1, 10);
    RNA_def_property_ui_range(prop, 1, 10, 1, 0);
    RNA_def_property_ui_text(prop, "Amplification", "Enhance the resolution of smoke by this factor using noise");
    RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset");

    prop= RNA_def_property(srna, "use_high_resolution", PROP_BOOLEAN, PROP_NONE);
    RNA_def_property_boolean_sdna(prop, NULL, "flags", MOD_SMOKE_HIGHRES);
    RNA_def_property_ui_text(prop, "High res", "Enable high resolution (using amplification)");
    RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset");

    prop= RNA_def_property(srna, "show_high_resolution", PROP_BOOLEAN, PROP_NONE);
    RNA_def_property_boolean_sdna(prop, NULL, "viewsettings", MOD_SMOKE_VIEW_SHOWBIG);
    RNA_def_property_ui_text(prop, "Show High Resolution", "Show high resolution (using amplification)");
    RNA_def_property_update(prop, NC_OBJECT|ND_DRAW, NULL);

    prop= RNA_def_property(srna, "noise_type", PROP_ENUM, PROP_NONE);
    RNA_def_property_enum_sdna(prop, NULL, "noise");
    RNA_def_property_enum_items(prop, prop_noise_type_items);
    RNA_def_property_ui_text(prop, "Noise Method", "Noise method which is used for creating the high resolution");
    RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset");

    prop= RNA_def_property(srna, "alpha", PROP_FLOAT, PROP_NONE);
    RNA_def_property_float_sdna(prop, NULL, "alpha");
    RNA_def_property_range(prop, -5.0, 5.0);
    RNA_def_property_ui_range(prop, -5.0, 5.0, 0.02, 5);
    RNA_def_property_ui_text(prop, "Density", "How much density affects smoke motion (higher value results in faster rising smoke)");
    RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset");

    prop= RNA_def_property(srna, "beta", PROP_FLOAT, PROP_NONE);
    RNA_def_property_float_sdna(prop, NULL, "beta");
    RNA_def_property_range(prop, -5.0, 5.0);
    RNA_def_property_ui_range(prop, -5.0, 5.0, 0.02, 5);
    RNA_def_property_ui_text(prop, "Heat", "How much heat affects smoke motion (higher value results in faster rising smoke)");
    RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset");

    prop= RNA_def_property(srna, "collision_group", PROP_POINTER, PROP_NONE);
    RNA_def_property_pointer_sdna(prop, NULL, "coll_group");
    RNA_def_property_struct_type(prop, "Group");
    RNA_def_property_flag(prop, PROP_EDITABLE);
    RNA_def_property_ui_text(prop, "Collision Group", "Limit collisions to this group");
    RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset_dependancy");

    prop= RNA_def_property(srna, "fluid_group", PROP_POINTER, PROP_NONE);
    RNA_def_property_pointer_sdna(prop, NULL, "fluid_group");
    RNA_def_property_struct_type(prop, "Group");
    RNA_def_property_flag(prop, PROP_EDITABLE);
    RNA_def_property_ui_text(prop, "Fluid Group", "Limit fluid objects to this group");
    RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset_dependancy");

    prop= RNA_def_property(srna, "effector_group", PROP_POINTER, PROP_NONE);
    RNA_def_property_pointer_sdna(prop, NULL, "eff_group");
    RNA_def_property_struct_type(prop, "Group");
    RNA_def_property_flag(prop, PROP_EDITABLE);
    RNA_def_property_ui_text(prop, "Effector Group", "Limit effectors to this group");
    RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset_dependancy");

    prop= RNA_def_property(srna, "strength", PROP_FLOAT, PROP_NONE);
    RNA_def_property_float_sdna(prop, NULL, "strength");
    RNA_def_property_range(prop, 0.0, 10.0);
    RNA_def_property_ui_range(prop, 0.0, 10.0, 1, 2);
    RNA_def_property_ui_text(prop, "Strength", "Strength of noise");
    RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset");

    prop= RNA_def_property(srna, "dissolve_speed", PROP_INT, PROP_NONE);
    RNA_def_property_int_sdna(prop, NULL, "diss_speed");
    RNA_def_property_range(prop, 1.0, 10000.0);
    RNA_def_property_ui_range(prop, 1.0, 10000.0, 1, 0);
    RNA_def_property_ui_text(prop, "Dissolve Speed", "Dissolve Speed");
    RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset");

    prop= RNA_def_property(srna, "use_dissolve_smoke", PROP_BOOLEAN, PROP_NONE);
    RNA_def_property_boolean_sdna(prop, NULL, "flags", MOD_SMOKE_DISSOLVE);
    RNA_def_property_ui_text(prop, "Dissolve Smoke", "Enable smoke to disappear over time");
    RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset");

    prop= RNA_def_property(srna, "use_dissolve_smoke_log", PROP_BOOLEAN, PROP_NONE);
    RNA_def_property_boolean_sdna(prop, NULL, "flags", MOD_SMOKE_DISSOLVE_LOG);
    RNA_def_property_ui_text(prop, "Logarithmic dissolve", "Using 1/x ");
    RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset");

    prop= RNA_def_property(srna, "point_cache", PROP_POINTER, PROP_NONE);
    RNA_def_property_flag(prop, PROP_NEVER_NULL);
    RNA_def_property_pointer_sdna(prop, NULL, "point_cache[0]");
    RNA_def_property_ui_text(prop, "Point Cache", "");

    prop= RNA_def_property(srna, "point_cache_compress_type", PROP_ENUM, PROP_NONE);
    RNA_def_property_enum_sdna(prop, NULL, "cache_comp");
    RNA_def_property_enum_items(prop, smoke_cache_comp_items);
    RNA_def_property_ui_text(prop, "Cache Compression", "Compression method to be used");

    prop= RNA_def_property(srna, "collision_extents", PROP_ENUM, PROP_NONE);
    RNA_def_property_enum_sdna(prop, NULL, "border_collisions");
    RNA_def_property_enum_items(prop, smoke_domain_colli_items);
    RNA_def_property_ui_text(prop, "Border Collisions", "Select which domain border will be treated as collision object");
    RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset");

    prop= RNA_def_property(srna, "effector_weights", PROP_POINTER, PROP_NONE);
    RNA_def_property_struct_type(prop, "EffectorWeights");
    RNA_def_property_clear_flag(prop, PROP_EDITABLE);
    RNA_def_property_ui_text(prop, "Effector Weights", "");

    prop= RNA_def_property(srna, "smooth_emitter", PROP_BOOLEAN, PROP_NONE);
    RNA_def_property_boolean_sdna(prop, NULL, "flags", MOD_SMOKE_HIGH_SMOOTH);
    RNA_def_property_ui_text(prop, "Smooth Emitter", "Smoothen emitted smoke to avoid blockiness");
    RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset");

    prop= RNA_def_property(srna, "time_scale", PROP_FLOAT, PROP_NONE);
    RNA_def_property_float_sdna(prop, NULL, "time_scale");
    RNA_def_property_range(prop, 0.2, 1.5);
    RNA_def_property_ui_range(prop, 0.2, 1.5, 0.02, 5);
    RNA_def_property_ui_text(prop, "Time Scale", "Adjust simulation speed");
    RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset");

    prop= RNA_def_property(srna, "vorticity", PROP_FLOAT, PROP_NONE);
    RNA_def_property_float_sdna(prop, NULL, "vorticity");
    RNA_def_property_range(prop, 0.01, 4.0);
    RNA_def_property_ui_range(prop, 0.01, 4.0, 0.02, 5);
    RNA_def_property_ui_text(prop, "Vorticity", "Amount of turbulence/rotation in fluid");
    RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset");

}

static void rna_def_smoke_flow_settings(BlenderRNA *brna)
{
    StructRNA *srna;
    PropertyRNA *prop;

    srna = RNA_def_struct(brna, "SmokeFlowSettings", NULL);
    RNA_def_struct_ui_text(srna, "Flow Settings", "Smoke flow settings");
    RNA_def_struct_sdna(srna, "SmokeFlowSettings");
    RNA_def_struct_path_func(srna, "rna_SmokeFlowSettings_path");

    prop= RNA_def_property(srna, "density", PROP_FLOAT, PROP_NONE);
    RNA_def_property_float_sdna(prop, NULL, "density");
    RNA_def_property_range(prop, 0.001, 1);
    RNA_def_property_ui_range(prop, 0.001, 1.0, 1.0, 4);
    RNA_def_property_ui_text(prop, "Density", "");
    RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset");

    prop= RNA_def_property(srna, "temperature", PROP_FLOAT, PROP_NONE);
    RNA_def_property_float_sdna(prop, NULL, "temp");
    RNA_def_property_range(prop, -10, 10);
    RNA_def_property_ui_range(prop, -10, 10, 1, 1);
    RNA_def_property_ui_text(prop, "Temp. Diff.", "Temperature difference to ambient temperature");
    RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset");
    
    prop= RNA_def_property(srna, "particle_system", PROP_POINTER, PROP_NONE);
    RNA_def_property_pointer_sdna(prop, NULL, "psys");
    RNA_def_property_struct_type(prop, "ParticleSystem");
    RNA_def_property_flag(prop, PROP_EDITABLE);
    RNA_def_property_ui_text(prop, "Particle Systems", "Particle systems emitted from the object");
    RNA_def_property_update(prop, 0, "rna_Smoke_reset_dependancy");

    prop= RNA_def_property(srna, "use_outflow", PROP_BOOLEAN, PROP_NONE);
    RNA_def_property_boolean_sdna(prop, NULL, "type", MOD_SMOKE_FLOW_TYPE_OUTFLOW);
    RNA_def_property_ui_text(prop, "Outflow", "Delete smoke from simulation");
    RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset");

    prop= RNA_def_property(srna, "use_absolute", PROP_BOOLEAN, PROP_NONE);
    RNA_def_property_boolean_sdna(prop, NULL, "flags", MOD_SMOKE_FLOW_ABSOLUTE);
    RNA_def_property_ui_text(prop, "Absolute Density", "Only allow given density value in emitter area");
    RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset");

    prop= RNA_def_property(srna, "initial_velocity", PROP_BOOLEAN, PROP_NONE);
    RNA_def_property_boolean_sdna(prop, NULL, "flags", MOD_SMOKE_FLOW_INITVELOCITY);
    RNA_def_property_ui_text(prop, "Initial Velocity", "Smoke inherits its velocity from the emitter particle");
    RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset");

    prop= RNA_def_property(srna, "velocity_factor", PROP_FLOAT, PROP_NONE);
    RNA_def_property_float_sdna(prop, NULL, "vel_multi");
    RNA_def_property_range(prop, -2.0, 2.0);
    RNA_def_property_ui_range(prop, -2.0, 2.0, 0.05, 5);
    RNA_def_property_ui_text(prop, "Multiplier", "Multiplier to adjust velocity passed to smoke");
    RNA_def_property_update(prop, NC_OBJECT|ND_MODIFIER, "rna_Smoke_reset");
}

static void rna_def_smoke_coll_settings(BlenderRNA *brna)
{
    StructRNA *srna;

    srna = RNA_def_struct(brna, "SmokeCollSettings", NULL);
    RNA_def_struct_ui_text(srna, "Collision Settings", "Smoke collision settings");
    RNA_def_struct_sdna(srna, "SmokeCollSettings");
    RNA_def_struct_path_func(srna, "rna_SmokeCollSettings_path");
}

void RNA_def_smoke(BlenderRNA *brna)
{
    rna_def_smoke_domain_settings(brna);
    rna_def_smoke_flow_settings(brna);
    rna_def_smoke_coll_settings(brna);
}

#endif