chore(heightmap): Implement HeightMapRenderObjClass::setTerrainDrawSize() to set custom draw sizes (#2677)

Author: xezon

Core/GameEngineDevice/Include/W3DDevice/GameClient/BaseHeightMap.h

@@ -123,7 +123,8 @@ class BaseHeightMapRenderObjClass : public RenderObjClass, public DX8_CleanupHoo
  	virtual void adjustTerrainLOD(Int adj);
 	virtual void doPartialUpdate(const IRegion2D &partialRange, WorldHeightMap *htMap, RefRenderObjListIterator *pLightsIterator) = 0;
 	virtual void staticLightingChanged();
-	virtual void oversizeTerrain(Int tilesToOversize);
+	virtual void oversizeTerrain(Int tilesToOversize) = 0; ///< Oversize the visible terrain area.
+	virtual void setTerrainDrawSize(Int width, Int height) = 0; ///< Resize the visible terrain area. Always defaults to oversize dimensions when oversize is set.
 	virtual void reset();
 
   void redirectToHeightmap( WorldHeightMap *pMap )

Core/GameEngineDevice/Include/W3DDevice/GameClient/FlatHeightMap.h

@@ -69,7 +69,8 @@ class FlatHeightMapRenderObjClass : public BaseHeightMapRenderObjClass
 	virtual void updateCenter(CameraClass *camera, RefRenderObjListIterator *pLightsIterator) override;
  	virtual void adjustTerrainLOD(Int adj) override;
 	virtual void reset() override;
-	virtual void oversizeTerrain(Int tilesToOversize) override;
+	virtual void oversizeTerrain(Int tilesToOversize) override; ///< Oversize the visible terrain area.
+	virtual void setTerrainDrawSize(Int width, Int height) override; ///< Resize the visible terrain area. Always defaults to oversize dimensions when oversize is set.
 	virtual void staticLightingChanged() override;
 	virtual void doPartialUpdate(const IRegion2D &partialRange, WorldHeightMap *htMap, RefRenderObjListIterator *pLightsIterator) override;
   virtual int updateBlock(Int x0, Int y0, Int x1, Int y1, WorldHeightMap *pMap, RefRenderObjListIterator *pLightsIterator) override {return 0;};

Core/GameEngineDevice/Include/W3DDevice/GameClient/HeightMap.h

@@ -80,7 +80,8 @@ class HeightMapRenderObjClass : public BaseHeightMapRenderObjClass
 	virtual void reset() override;
 	virtual void doPartialUpdate(const IRegion2D &partialRange, WorldHeightMap *htMap, RefRenderObjListIterator *pLightsIterator) override;
 
-	virtual void oversizeTerrain(Int tilesToOversize) override;
+	virtual void oversizeTerrain(Int tilesToOversize) override; ///< Oversize the visible terrain area.
+	virtual void setTerrainDrawSize(Int width, Int height) override; ///< Resize the visible terrain area. Always defaults to oversize dimensions when oversize is set.
 
 	virtual int updateBlock(Int x0, Int y0, Int x1, Int y1, WorldHeightMap *pMap, RefRenderObjListIterator *pLightsIterator) override;
 
@@ -93,6 +94,8 @@ class HeightMapRenderObjClass : public BaseHeightMapRenderObjClass
 	VERTEX_FORMAT *m_vertexBufferBackup; ///< In memory copy of the vertex buffer data for quick update of dynamic lighting.
 	Int m_originX; ///<  Origin point in the grid.  Slides around.
 	Int m_originY; ///< Origin point in the grid.  Slides around.
+	Int m_oversizeDrawWidth; // Oversize draw width required by mission scripts for cinematic sequences.
+	Int m_oversizeDrawHeight; // Oversize draw height required by mission scripts for cinematic sequences.
 	DX8IndexBufferClass			*m_indexBuffer;	///<indices defining triangles in a VB tile.
 	Int	m_numVBTilesX;	///<dimensions of array containing all the vertex buffers
 	Int	m_numVBTilesY;	///<dimensions of array containing all the vertex buffers

Core/GameEngineDevice/Include/W3DDevice/GameClient/WorldHeightMap.h

@@ -250,8 +250,8 @@ class WorldHeightMap : public RefCountClass,
 
 	Int getDrawWidth() {return m_drawWidthX;}
 	Int getDrawHeight() {return m_drawHeightY;}
-	void setDrawWidth(Int width) {m_drawWidthX = width; if (m_drawWidthX>m_width) m_drawWidthX = m_width;}
-	void setDrawHeight(Int height) {m_drawHeightY = height; if (m_drawHeightY>m_height) m_drawHeightY = m_height;}
+	void setDrawWidth(Int width) {DEBUG_ASSERTCRASH(width <= m_width, ("Draw width must not exceed map width")); m_drawWidthX = width;}
+	void setDrawHeight(Int height) {DEBUG_ASSERTCRASH(height <= m_height, ("Draw height must not exceed map height")); m_drawHeightY = height;}
 	virtual Int getBorderSize() override {return m_borderSize;}
   Int getBorderSizeInline() const { return m_borderSize; }
 	/// Get height with the offset that HeightMapRenderObjClass uses built in.

Core/GameEngineDevice/Source/W3DDevice/GameClient/FlatHeightMap.cpp

@@ -243,7 +243,10 @@ void FlatHeightMapRenderObjClass::oversizeTerrain(Int tilesToOversize)
 	// Not needed with flat version. [3/20/2003]
 }
 
