Viewport smoke: add support to render the volume using a color ramp.

This is yet another debug option that allows to render an arbitrary
simulation field by using a color ramp to inspect its voxel values.
Note that when using this, fire rendering is turned off.

Reviewers: plasmasolutions, gottfried

Differential Revision: https://developer.blender.org/D1733

1 files changed, 48 insertions, 0 deletions

diff --git a/source/blender/makesrna/intern/rna_smoke.c b/source/blender/makesrna/intern/rna_smoke.c
index b4ba306df3f..6db370fc152 100644
--- a/source/blender/makesrna/intern/rna_smoke.c
+++ b/source/blender/makesrna/intern/rna_smoke.c
@@ -30,6 +30,7 @@
 #include <limits.h>
 
 #include "RNA_define.h"
+#include "RNA_enum_types.h"
 
 #include "rna_internal.h"
 
@@ -53,6 +54,7 @@
 #include "BKE_context.h"
 #include "BKE_depsgraph.h"
 #include "BKE_particle.h"
+#include "BKE_texture.h"
 
 #include "smoke_API.h"
 
@@ -383,6 +385,17 @@ static void rna_SmokeFlow_uvlayer_set(PointerRNA *ptr, const char *value)
 	rna_object_uvlayer_name_set(ptr, value, flow->uvlayer_name, sizeof(flow->uvlayer_name));
 }
 
+static void rna_Smoke_use_color_ramp_set(PointerRNA *ptr, int value)
+{
+	SmokeDomainSettings *sds = (SmokeDomainSettings *)ptr->data;
+
+	sds->use_coba = value;
+
+	if (value && sds->coba == NULL) {
+		sds->coba = add_colorband(false);
+	}
+}
+
 #else
 
 static void rna_def_smoke_domain_settings(BlenderRNA *brna)
@@ -805,6 +818,41 @@ static void rna_def_smoke_domain_settings(BlenderRNA *brna)
 	RNA_def_property_ui_range(prop, 0.0, 100.0, 0.1, 3);
 	RNA_def_property_ui_text(prop, "Scale", "Multiplier for scaling the vectors");
 	RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
+
+	/* --------- Color mapping. --------- */
+
+	prop = RNA_def_property(srna, "use_color_ramp", PROP_BOOLEAN, PROP_NONE);
+	RNA_def_property_boolean_sdna(prop, NULL, "use_coba", 0);
+	RNA_def_property_boolean_funcs(prop, NULL, "rna_Smoke_use_color_ramp_set");
+	RNA_def_property_ui_text(prop, "Use Color Ramp",
+	                         "Render a simulation field while mapping its voxels values to the colors of a ramp");
+	RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
+
+	static EnumPropertyItem coba_field_items[] = {
+	    {FLUID_FIELD_COLOR_R, "COLOR_R", 0, "Red", "Red component of the color field"},
+	    {FLUID_FIELD_COLOR_G, "COLOR_G", 0, "Green", "Green component of the color field"},
+	    {FLUID_FIELD_COLOR_B, "COLOR_B", 0, "Blue", "Blue component of the color field"},
+		{FLUID_FIELD_DENSITY, "DENSITY", 0, "Density", "Quantity of soot in the fluid"},
+	    {FLUID_FIELD_FLAME, "FLAME", 0, "Flame", "Flame field"},
+	    {FLUID_FIELD_FUEL, "FUEL", 0, "Fuel", "Fuel field"},
+	    {FLUID_FIELD_HEAT, "HEAT", 0, "Heat", "Temperature of the fluid"},
+	    {FLUID_FIELD_VELOCITY_X, "VELOCITY_X", 0, "X Velocity", "X component of the velocity field"},
+	    {FLUID_FIELD_VELOCITY_Y, "VELOCITY_Y", 0, "Y Velocity", "Y component of the velocity field"},
+	    {FLUID_FIELD_VELOCITY_Z, "VELOCITY_Z", 0, "Z Velocity", "Z component of the velocity field"},
+		{0, NULL, 0, NULL, NULL}
+	};
+
+	prop = RNA_def_property(srna, "coba_field", PROP_ENUM, PROP_NONE);
+	RNA_def_property_enum_sdna(prop, NULL, "coba_field");
+	RNA_def_property_enum_items(prop, coba_field_items);
+	RNA_def_property_ui_text(prop, "Field", "Simulation field to color map");
+	RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
+
+	prop = RNA_def_property(srna, "color_ramp", PROP_POINTER, PROP_NEVER_NULL);
+	RNA_def_property_pointer_sdna(prop, NULL, "coba");
+	RNA_def_property_struct_type(prop, "ColorRamp");
+	RNA_def_property_ui_text(prop, "Color Ramp", "");
+	RNA_def_property_update(prop, NC_OBJECT | ND_DRAW, NULL);
 }
 
 static void rna_def_smoke_flow_settings(BlenderRNA *brna)