GI#66, CF#243 - Background Layer Improvements

Activities/ActorEditor.cpp

@@ -319,7 +319,6 @@ void ActorEditor::DrawGUI(BITMAP *pTargetBitmap, const Vector &targetPos, int wh
     if (m_pEditedActor)
     {
         m_pEditedActor->Draw(pTargetBitmap, targetPos, g_DrawColor);
-        m_pEditedActor->Draw(pTargetBitmap, targetPos, g_DrawDebug);
     }
 
     // Clear out annoying blooms

Activities/AreaEditor.cpp

@@ -611,7 +611,7 @@ bool AreaEditor::SaveScene(string saveAsName, bool forceOverwrite)
 	if (g_PresetMan.GetDataModule(m_ModuleSpaceID)->GetFileName() == "Scenes.rte")
 	{
 		string sceneFilePath(g_PresetMan.GetDataModule(m_ModuleSpaceID)->GetFileName() + "/" + saveAsName + ".ini");
-		string previewFilePath(g_PresetMan.GetDataModule(m_ModuleSpaceID)->GetFileName() + "/" + saveAsName + ".preview.bmp");
+		string previewFilePath(g_PresetMan.GetDataModule(m_ModuleSpaceID)->GetFileName() + "/" + saveAsName + ".preview.png");
 		if (g_PresetMan.AddEntityPreset(g_SceneMan.GetScene(), m_ModuleSpaceID, forceOverwrite, sceneFilePath))
 		{
 			// Save preview
@@ -638,7 +638,7 @@ bool AreaEditor::SaveScene(string saveAsName, bool forceOverwrite)
 	{
 		// Try to save to the data module
 		string sceneFilePath(g_PresetMan.GetDataModule(m_ModuleSpaceID)->GetFileName() + "/Scenes/" + saveAsName + ".ini");
-		string previewFilePath(g_PresetMan.GetDataModule(m_ModuleSpaceID)->GetFileName() + "/Scenes/" + saveAsName + ".preview.bmp");
+		string previewFilePath(g_PresetMan.GetDataModule(m_ModuleSpaceID)->GetFileName() + "/Scenes/" + saveAsName + ".preview.png");
 		if (g_PresetMan.AddEntityPreset(g_SceneMan.GetScene(), m_ModuleSpaceID, forceOverwrite, sceneFilePath))
 		{
             // Save preview

Activities/GibEditor.cpp

@@ -338,7 +338,7 @@ void GibEditor::Update()
                 // Clear out the terrain after a few tests
                 if (m_TestCounter >= 3)
                 {
-                    g_SceneMan.GetScene()->GetTerrain()->ClearAllMaterial();
+					ClearTestArea();
                     m_TestCounter = 0;
                 }
                 // Clear all crap still flying around
@@ -529,7 +529,7 @@ void GibEditor::Update()
                     }
 
                     // Clear out the testing area
-                    g_SceneMan.GetScene()->GetTerrain()->ClearAllMaterial();
+					ClearTestArea();
                     m_TestCounter = 0;
 
                     m_pObjectToLoad = 0;
@@ -955,4 +955,11 @@ void GibEditor::UpdateOverwriteDialog()
         m_pOverwriteNameLabel->SetText(g_PresetMan.GetDataModule(m_ModuleSpaceID)->GetFileName() + "/NewData/" + m_pEditedObject->GetPresetName() + ".ini");
 }
 
-} // namespace RTE
+/////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
+
+	void GibEditor::ClearTestArea() const {
+		clear_bitmap(g_SceneMan.GetTerrain()->GetFGColorBitmap());
+		clear_bitmap(g_SceneMan.GetTerrain()->GetBGColorBitmap());
+		clear_bitmap(g_SceneMan.GetTerrain()->GetMaterialBitmap());
+	}
+}

Activities/GibEditor.h

@@ -306,6 +306,11 @@ ClassInfoGetters;
 
 private:
 
+	/// <summary>
+	/// Clears all the layers of the testing area terrain so nothing that somehow settled lingers between edited object changes and testing phases.
+	/// </summary>
+	void ClearTestArea() const;
+
 
 //////////////////////////////////////////////////////////////////////////////////////////
 // Method:          Clear

Activities/SceneEditor.cpp

@@ -24,6 +24,7 @@
 #include "HeldDevice.h"
 #include "Scene.h"
 #include "DataModule.h"
+#include "SLBackground.h"
 
 #include "GUI.h"
 #include "GUIFont.h"
@@ -417,22 +418,22 @@ void SceneEditor::Update()
                     pItem = m_pNewBG1Combo->GetItem(m_pNewBG1Combo->GetSelectedIndex());
                     if (pItem && !pItem->m_Name.empty())
                     {
-                        SceneLayer *pNewLayer = dynamic_cast<SceneLayer *>(g_PresetMan.GetEntityPreset("SceneLayer", pItem->m_Name, m_ModuleSpaceID)->Clone());
-                        RTEAssert(pNewLayer, "No SceneLayer of the name set as BG1 is defined!");
+						SLBackground *pNewLayer = dynamic_cast<SLBackground *>(g_PresetMan.GetEntityPreset("SLBackground", pItem->m_Name, m_ModuleSpaceID)->Clone());
+                        RTEAssert(pNewLayer, "No SLBackground of the name set as BG1 is defined!");
                         pNewScene->GetBackLayers().push_back(pNewLayer);
                     }
                     pItem = m_pNewBG2Combo->GetItem(m_pNewBG2Combo->GetSelectedIndex());
                     if (pItem && !pItem->m_Name.empty())
                     {
-                        SceneLayer *pNewLayer = dynamic_cast<SceneLayer *>(g_PresetMan.GetEntityPreset("SceneLayer", pItem->m_Name, m_ModuleSpaceID)->Clone());
-                        RTEAssert(pNewLayer, "No SceneLayer of the name set as BG2 is defined!");
+						SLBackground *pNewLayer = dynamic_cast<SLBackground *>(g_PresetMan.GetEntityPreset("SLBackground", pItem->m_Name, m_ModuleSpaceID)->Clone());
+                        RTEAssert(pNewLayer, "No SLBackground of the name set as BG2 is defined!");
                         pNewScene->GetBackLayers().push_back(pNewLayer);
                     }
                     pItem = m_pNewBG3Combo->GetItem(m_pNewBG3Combo->GetSelectedIndex());
                     if (pItem && !pItem->m_Name.empty())
                     {
-                        SceneLayer *pNewLayer = dynamic_cast<SceneLayer *>(g_PresetMan.GetEntityPreset("SceneLayer", pItem->m_Name, m_ModuleSpaceID)->Clone());
-                        RTEAssert(pNewLayer, "No SceneLayer of the name set as BG3 is defined!");
+						SLBackground *pNewLayer = dynamic_cast<SLBackground *>(g_PresetMan.GetEntityPreset("SLBackground", pItem->m_Name, m_ModuleSpaceID)->Clone());
+                        RTEAssert(pNewLayer, "No SLBackground of the name set as BG3 is defined!");
                         pNewScene->GetBackLayers().push_back(pNewLayer);
                     }
 
@@ -795,21 +796,21 @@ void SceneEditor::UpdateNewDialog()
 
     // Get the list of all read in NEAR background layers
     list<Entity *> bgList;
-    g_PresetMan.GetAllOfGroupInModuleSpace(bgList, "Near Backdrops", "SceneLayer", selectedModuleID);
+    g_PresetMan.GetAllOfGroupInModuleSpace(bgList, "Near Backdrops", "SLBackground", selectedModuleID);
     // Go through the list and add their names to the combo box
     for (list<Entity *>::iterator itr = bgList.begin(); itr != bgList.end(); ++itr)
         m_pNewBG1Combo->AddItem((*itr)->GetPresetName());
 
     // Get the list of all read in MID background layers
     bgList.clear();
-    g_PresetMan.GetAllOfGroupInModuleSpace(bgList, "Mid Backdrops", "SceneLayer", selectedModuleID);
+    g_PresetMan.GetAllOfGroupInModuleSpace(bgList, "Mid Backdrops", "SLBackground", selectedModuleID);
     // Go through the list and add their names to the combo box
     for (list<Entity *>::iterator itr = bgList.begin(); itr != bgList.end(); ++itr)
         m_pNewBG2Combo->AddItem((*itr)->GetPresetName());
 
     // Get the list of all read in FAR background layers
     bgList.clear();
-    g_PresetMan.GetAllOfGroupInModuleSpace(bgList, "Far Backdrops", "SceneLayer", selectedModuleID);
+    g_PresetMan.GetAllOfGroupInModuleSpace(bgList, "Far Backdrops", "SLBackground", selectedModuleID);
     // Go through the list and add their names to the combo box
     for (list<Entity *>::iterator itr = bgList.begin(); itr != bgList.end(); ++itr)
         m_pNewBG3Combo->AddItem((*itr)->GetPresetName());

CHANGELOG.md

@@ -8,24 +8,121 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 <details><summary><b>Added</b></summary>
 
-- New `DataModule` INI property `SupportedGameVersion` to define what version of the game a mod supports. This must be specified, and must match the current game version, in order for the mod to load succesfully.
+- New `DataModule` INI property `SupportedGameVersion` to define what version of the game a mod supports. This must be specified, and must match the current game version, in order for the mod to load successfully.
 
-- New `Actor` INI properties `Organic = 0/1` and `Robotic = 0/1` and supporting Lua functions `Actor:IsOrganic()` and `Actor:IsRobotic()`. These have no direct gameplay effect (and default to false), but will be very useful for inter-mod compatibility, as they allow scripts to know if an `Actor` is organic or robotic, and treat them accordingly.
+- New `Actor` INI properties `Organic = 0/1` and `Robotic = 0/1` and supporting Lua functions `Actor:IsOrganic()` and `Actor:IsRobotic()`.  
+	These have no direct gameplay effect (and default to false), but will be very useful for inter-mod compatibility, as they allow scripts to know if an `Actor` is organic or robotic, and treat them accordingly.
 
 - New INI and Lua (R/W) `ACDropShip` property `HoverHeightModifier`. This allows for modification of the height at which an `ACDropShip` will hover when unloading cargo, or staying at a location.
 
+- New `Scene` Lua property `BackgroundLayers` (R/O) to access an iterator of the `Scene`'s `SLBackground` layers.
+
+- `SLBackground` layers can now be animated using the same INI and Lua animation controls as everything else (`FrameCount`, `SpriteAnimMode`, etc). ([Issue #66](https://github.com/cortex-command-community/Cortex-Command-Community-Project-Source/issues/66))  
+	The collection of the `Scene`'s background layers can be accessed via `scene.BackgroundLayers`.
+
+- Added `SLBackground` auto-scrolling INI and Lua controls. ([Issue #66](https://github.com/cortex-command-community/Cortex-Command-Community-Project-Source/issues/66))  
+	The INI definition looks like this:  
+	```
+	CanAutoScrollX = 0/1 // Whether this can auto-scroll on the X axis. Scrolling will take effect only when combined with WrapX = 1, otherwise ignored.
+	CanAutoScrollY = 0/1 // Whether this can auto-scroll on the Y axis. Scrolling will take effect only when combined with WrapY = 1, otherwise ignored.
+
+	AutoScrollStepInterval = intValue // The duration between auto-scrolling steps on both axis, in milliseconds.
+
+	AutoScrollStep = Vector
+		X = intValue // The number of pixels to progress the scrolling on the X axis each step. Float values are supported but may end up choppy and inconsistent due to internal rounding and lack of sub-pixel precision.
+		Y = intValue // The number of pixels to progress the scrolling on the Y axis each step. Float values are supported but may end up choppy and inconsistent due to internal rounding and lack of sub-pixel precision.
+	```
+	You can read and write the following Lua properties:  
+	```
+	slBackground.CanAutoScrollX = bool -- this may be true even if X axis scrolling is not in effect due to WrapX = 0.
+	slBackground.CanAutoScrollY = bool -- this may be true even if Y axis scrolling is not in effect due to WrapY = 0.
+	slBackground.AutoScrollInterval = intValue
+	slBackground.AutoScrollStep = vector
+	slBackground.AutoScrollStepX = intValue
+	slBackground.AutoScrollStepY = intValue
+	```
+	`slBackground:IsAutoScrolling()` - (R/O) returns whether auto-scrolling is actually in effect on either axis (meaning either `WrapX` and `CanAutoScrollX` or `WrapY` and `CanAutoScrollY` are true).
+
+	The collection of the `Scene`'s background layers can be accessed via `scene.BackgroundLayers`.
+
+- New `Settings.ini` property `SceneBackgroundAutoScaleMode = 0/1/2`. ([Issue #243](https://github.com/cortex-command-community/Cortex-Command-Community-Project-Source/issues/243))  
+	Auto-scaling modes are: 0 = Off, 1 = Fit Screen, 2 = Always 2x.  
+	This will auto-scale all `Scene` background layers to cover the whole screen vertically in cases where the layer's sprite is too short and creates a gap at the bottom.  
+	In cases where a layer is short by design, auto-scaling behavior can be disabled on a per-layer basis using the `SLBackground` INI property `IgnoreAutoScaling`, otherwise it may be excessively scaled up to 2x (maximum).  
+	Note that any `ScaleFactor` definitions in layers that aren't set to ignore auto-scaling will be overridden.  
+
+	Only relevant when playing on un-scaled vertical resolutions of 640p and above as most background layer sprites are currently around 580px tall, and comes with a minor performance impact.  
+	Note that in fit screen mode each layer is scaled individually so some layers may be scaled more than others, or not scaled at all.  
+	In always 2x mode all layers will be equally scaled to 2x.
+
+- New `SLBackground` INI property `IgnoreAutoScaling = 0/1` to ignore the global background layer auto-scaling setting and use the `ScaleFactor` defined in the preset, if any.
+
+- New `SLBackground` INI property `OriginPointOffset` to offset the layer from the top left corner of the screen.
+
+- Added new `TerrainDebris` scattering functionality. ([Issue #152](https://github.com/cortex-command-community/Cortex-Command-Community-Project-Source/issues/152))  
+	New INI properties are:  
+	```
+	MinRotation/MaxRotation = angleDegrees // Rotates each debris piece to a random angle within the specified values. Values in degrees, negative values are counter-clockwise.  
+
+	FlipChance = floatValue // Chance for a debris piece to be flipped when either `CanHFlip` or `CanYFlip` are set true. 0-1, defaults to 0.5.  
+
+	CanHFlip/CanVFlip = 0/1 // Flips each debris piece on the X, Y or both axis.
+	```
+
+- Added support for `Material` background textures with INI property `BGTextureFile`.
+
 </details>
 
 <details><summary><b>Changed</b></summary>
 
 - Completely replaced `ScriptFile` with `ScriptPath`.
 
+- `Scene` background layer presets in INI are now defined as `SLBackground` rather than `SceneLayer`.
+
+- `TerrainDebris` INI property `OnlyOnSurface = 0/1` replaced with `DebrisPlacementMode = 0-6`.  
+	Placement modes are:  
+	```
+	0 (NoPlacementRestrictions) // Debris will be placed anywhere where there is target material (currently not strictly enforced when being offset by min/max depth, so can end up being placed mid-air/cavity unless set to OnlyBuried = 1).
+
+	1 (OnSurfaceOnly) // Debris will be placed only on the surface (scanning from top to bottom) where no background cavity material (material index 1) was encountered before the target material.
+
+	2 (OnCavitySurfaceOnly) // Debris will be placed only on the surface (scanning from top to bottom) where background cavity material (material index 1) was encountered before the target material.
+
+	3 (OnSurfaceAndCavitySurface) // Debris will be placed only on the surface (scanning from top to bottom) regardless whether background cavity material (material index 1) was encountered before the target material.
+
+	4 (OnOverhangOnly) // Debris will be placed only on overhangs (scanning from bottom to top) where no background cavity material (material index 1) was encountered before the target material.
+
+	5 (OnCavityOverhangOnly) // Debris will be placed only on overhangs (scanning from bottom to top) where background cavity material (material index 1) was encountered before the target material.
+
+	6 (OnOverhangAndCavityOverhang) // Debris will be placed only on overhangs (scanning from bottom to top) regardless whether background cavity material (material index 1) was encountered before the target material.
+	```
+
+- `Material` INI property `TextureFile` renamed to `FGTextureFile` to accommodate new background texture property.
+
+- `TerrainObject`s no longer have a hard requirement for `FG` and `Mat` layer sprites. Any layer may be omitted as long as at least one is defined.
+
+- `Scene` layer data will now be saved as compressed PNG to reduce file sizes of MetaGame saves and is threaded to prevent the game from freezing when layer data is being saved. 
+
 </details>
 
 <details><summary><b>Fixed</b></summary>
+
+- Fixed material view not drawing correctly when viewed in split-screen. ([Issue #54](https://github.com/cortex-command-community/Cortex-Command-Community-Project-Source/issues/54))
+
+- Fix `TerrainObject`s not wrapping when placed over the Y seam on Y-wrapped scenes.
+
 </details>
 
 <details><summary><b>Removed</b></summary>
+
+- Removed `SLTerrain` and `SLBackground` INI property `Offset`. Internal and shouldn't have been exposed.
+
+- Removed `SLTerrain` INI alt property `AddTerrainObject`. Use `PlaceTerrainObject` for consistency with similar properties.
+
+- Removed `TerrainObject` INI property `DisplayAsTerrain`. Wasn't implemented and did nothing.
+
+- Removed `SceneMan` Lua function `AddTerrainObject`. `SceneMan:AddSceneObject` should be used instead.
+
 </details>
 
 ***