-
+void FlatHeightMapRenderObjClass::setTerrainDrawSize(Int width, Int height)
+{
+	// Not needed with flat version.
+}
 
 //=============================================================================
 // HeightMapRenderObjClass::doPartialUpdate

Core/GameEngineDevice/Source/W3DDevice/GameClient/HeightMap.cpp

@@ -1048,6 +1048,8 @@ m_vertexBufferTiles(nullptr),
 m_vertexBufferBackup(nullptr),
 m_originX(0),
 m_originY(0),
+m_oversizeDrawWidth(0),
+m_oversizeDrawHeight(0),
 m_indexBuffer(nullptr),
 m_numVBTilesX(0),
 m_numVBTilesY(0),
@@ -1161,6 +1163,8 @@ void HeightMapRenderObjClass::ReAcquireResources()
 void HeightMapRenderObjClass::reset()
 {
 	BaseHeightMapRenderObjClass::reset();
+	m_oversizeDrawWidth = 0;
+	m_oversizeDrawHeight = 0;
 }
 
 //=============================================================================
@@ -1170,17 +1174,42 @@ void HeightMapRenderObjClass::reset()
 //=============================================================================
 void HeightMapRenderObjClass::oversizeTerrain(Int tilesToOversize)
 {
-	Int width = WorldHeightMap::NORMAL_DRAW_WIDTH;
-	Int height = WorldHeightMap::NORMAL_DRAW_HEIGHT;
-	if (tilesToOversize>0 && tilesToOversize<5)
+	if (tilesToOversize>0)
 	{
-		width += VERTEX_BUFFER_TILE_LENGTH * tilesToOversize;
-		height += VERTEX_BUFFER_TILE_LENGTH * tilesToOversize;
-		if (width>m_map->getXExtent())
-			width = m_map->getXExtent();
-		if (height>m_map->getYExtent())
-			height = m_map->getYExtent();
+		m_oversizeDrawWidth = WorldHeightMap::NORMAL_DRAW_WIDTH + VERTEX_BUFFER_TILE_LENGTH * tilesToOversize;
+		m_oversizeDrawHeight = WorldHeightMap::NORMAL_DRAW_HEIGHT + VERTEX_BUFFER_TILE_LENGTH * tilesToOversize;
+		m_oversizeDrawWidth = std::min(m_oversizeDrawWidth, m_map->getXExtent());
+		m_oversizeDrawHeight = std::min(m_oversizeDrawHeight, m_map->getYExtent());
+		setTerrainDrawSize(m_oversizeDrawWidth, m_oversizeDrawHeight);
 	}
+	else
+	{
+		m_oversizeDrawWidth = 0;
+		m_oversizeDrawHeight = 0;
+		Int width = std::min((Int)WorldHeightMap::NORMAL_DRAW_WIDTH, m_map->getXExtent());
+		Int height = std::min((Int)WorldHeightMap::NORMAL_DRAW_HEIGHT, m_map->getYExtent());
+		setTerrainDrawSize(width, height);
+	}
+}
+
+void HeightMapRenderObjClass::setTerrainDrawSize(Int width, Int height)
+{
+	if (m_map == nullptr)
+		return;
+
+	if (m_oversizeDrawWidth != 0)
+		width = m_oversizeDrawWidth;
+	else
+		width = std::min(width, m_map->getXExtent());
+
+	if (m_oversizeDrawHeight != 0)
+		height = m_oversizeDrawHeight;
+	else
+		height = std::min(height, m_map->getYExtent());
+
+	if (width == m_map->getDrawWidth() && height == m_map->getDrawHeight())
+		return;
+
 	Int dx = width-m_map->getDrawWidth();
 	Int dy = height-m_map->getDrawHeight();
 	m_map->setDrawWidth(width);

Generals/Code/Tools/WorldBuilder/src/wbview3d.cpp

@@ -1512,8 +1512,8 @@ void WbView3d::updateHeightMapInView(WorldHeightMap *htMap, Bool partial, const
 				htMap->setDrawHeight(htMap->getYExtent());
 				m_heightMapRenderObj->initHeightData(htMap->getXExtent(), htMap->getYExtent(), htMap, &lightListIt);
 			} else {
-				htMap->setDrawWidth(m_partialMapSize);
-				htMap->setDrawHeight(m_partialMapSize);
+				htMap->setDrawWidth(std::min(m_partialMapSize, htMap->getXExtent()));
+				htMap->setDrawHeight(std::min(m_partialMapSize, htMap->getYExtent()));
 				m_heightMapRenderObj->initHeightData(htMap->getDrawWidth(), htMap->getDrawHeight(), htMap, &lightListIt);
 			}
 			m_heightMapRenderObj->updateViewImpassableAreas();

GeneralsMD/Code/Tools/WorldBuilder/src/wbview3d.cpp

@@ -1593,8 +1593,8 @@ void WbView3d::updateHeightMapInView(WorldHeightMap *htMap, Bool partial, const
 				htMap->setDrawHeight(htMap->getYExtent());
 				m_heightMapRenderObj->initHeightData(htMap->getXExtent(), htMap->getYExtent(), htMap, &lightListIt);
 			} else {
-				htMap->setDrawWidth(m_partialMapSize);
-				htMap->setDrawHeight(m_partialMapSize);
+				htMap->setDrawWidth(std::min(m_partialMapSize, htMap->getXExtent()));
+				htMap->setDrawHeight(std::min(m_partialMapSize, htMap->getYExtent()));
 				m_heightMapRenderObj->initHeightData(htMap->getDrawWidth(), htMap->getDrawHeight(), htMap, &lightListIt);
 			}
 			m_heightMapRenderObj->updateViewImpassableAreas();