Allow customizing the fs2 selection effect (#6868)

* allow customizing the fs2 selection effect

* undo color color shift

Author: MjnMixael

code/missionui/missionscreencommon.cpp

@@ -1663,7 +1663,7 @@ void draw_model_icon(int model_id, uint64_t flags, float closeup_zoom, int x, in
 	gr_reset_clip();
 }
 
-void draw_model_rotating(model_render_params *render_info, int model_id, int x1, int y1, int x2, int y2, float *rotation_buffer, const vec3d *closeup_pos, float closeup_zoom, float rev_rate, uint64_t flags, int resize_mode, int effect)
+void draw_model_rotating(model_render_params *render_info, int model_id, int x1, int y1, int x2, int y2, float *rotation_buffer, const vec3d *closeup_pos, float closeup_zoom, float rev_rate, uint64_t flags, int resize_mode, select_effect_params effect_params)
 {
 	//WMC - Can't draw a non-model
 	if (model_id < 0)
@@ -1680,7 +1680,7 @@ void draw_model_rotating(model_render_params *render_info, int model_id, int x1,
 
 	const bool& shadow_disable_override = flags & MR_IS_MISSILE ? Shadow_disable_overrides.disable_mission_select_weapons : Shadow_disable_overrides.disable_mission_select_ships;
 
-	if (effect == 2) {  // FS2 Effect; Phase 0 Expand scanline, Phase 1 scan the grid and wireframe, Phase 2 scan up and reveal the ship, Phase 3 tilt the camera, Phase 4 start rotating the ship
+	if (effect_params.effect == 2) {  // FS2 Effect; Phase 0 Expand scanline, Phase 1 scan the grid and wireframe, Phase 2 scan up and reveal the ship, Phase 3 tilt the camera, Phase 4 start rotating the ship
 		// rotate the ship as much as required for this frame
 		if (time >= 3.6f) // Phase 4
 			*rotation_buffer += PI2 * flFrametime / rev_rate;
@@ -1743,7 +1743,7 @@ void draw_model_rotating(model_render_params *render_info, int model_id, int x1,
 		g3_start_instance_angles(&vmd_zero_vector,&view_angles);
 
 		if (time < 0.5f) { // Do the expanding scanline in phase 0
-			gr_set_color(0,255,0);
+			gr_set_color(effect_params.fs2_scanline_color.red, effect_params.fs2_scanline_color.green, effect_params.fs2_scanline_color.blue);
 			start.xyz.x = size*start_scale;
 			start.xyz.y = 0.0f;
 			start.xyz.z = -clip;
@@ -1758,32 +1758,38 @@ void draw_model_rotating(model_render_params *render_info, int model_id, int x1,
 		gr_zbuffer_set(GR_ZBUFF_NONE); // Turn off Depthbuffer so we don't get gridlines over the ship or a disappearing scanline 
 		Glowpoint_use_depth_buffer = false; // Since we don't have one
 		if (time >= 0.5f) { // Phase 1 onward draw the grid
-			int i;
 			start.xyz.y = -offset;
 			start.xyz.z = size+offset*0.5f;
 			stop.xyz.y = -offset;
 			stop.xyz.z = -size+offset*0.5f;
-			gr_set_color(0,200,0);
+			gr_set_color(effect_params.fs2_grid_color.red, effect_params.fs2_grid_color.green, effect_params.fs2_grid_color.blue);
 			g3_start_instance_angles(&vmd_zero_vector,&view_angles);
 
 			if (time < 1.5f) {
 				stop.xyz.z = -clip;
 			}
 
-			for (i = -3; i < 4; i++) {
-				start.xyz.x = stop.xyz.x = size*0.333f*i;
-				//g3_draw_htl_line(&start,&stop);
+			int num_lines = std::max(3, effect_params.fs2_grid_density);
+			float x_step = (size * 2.0f) / (num_lines - 1);
+			float x_start = -size;
+
+			for (int i = 0; i < num_lines; ++i) {
+				start.xyz.x = stop.xyz.x = x_start + i * x_step;
 				g3_render_line_3d(false, &start, &stop);
 			}
 
 			start.xyz.x = size;
 			stop.xyz.x = -size;
 
-			for (i = 3; i > -4; i--) {
-				start.xyz.z = stop.xyz.z = size*0.333f*i+offset*0.5f;
-				if ((time < 1.5f) && (start.xyz.z <= -clip))
+			float z_step = (size * 2.0f) / (num_lines - 1);
+			float z_start = size + offset * 0.5f;
+
+			for (int i = 0; i < num_lines; ++i) {
+				float z = z_start - i * z_step;
+				if ((time < 1.5f) && (z <= -clip))
 					break;
-				//g3_draw_htl_line(&start,&stop);
+
+				start.xyz.z = stop.xyz.z = z;
 				g3_render_line_3d(false, &start, &stop);
 			}
 
@@ -1825,8 +1831,8 @@ void draw_model_rotating(model_render_params *render_info, int model_id, int x1,
 				gr_set_view_matrix(&Eye_position, &Eye_matrix);
             }
 			gr_zbuffer_set(false);
-			gr_set_color(80,49,160);
-			render_info->set_color(80, 49, 160);
+			gr_set_color(effect_params.fs2_wireframe_color.red, effect_params.fs2_wireframe_color.green, effect_params.fs2_wireframe_color.blue);
+			render_info->set_color(effect_params.fs2_wireframe_color.red, effect_params.fs2_wireframe_color.green, effect_params.fs2_wireframe_color.blue);
 
 			render_info->set_animated_effect(ANIMATED_SHADER_LOADOUTSELECT_FS2, -clip);
 
@@ -1847,7 +1853,7 @@ void draw_model_rotating(model_render_params *render_info, int model_id, int x1,
 			}
 
 			if (time < 2.5f) { // Render the scanline in Phase 1 and 2
-				gr_set_color(0,255,0);
+				gr_set_color(effect_params.fs2_scanline_color.red, effect_params.fs2_scanline_color.green, effect_params.fs2_scanline_color.blue);
 				start.xyz.x = size*1.25f;
 				start.xyz.y = 0.0f;
 				start.xyz.z = -clip;
@@ -1924,7 +1930,7 @@ void draw_model_rotating(model_render_params *render_info, int model_id, int x1,
 
 		gr_set_color(0,128,0);
 
-		if (effect == 1) { // FS1 effect
+		if (effect_params.effect == 1) { // FS1 effect
 			render_info->set_animated_effect(ANIMATED_SHADER_LOADOUTSELECT_FS1, MIN(time*0.5f,2.0f));
 			render_info->set_flags(flags);
 		} else {

code/missionui/missionscreencommon.h

@@ -14,6 +14,7 @@
 
 #include "globalincs/globals.h"
 #include "gamesnd/gamesnd.h"
+#include "mod_table/mod_table.h"
 #include "model/model.h"
 #include "ui/ui.h"
 
@@ -212,6 +213,18 @@ typedef struct loadout_data
 
 extern loadout_data Player_loadout;
 
+struct select_effect_params {
+	int effect;                  // effect type (0 = none/rotate, 1 = FS1, 2 = FS2)
+	color fs2_grid_color;        // color of the grid in FS2 effect
+	color fs2_scanline_color;    // color of the scanlines in FS2 effect
+	int fs2_grid_density;        // density of the grid in FS2 effect
+	color fs2_wireframe_color;   // color of the model wireframe in FS2 effect
+
+	select_effect_params() : effect(2), fs2_grid_color(Default_fs2_effect_grid_color), fs2_scanline_color(Default_fs2_effect_scanline_color), fs2_grid_density(Default_fs2_effect_grid_density), fs2_wireframe_color(Default_fs2_effect_wireframe_color)
+	{
+	}
+};
+
 void wss_save_loadout();
 void wss_maybe_restore_loadout();
 void wss_direct_restore_loadout();
@@ -222,7 +235,7 @@ int restore_wss_data(ubyte *data);
 
 class ship_info;
 void draw_model_icon(int model_id, uint64_t flags, float closeup_zoom, int x1, int x2, int y1, int y2, ship_info* sip = NULL, int resize_mode = GR_RESIZE_FULL, const vec3d *closeup_pos = &vmd_zero_vector);
-void draw_model_rotating(model_render_params *render_info, int model_id, int x1, int y1, int x2, int y2, float *rotation_buffer, const vec3d *closeup_pos=nullptr, float closeup_zoom = .65f, float rev_rate = REVOLUTION_RATE, uint64_t flags = MR_AUTOCENTER | MR_NO_FOGGING, int resize_mode=GR_RESIZE_FULL, int effect = 2);
+void draw_model_rotating(model_render_params *render_info, int model_id, int x1, int y1, int x2, int y2, float *rotation_buffer, const vec3d *closeup_pos=nullptr, float closeup_zoom = .65f, float rev_rate = REVOLUTION_RATE, uint64_t flags = MR_AUTOCENTER | MR_NO_FOGGING, int resize_mode=GR_RESIZE_FULL, select_effect_params effect_params = select_effect_params{});
 
 void common_set_team_pointers(int team);
 void common_reset_team_pointers();

code/missionui/missionshipchoice.cpp

@@ -1452,6 +1452,13 @@ void ship_select_do(float frametime)
 				render_info.set_replacement_textures(ShipSelectModelNum, sip->replacement_textures);
 			}
 
+			select_effect_params params;
+			params.effect = sip->selection_effect;
+			params.fs2_grid_color = sip->fs2_effect_grid_color;
+			params.fs2_scanline_color = sip->fs2_effect_scanline_color;
+			params.fs2_grid_density = sip->fs2_effect_grid_density;
+			params.fs2_wireframe_color = sip->fs2_effect_wireframe_color;
+
 			draw_model_rotating(
 				&render_info, 
 				ShipSelectModelNum,
@@ -1465,7 +1472,7 @@ void ship_select_do(float frametime)
 				rev_rate,
 				MR_AUTOCENTER | MR_NO_FOGGING,
 				GR_RESIZE_MENU,
-				sip->selection_effect);
+				params);
 		}
 	}
 

code/missionui/missionweaponchoice.cpp

@@ -2813,6 +2813,13 @@ void weapon_select_do(float frametime)
 			modelIdx = model_load(wip->pofbitmap_name, nullptr, ErrorType::FATAL_ERROR);
 		}
 
+		select_effect_params params;
+		params.effect = wip->selection_effect;
+		params.fs2_grid_color = wip->fs2_effect_grid_color;
+		params.fs2_scanline_color = wip->fs2_effect_scanline_color;
+		params.fs2_grid_density = wip->fs2_effect_grid_density;
+		params.fs2_wireframe_color = wip->fs2_effect_wireframe_color;
+
 		model_render_params render_info;
 		draw_model_rotating(&render_info, 
 			modelIdx,
@@ -2826,7 +2833,7 @@ void weapon_select_do(float frametime)
 			REVOLUTION_RATE,
 			MR_IS_MISSILE | MR_AUTOCENTER | MR_NO_FOGGING,
 			GR_RESIZE_MENU,
-			wip->selection_effect);
+			params);
 	} else if ( Weapon_anim_class != -1 && ( Selected_wl_class == Weapon_anim_class )) {
 		Assert(Selected_wl_class >= 0 && Selected_wl_class < weapon_info_size());
 		if ( Weapon_anim_class != Selected_wl_class )

code/mod_table/mod_table.cpp

@@ -46,6 +46,10 @@ bool Use_3d_overhead_ship;
 overhead_style Default_overhead_ship_style;
 int Default_ship_select_effect;
 int Default_weapon_select_effect;
+color Default_fs2_effect_grid_color;
+color Default_fs2_effect_scanline_color;
+color Default_fs2_effect_wireframe_color;
+int Default_fs2_effect_grid_density;
 int Default_fiction_viewer_ui;
 bool Enable_external_shaders;
 bool Enable_external_default_scripts;
@@ -1217,6 +1221,44 @@ void parse_mod_table(const char *filename)
 					mprintf(("Game Settings Table: Using 3D weapon icons\n"));
 			}
 
+			if (optional_string("$FS2 effect grid color:")) {
+				int rgb[3];
+				stuff_int_list(rgb, 3);
+				CLAMP(rgb[0], 0, 255);
+				CLAMP(rgb[1], 0, 255);
+				CLAMP(rgb[2], 0, 255);
+				gr_init_color(&Default_fs2_effect_grid_color, rgb[0], rgb[1], rgb[2]);
+			}
+
+			if (optional_string("$FS2 effect scanline color:")) {
+				int rgb[3];
+				stuff_int_list(rgb, 3);
+				CLAMP(rgb[0], 0, 255);
+				CLAMP(rgb[1], 0, 255);
+				CLAMP(rgb[2], 0, 255);
+				gr_init_color(&Default_fs2_effect_scanline_color, rgb[0], rgb[1], rgb[2]);
+			}
+
+			if (optional_string("$FS2 effect grid density:")) {
+				int tmp;
+				stuff_int(&tmp);
+				// only set value if it is above 0
+				if (tmp > 0) {
+					Default_fs2_effect_grid_density = tmp;
+				} else {
+					Warning(LOCATION, "The $FS2 effect grid density must be above 0.\n");
+				}
+			}
+
+			if (optional_string("$FS2 effect wireframe color:")) {
+				int rgb[3];
+				stuff_int_list(rgb, 3);
+				CLAMP(rgb[0], 0, 255);
+				CLAMP(rgb[1], 0, 255);
+				CLAMP(rgb[2], 0, 255);
+				gr_init_color(&Default_fs2_effect_wireframe_color, rgb[0], rgb[1], rgb[2]);
+			}
+
 			if (optional_string("$Use 3d overhead ship:")) {
 				stuff_boolean(&Use_3d_overhead_ship);
 				if (Use_3d_overhead_ship)
@@ -1658,6 +1700,10 @@ void mod_table_reset()
 	Always_show_directive_value_count = false;
 	Default_ship_select_effect = 2;
 	Default_weapon_select_effect = 2;
+	gr_init_color(&Default_fs2_effect_grid_color, 0, 200, 0);
+	gr_init_color(&Default_fs2_effect_scanline_color, 0, 255, 0);
+	Default_fs2_effect_grid_density = 7; // Default original value
+	gr_init_color(&Default_fs2_effect_wireframe_color, 80, 49, 160);
 	Default_overhead_ship_style = OH_TOP_VIEW;
 	Default_fiction_viewer_ui = -1;
 	Enable_external_shaders = false;

code/mod_table/mod_table.h

@@ -59,6 +59,10 @@ extern bool Use_3d_weapon_select;
 extern int Default_weapon_select_effect;
 extern bool Use_3d_weapon_icons;
 extern bool Use_3d_overhead_ship;
+extern color Default_fs2_effect_grid_color;
+extern color Default_fs2_effect_scanline_color;
+extern color Default_fs2_effect_wireframe_color;
+extern int Default_fs2_effect_grid_density;
 extern overhead_style Default_overhead_ship_style;
 extern int Default_fiction_viewer_ui;
 extern bool Enable_external_shaders;

code/scripting/api/objs/shipclass.cpp

@@ -1262,6 +1262,13 @@ ADE_FUNC(renderSelectModel,
 		render_info.set_replacement_textures(modelNum, sip->replacement_textures);
 	}
 
+	select_effect_params params;
+	params.effect = effect;
+	params.fs2_grid_color = sip->fs2_effect_grid_color;
+	params.fs2_scanline_color = sip->fs2_effect_scanline_color;
+	params.fs2_grid_density = sip->fs2_effect_grid_density;
+	params.fs2_wireframe_color = sip->fs2_effect_wireframe_color;
+
 	draw_model_rotating(&render_info,
 		modelNum,
 		x1,
@@ -1274,7 +1281,7 @@ ADE_FUNC(renderSelectModel,
 		rev_rate,
 		MR_AUTOCENTER | MR_NO_FOGGING,
 		GR_RESIZE_NONE,
-		effect);
+		params);
 
 	return ade_set_args(L, "b", true);
 }

code/scripting/api/objs/weaponclass.cpp

@@ -1151,6 +1151,13 @@ ADE_FUNC(renderSelectModel,
 
 	model_render_params render_info;
 
+	select_effect_params params;
+	params.effect = effect;
+	params.fs2_grid_color = wip->fs2_effect_grid_color;
+	params.fs2_scanline_color = wip->fs2_effect_scanline_color;
+	params.fs2_grid_density = wip->fs2_effect_grid_density;
+	params.fs2_wireframe_color = wip->fs2_effect_wireframe_color;
+
 	draw_model_rotating(&render_info,
 		modelNum,
 		x1,
@@ -1163,7 +1170,7 @@ ADE_FUNC(renderSelectModel,
 		REVOLUTION_RATE,
 		MR_IS_MISSILE | MR_AUTOCENTER | MR_NO_FOGGING,
 		GR_RESIZE_NONE,
-		effect);
+		params);
 
 	return ade_set_args(L, "b", true);
 }

code/ship/ship.cpp

@@ -1209,6 +1209,10 @@ void ship_info::clone(const ship_info& other)
 	strcpy_s(anim_filename, other.anim_filename);
 	strcpy_s(overhead_filename, other.overhead_filename);
 	selection_effect = other.selection_effect;
+	fs2_effect_grid_color = other.fs2_effect_grid_color;
+	fs2_effect_scanline_color = other.fs2_effect_scanline_color;
+	fs2_effect_grid_density = other.fs2_effect_grid_density;
+	fs2_effect_wireframe_color = other.fs2_effect_wireframe_color;
 
 	wingmen_status_dot_override = other.wingmen_status_dot_override;
 
@@ -1549,6 +1553,10 @@ void ship_info::move(ship_info&& other)
 	std::swap(anim_filename, other.anim_filename);
 	std::swap(overhead_filename, other.overhead_filename);
 	selection_effect = other.selection_effect;
+	fs2_effect_grid_color = other.fs2_effect_grid_color;
+	fs2_effect_scanline_color = other.fs2_effect_scanline_color;
+	fs2_effect_grid_density = other.fs2_effect_grid_density;
+	fs2_effect_wireframe_color = other.fs2_effect_wireframe_color;
 
 	wingmen_status_dot_override = other.wingmen_status_dot_override;
 
@@ -1926,6 +1934,10 @@ ship_info::ship_info()
 	overhead_filename[0] = '\0';
 
 	selection_effect = Default_ship_select_effect;
+	fs2_effect_grid_color = Default_fs2_effect_grid_color;
+	fs2_effect_scanline_color = Default_fs2_effect_scanline_color;
+	fs2_effect_grid_density = Default_fs2_effect_grid_density;
+	fs2_effect_wireframe_color = Default_fs2_effect_wireframe_color;
 
 	wingmen_status_dot_override = -1;
 
@@ -3036,6 +3048,44 @@ static void parse_ship_values(ship_info* sip, const bool is_template, const bool
 			sip->selection_effect = 0;
 	}
 
+	if (optional_string("$FS2 effect grid color:")) {
+		int rgb[3];
+		stuff_int_list(rgb, 3);
+		CLAMP(rgb[0], 0, 255);
+		CLAMP(rgb[1], 0, 255);
+		CLAMP(rgb[2], 0, 255);
+		gr_init_color(&sip->fs2_effect_grid_color, rgb[0], rgb[1], rgb[2]);
+	}
+
+	if (optional_string("$FS2 effect scanline color:")) {
+		int rgb[3];
+		stuff_int_list(rgb, 3);
+		CLAMP(rgb[0], 0, 255);
+		CLAMP(rgb[1], 0, 255);
+		CLAMP(rgb[2], 0, 255);
+		gr_init_color(&sip->fs2_effect_scanline_color, rgb[0], rgb[1], rgb[2]);
+	}
+
+	if (optional_string("$FS2 effect grid density:")) {
+		int tmp;
+		stuff_int(&tmp);
+		// only set value if it is above 0
+		if (tmp > 0) {
+			sip->fs2_effect_grid_density = tmp;
+		} else {
+			Warning(LOCATION, "The $FS2 effect grid density must be above 0.\n");
+		}
+	}
+
+	if (optional_string("$FS2 effect wireframe color:")) {
+		int rgb[3];
+		stuff_int_list(rgb, 3);
+		CLAMP(rgb[0], 0, 255);
+		CLAMP(rgb[1], 0, 255);
+		CLAMP(rgb[2], 0, 255);
+		gr_init_color(&sip->fs2_effect_wireframe_color, rgb[0], rgb[1], rgb[2]);
+	}
+
 	// This only works if the hud gauge defined uses $name assignment
 	if (optional_string("$HUD Gauge Configs:")) {
 		SCP_vector<SCP_string> gauge_configs;

code/ship/ship.h

@@ -1354,6 +1354,10 @@ class ship_info
 	char	anim_filename[MAX_FILENAME_LEN];	// filename for animation that plays in ship selection
 	char	overhead_filename[MAX_FILENAME_LEN];	// filename for animation that plays weapons loadout
 	int 	selection_effect;
+	color   fs2_effect_grid_color;				// color of the grid effect in the ship selection screen
+	color  fs2_effect_scanline_color;           // color of the scanline effect in the ship selection screen
+	int     fs2_effect_grid_density;			// density of the grid effect in the ship selection screen
+	color   fs2_effect_wireframe_color;         // color of the wireframe effect in the ship selection screen
 
 	int wingmen_status_dot_override; // optional wingmen dot status animation to use instead of default --wookieejedi