Merge remote-tracking branch 'origin/vorticity' into playtest-june2025

jacob1 · jacob1 · commit 12c4070c8ddd · 2025-05-31T22:35:52.000-04:00
diff --git a/src/client/GameSave.cpp b/src/client/GameSave.cpp
@@ -17,7 +17,7 @@
 #include <algorithm>
 
 constexpr auto currentVersion = UPSTREAM_VERSION.displayVersion;
-constexpr auto nextVersion = Version(99, 3);
+constexpr auto nextVersion = Version(100, 0);
 static_assert(!ALLOW_FAKE_NEWER_VERSION || nextVersion >= currentVersion);
 
 constexpr auto effectiveVersion = ALLOW_FAKE_NEWER_VERSION ? nextVersion : currentVersion;
@@ -630,6 +630,7 @@ void GameSave::readOPS(const std::vector<char> &data)
 		CheckBsonFieldFloat(iter, "customGravityY", &customGravityY);
 		CheckBsonFieldInt(iter, "airMode", &airMode);
 		CheckBsonFieldFloat(iter, "ambientAirTemp", &ambientAirTemp);
+		CheckBsonFieldFloat(iter, "vorticityCoeff", &vorticityCoeff);
 		CheckBsonFieldInt(iter, "edgeMode", &edgeMode);
 		CheckBsonFieldInt(iter, "pmapbits", &pmapbits);
 		CheckBsonFieldBool(iter, "ensureDeterminism", &ensureDeterminism);
@@ -2583,6 +2584,11 @@ std::pair<bool, std::vector<char>> GameSave::serialiseOPS() const
 		bson_append_double(&b, "ambientAirTemp", double(ambientAirTemp));
 		RESTRICTVERSION(96, 0);
 	}
+	if (vorticityCoeff > 0.0001f && vorticityCoeff < 1.0f)
+	{
+		bson_append_double(&b, "vorticityCoeff", double(vorticityCoeff));
+		RESTRICTVERSION(100, 0);
+	}
 	bson_append_int(&b, "edgeMode", edgeMode);
 
 	if (stkm.hasData())
diff --git a/src/client/GameSave.h b/src/client/GameSave.h
@@ -107,6 +107,7 @@ class GameSave
 	float customGravityY = 0.0f;
 	int airMode = 0;
 	float ambientAirTemp = R_TEMP + 273.15f;
+	float vorticityCoeff = 0.0f;
 	int edgeMode = 0;
 	bool wantAuthors = true;
 
diff --git a/src/graphics/Graphics.cpp b/src/graphics/Graphics.cpp
@@ -435,6 +435,12 @@ void Graphics::draw_icon(int x, int y, Icon icon, unsigned char alpha, bool inve
 			BlendChar({ x + 1, y + 1 }, 0xE055, 0x37FF37_rgb .WithAlpha(alpha));
 		}
 		break;
+	case IconVort:
+		if(invert)
+			BlendChar({ x + 1, y + 1 }, 0xE054, 0xA64D79_rgb .WithAlpha(alpha));
+		else
+			BlendChar({ x + 1, y + 1 }, 0xE054, 0xC27BA0_rgb .WithAlpha(alpha));
+		break;
 	default:
 		if(invert)
 			BlendChar({ x, y }, 't', 0x000000_rgb .WithAlpha(alpha));
diff --git a/src/graphics/Icons.h b/src/graphics/Icons.h
@@ -38,5 +38,6 @@ enum Icon
 	IconPersistant,
 	IconHeat,
 	IconLife,
-	IconGradient
+	IconGradient,
+	IconVort
 };
diff --git a/src/graphics/Renderer.cpp b/src/graphics/Renderer.cpp
@@ -988,6 +988,14 @@ void Renderer::draw_air()
 					c = RGB(r, g, b);
 				}
 			}
+			else if (displayMode & DISPLAY_AIRW)
+			{
+				auto w = 4*Air::vorticity(*sim, y, x);
+				if (w > 0.0f)
+					c = RGB(clamp_flt(w, 0.0f, 8.0f), 0, 0); //positive vorticity is red
+				else
+					c = RGB(0, 0, clamp_flt(-w, 0.0f, 8.0f)); //negative vorticity is blue
+			}
 			if (findingElement)
 			{
 				c.Red   /= 10;
diff --git a/src/gui/game/GameModel.cpp b/src/gui/game/GameModel.cpp
@@ -61,6 +61,7 @@ GameModel::GameModel(GameView *newView):
 	colour(255, 0, 0, 255),
 	edgeMode(EDGE_VOID),
 	ambientAirTemp(R_TEMP + 273.15f),
+	vorticityCoeff(0.0f),
 	decoSpace(DECOSPACE_SRGB),
 	view(newView)
 {
@@ -121,6 +122,17 @@ GameModel::GameModel(GameView *newView):
 		}
 	}
 	sim->air->ambientAirTemp = ambientAirTemp;
+
+	vorticityCoeff = 0.1f; // The default for old saves is 0, but use 0.1 for old configs
+	{
+		auto vort = prefs.Get("Simulation.VorticityCoeff", vorticityCoeff);
+		if (0.0f <= vort && vort <= 1.0f)
+		{
+			vorticityCoeff = vort;
+		}
+	}
+	sim->air->vorticityCoeff = vorticityCoeff;
+
 	decoSpace = prefs.Get("Simulation.DecoSpace", NUM_DECOSPACES, DECOSPACE_SRGB);
 	sim->SetDecoSpace(decoSpace);
 	if (prefs.Get("Simulation.NewtonianGravity", false))
@@ -308,6 +320,17 @@ float GameModel::GetAmbientAirTemperature()
 	return this->ambientAirTemp;
 }
 
+void GameModel::SetVorticityCoeff(float vorticityCoeff)
+{
+	this->vorticityCoeff = vorticityCoeff;
+	sim->air->vorticityCoeff = vorticityCoeff;
+}
+
+float GameModel::GetVorticityCoeff()
+{
+	return this->vorticityCoeff;
+}
+
 void GameModel::SetDecoSpace(int decoSpace)
 {
 	sim->SetDecoSpace(decoSpace);
@@ -736,6 +759,7 @@ void GameModel::SaveToSimParameters(const GameSave &saveData)
 	sim->customGravityY = saveData.customGravityY;
 	sim->air->airMode = saveData.airMode;
 	sim->air->ambientAirTemp = saveData.ambientAirTemp;
+	sim->air->vorticityCoeff = saveData.vorticityCoeff;
 	sim->edgeMode = saveData.edgeMode;
 	sim->legacy_enable = saveData.legacyEnable;
 	sim->water_equal_test = saveData.waterEEnabled;
@@ -1112,6 +1136,7 @@ void GameModel::ClearSimulation()
 	sim->water_equal_test = false;
 	sim->SetEdgeMode(edgeMode);
 	sim->air->ambientAirTemp = ambientAirTemp;
+	sim->air->vorticityCoeff = vorticityCoeff;
 
 	sim->clear_sim();
 	ren->ClearAccumulation();
diff --git a/src/gui/game/GameModel.h b/src/gui/game/GameModel.h
@@ -104,6 +104,7 @@ class GameModel
 
 	int edgeMode;
 	float ambientAirTemp;
+	float vorticityCoeff;
 	int decoSpace;
 
 	String infoTip;
@@ -162,6 +163,8 @@ class GameModel
 	}
 	void SetAmbientAirTemperature(float ambientAirTemp);
 	float GetAmbientAirTemperature();
+	void SetVorticityCoeff(float vorticityCoeff);
+	float GetVorticityCoeff();
 	void SetDecoSpace(int decoSpace);
 	int GetDecoSpace();
 
diff --git a/src/gui/options/OptionsController.cpp b/src/gui/options/OptionsController.cpp
@@ -62,6 +62,11 @@ void OptionsController::SetAmbientAirTemperature(float ambientAirTemp)
 	model->SetAmbientAirTemperature(ambientAirTemp);
 }
 
+void OptionsController::SetVorticityCoeff(float vorticityCoeff)
+{
+	model->SetVorticityCoeff(vorticityCoeff);
+}
+
 void OptionsController::SetEdgeMode(int edgeMode)
 {
 	model->SetEdgeMode(edgeMode);
diff --git a/src/gui/options/OptionsController.h b/src/gui/options/OptionsController.h
@@ -22,6 +22,7 @@ class OptionsController
 	void SetCustomGravityY(float y);
 	void SetAirMode(int airMode);
 	void SetAmbientAirTemperature(float ambientAirTemp);
+	void SetVorticityCoeff(float vorticityCoeff);
 	void SetEdgeMode(int edgeMode);
 	void SetTemperatureScale(int temperatureScale);
 	void SetThreadedRendering(bool newThreadedRendering);
diff --git a/src/gui/options/OptionsModel.cpp b/src/gui/options/OptionsModel.cpp
@@ -119,6 +119,17 @@ void OptionsModel::SetAmbientAirTemperature(float ambientAirTemp)
 	notifySettingsChanged();
 }
 
+float OptionsModel::GetVorticityCoeff()
+{
+	return gModel->GetSimulation()->air->vorticityCoeff;
+}
+void OptionsModel::SetVorticityCoeff(float vorticityCoeff)
+{
+	GlobalPrefs::Ref().Set("Simulation.VorticityCoeff", vorticityCoeff);
+	gModel->SetVorticityCoeff(vorticityCoeff);
+	notifySettingsChanged();
+}
+
 int OptionsModel::GetGravityMode()
 {
 	return sim->gravityMode;
diff --git a/src/gui/options/OptionsModel.h b/src/gui/options/OptionsModel.h
@@ -27,6 +27,8 @@ class OptionsModel
 	void SetAirMode(int airMode);
 	float GetAmbientAirTemperature();
 	void SetAmbientAirTemperature(float ambientAirTemp);
+	float GetVorticityCoeff();
+	void SetVorticityCoeff(float vorticityCoeff);
 	int GetEdgeMode();
 	void SetEdgeMode(int edgeMode);
 	int GetTemperatureScale();
diff --git a/src/gui/options/OptionsView.cpp b/src/gui/options/OptionsView.cpp
@@ -138,6 +138,22 @@ OptionsView::OptionsView() : ui::Window(ui::Point(-1, -1), ui::Point(320, 340))
 		scrollPanel->AddChild(label);
 		currentY += 20;
 	}
+	{ // Vorticity coefficient setting
+		vorticityCoeff = new ui::Textbox(ui::Point(Size.X-95, currentY), ui::Point(80, 16));
+		vorticityCoeff->SetActionCallback({ [this] {
+			UpdateVorticityCoeff(vorticityCoeff->GetText(), false);
+		} });
+		vorticityCoeff->SetDefocusCallback({ [this] {
+			UpdateVorticityCoeff(vorticityCoeff->GetText(), true);
+		}});
+		vorticityCoeff->SetLimit(9);
+		scrollPanel->AddChild(vorticityCoeff);
+		auto *label = new ui::Label(ui::Point(8, currentY), ui::Point(Size.X-105, 16), "Vorticity confinement");
+		label->Appearance.HorizontalAlign = ui::Appearance::AlignLeft;
+		label->Appearance.VerticalAlign = ui::Appearance::AlignMiddle;
+		scrollPanel->AddChild(label);
+		currentY += 20;
+	}
 	class GravityWindow : public ui::Window
 	{
 		void OnTryExit(ExitMethod method) override
@@ -430,6 +446,13 @@ void OptionsView::AmbientAirTempToTextBox(float airTemp)
 	ambientAirTemp->SetText(sb.Build());
 }
 
+void OptionsView::VorticityCoeffToTextBox(float vorticity)
+{
+	StringBuilder sb;
+	sb << Format::Precision(2) << vorticity;
+	vorticityCoeff->SetText(sb.Build());
+}
+
 void OptionsView::UpdateStartupRequestStatus()
 {
 	switch (Client::Ref().GetStartupRequestStatus())
@@ -502,6 +525,47 @@ void OptionsView::UpdateAirTemp(String temp, bool isDefocus)
 	UpdateAmbientAirTempPreview(airTemp, isValid);
 }
 
+void OptionsView::UpdateVorticityCoeff(String vort, bool isDefocus)
+{
+	// Parse vorticity and determine validity
+	float vorticity = 0;
+	bool isValid;
+	try
+	{
+		vorticity = vort.ToNumber<float>();
+		isValid = true;
+	}
+	catch (const std::exception &ex)
+	{
+		isValid = false;
+	}
+
+	// While defocusing, correct out of range vorticity and empty textboxes
+	if (isDefocus)
+	{
+		if (vort.empty())
+		{
+			isValid = true;
+			vorticity = 0.0f;
+		}
+		else if (!isValid)
+			return;
+		else if (vorticity < 0.0f)
+			vorticity = 0.0f;
+		else if (vorticity > 1.0f)
+			vorticity = 1.0f;
+
+		VorticityCoeffToTextBox(vorticity);
+	}
+	// Out of range vorticities are invalid, preview should go away
+	else if (isValid && (vorticity < 0.0f || vorticity > 1.0f))
+		isValid = false;
+
+	// If valid, set vorticity
+	if (isValid)
+		c->SetVorticityCoeff(vorticity);
+}
+
 void OptionsView::NotifySettingsChanged(OptionsModel * sender)
 {
 	temperatureScale->SetOption(sender->GetTemperatureScale()); // has to happen before AmbientAirTempToTextBox is called
@@ -517,6 +581,11 @@ void OptionsView::NotifySettingsChanged(OptionsModel * sender)
 		UpdateAmbientAirTempPreview(airTemp, true);
 		AmbientAirTempToTextBox(airTemp);
 	}
+	// Same for vorticity
+	if (!vorticityCoeff->IsFocused())
+	{
+		VorticityCoeffToTextBox(sender->GetVorticityCoeff());
+	}
 	gravityMode->SetOption(sender->GetGravityMode());
 	customGravityX = sender->GetCustomGravityX();
 	customGravityY = sender->GetCustomGravityY();
diff --git a/src/gui/options/OptionsView.h b/src/gui/options/OptionsView.h
@@ -24,6 +24,7 @@ class OptionsView: public ui::Window
 	ui::DropDown *airMode{};
 	ui::Textbox *ambientAirTemp{};
 	ui::Button *ambientAirTempPreview{};
+	ui::Textbox *vorticityCoeff{};
 	ui::DropDown *gravityMode{};
 	ui::DropDown *edgeMode{};
 	ui::DropDown *temperatureScale{};
@@ -52,6 +53,8 @@ class OptionsView: public ui::Window
 	void UpdateAmbientAirTempPreview(float airTemp, bool isValid);
 	void AmbientAirTempToTextBox(float airTemp);
 	void UpdateAirTemp(String temp, bool isDefocus);
+	void VorticityCoeffToTextBox(float vorticity);
+	void UpdateVorticityCoeff(String cort, bool isDefocus);
 	void UpdateStartupRequestStatus();
 public:
 	OptionsView();
diff --git a/src/gui/render/RenderView.cpp b/src/gui/render/RenderView.cpp
@@ -91,11 +91,12 @@ RenderView::RenderView():
 	addDisplayModeCheckbox(DISPLAY_AIRP, IconPressure  , ui::Point(135, 22), "Displays pressure, red is positive and blue is negative");
 	addDisplayModeCheckbox(DISPLAY_AIRV, IconVelocity  , ui::Point(167,  4), "Displays velocity and positive pressure: up/down adds blue, right/left adds red, still pressure adds green");
 	addDisplayModeCheckbox(DISPLAY_AIRH, IconHeat      , ui::Point(167, 22), "Displays the temperature of the air like heat display does");
-	line2 = 200;
-	addDisplayModeCheckbox(DISPLAY_WARP, IconWarp      , ui::Point(205, 22), "Gravity lensing, Newtonian Gravity bends light with this on");
-	addDisplayModeCheckbox(DISPLAY_EFFE, IconEffect    , ui::Point(205,  4), "Enables moving solids, stickmen guns, and premium(tm) graphics");
-	addDisplayModeCheckbox(DISPLAY_PERS, IconPersistant, ui::Point(237,  4), "Element paths persist on the screen for a while");
-	line3 = 270;
+	addDisplayModeCheckbox(DISPLAY_AIRW, IconVort      , ui::Point(199,  4), "Displays vorticity, red is clockwise and blue is anticlockwise");
+	line2 = 232;
+	addDisplayModeCheckbox(DISPLAY_WARP, IconWarp      , ui::Point(237, 22), "Gravity lensing, Newtonian Gravity bends light with this on");
+	addDisplayModeCheckbox(DISPLAY_EFFE, IconEffect    , ui::Point(237,  4), "Enables moving solids, stickmen guns, and premium(tm) graphics");
+	addDisplayModeCheckbox(DISPLAY_PERS, IconPersistant, ui::Point(269,  4), "Element paths persist on the screen for a while");
+	line3 = 302;
 
 	auto addColourModeCheckbox = [this](unsigned int mode, Icon icon, ui::Point offset, String tooltip) {
 		auto *colourModeCheckbox = new ModeCheckbox(ui::Point(0, YRES) + offset, ui::Point(30, 16), "", tooltip);
@@ -117,11 +118,11 @@ RenderView::RenderView():
 		} });
 		AddComponent(colourModeCheckbox);
 	};
-	addColourModeCheckbox(COLOUR_HEAT, IconHeat    , ui::Point(275,  4), "Displays temperatures of the elements, dark blue is coldest, pink is hottest");
-	addColourModeCheckbox(COLOUR_LIFE, IconLife    , ui::Point(275, 22), "Displays the life value of elements in greyscale gradients");
-	addColourModeCheckbox(COLOUR_GRAD, IconGradient, ui::Point(307, 22), "Changes colors of elements slightly to show heat diffusing through them");
-	addColourModeCheckbox(COLOUR_BASC, IconBasic   , ui::Point(307,  4), "No special effects at all for anything, overrides all other options and deco");
-	line4 = 340;
+	addColourModeCheckbox(COLOUR_HEAT, IconHeat    , ui::Point(307,  4), "Displays temperatures of the elements, dark blue is coldest, pink is hottest");
+	addColourModeCheckbox(COLOUR_LIFE, IconLife    , ui::Point(307, 22), "Displays the life value of elements in greyscale gradients");
+	addColourModeCheckbox(COLOUR_GRAD, IconGradient, ui::Point(339, 22), "Changes colors of elements slightly to show heat diffusing through them");
+	addColourModeCheckbox(COLOUR_BASC, IconBasic   , ui::Point(339,  4), "No special effects at all for anything, overrides all other options and deco");
+	line4 = 372;
 }
 
 uint32_t RenderView::CalculateRenderMode()
diff --git a/src/lua/LuaRenderer.cpp b/src/lua/LuaRenderer.cpp
@@ -370,6 +370,7 @@ void LuaRenderer::Open(lua_State *L)
 	LCONST(DISPLAY_WARP);
 	LCONST(DISPLAY_PERS);
 	LCONST(DISPLAY_EFFE);
+	LCONST(DISPLAY_AIRW);
 #undef LCONST
 	lua_pushvalue(L, -1);
 	lua_setglobal(L, "renderer");
diff --git a/src/lua/LuaSimulation.cpp b/src/lua/LuaSimulation.cpp
@@ -1275,6 +1275,21 @@ static int ambientAirTemp(lua_State *L)
 	return 0;
 }
 
+static int vorticityCoeff(lua_State *L)
+{
+	auto *lsi = GetLSI();
+	int acount = lua_gettop(L);
+	if (acount == 0)
+	{
+		lua_pushnumber(L, lsi->sim->air->vorticityCoeff);
+		return 1;
+	}
+	lsi->AssertInterfaceEvent();
+	float vorticityCoeff = restrict_flt(luaL_optnumber(L, 1, 0.0f), 0.0f, 1.0f);
+	lsi->gameModel->SetVorticityCoeff(vorticityCoeff);
+	return 0;
+}
+
 static int elementCount(lua_State *L)
 {
 	int element = luaL_optint(L, 1, 0);
@@ -2013,6 +2028,7 @@ void LuaSimulation::Open(lua_State *L)
 		LFUNC(airMode),
 		LFUNC(waterEqualization),
 		LFUNC(ambientAirTemp),
+		LFUNC(vorticityCoeff),
 		LFUNC(elementCount),
 		LFUNC(canMove),
 		LFUNC(brush),
diff --git a/src/simulation/Air.cpp b/src/simulation/Air.cpp
diff --git a/src/simulation/Air.h b/src/simulation/Air.h
diff --git a/src/simulation/ElementGraphics.h b/src/simulation/ElementGraphics.h
diff --git a/src/simulation/Simulation.cpp b/src/simulation/Simulation.cpp

Original file line number	Diff line number	Diff line change
`@@ -988,6 +988,14 @@ void Renderer::draw_air()`
`988`	`988`	`c = RGB(r, g, b);`
`989`	`989`	`}`
`990`	`990`	`}`
	`991`	`+ else if (displayMode & DISPLAY_AIRW)`
	`992`	`+ {`
	`993`	`+ auto w = 4Air::vorticity(sim, y, x);`
	`994`	`+ if (w > 0.0f)`
	`995`	`+ c = RGB(clamp_flt(w, 0.0f, 8.0f), 0, 0); //positive vorticity is red`
	`996`	`+ else`
	`997`	`+ c = RGB(0, 0, clamp_flt(-w, 0.0f, 8.0f)); //negative vorticity is blue`
	`998`	`+ }`
`991`	`999`	`if (findingElement)`
`992`	`1000`	`{`
`993`	`1001`	`c.Red /= 10;`
Original file line number	Diff line number	Diff line change
`@@ -62,6 +62,11 @@ void OptionsController::SetAmbientAirTemperature(float ambientAirTemp)`
`62`	`62`	`model->SetAmbientAirTemperature(ambientAirTemp);`
`63`	`63`	`}`
`64`	`64`
	`65`	`+void OptionsController::SetVorticityCoeff(float vorticityCoeff)`
	`66`	`+{`
	`67`	`+ model->SetVorticityCoeff(vorticityCoeff);`
	`68`	`+}`
	`69`	`+`
`65`	`70`	`void OptionsController::SetEdgeMode(int edgeMode)`
`66`	`71`	`{`
`67`	`72`	`model->SetEdgeMode(edgeMode);`