#include <W3DTerrainVisual.h>

Inherits TerrainVisual.

Public Member Functions
	W3DTerrainVisual ()

virtual	~W3DTerrainVisual ()

virtual void	init (void)

virtual void	reset (void)

virtual void	update (void)

virtual Bool	load (AsciiString filename)

void	getTerrainColorAt (Real x, Real y, RGBColor *pColor)
	get color of texture on the terrain at location specified

TerrainType *	getTerrainTile (Real x, Real y)
	get the terrain tile type at the world location in the (x,y) plane ignoring Z

virtual Bool	intersectTerrain (Coord3D rayStart, Coord3D rayEnd, Coord3D *result)

virtual void	enableWaterGrid (Bool enable)
	enable/disable the water grid

virtual void	setWaterGridHeightClamps (const WaterHandle *waterTable, Real minZ, Real maxZ)
	set min/max height values allowed in water grid pointed to by waterTable

virtual void	setWaterAttenuationFactors (const WaterHandle *waterTable, Real a, Real b, Real c, Real range)
	adjust fallof parameters for grid change method

virtual void	setWaterTransform (const WaterHandle *waterTable, Real angle, Real x, Real y, Real z)
	set the water table position and orientation in world space

virtual void	setWaterTransform (const Matrix3D *transform)

virtual void	getWaterTransform (const WaterHandle waterTable, Matrix3D transform)

virtual void	setWaterGridResolution (const WaterHandle *waterTable, Real gridCellsX, Real gridCellsY, Real cellSize)
	water grid resolution spacing

virtual void	getWaterGridResolution (const WaterHandle waterTable, Real gridCellsX, Real gridCellsY, Real cellSize)

virtual void	changeWaterHeight (Real x, Real y, Real delta)
	adjust the water grid in world coords by the delta

virtual void	addWaterVelocity (Real worldX, Real worldY, Real velocity, Real preferredHeight)
	adjust the velocity at a water grid point corresponding to the world x,y

virtual Bool	getWaterGridHeight (Real worldX, Real worldY, Real *height)
	get height of water grid at specified position

virtual void	setTerrainTracksDetail (void)
	set detail of terrain tracks.

virtual void	setShoreLineDetail (void)

void	addFactionBib (Object *factionBuilding, Bool highlight, Real extra=0)
	Add a bib at location.

void	removeFactionBib (Object *factionBuilding)
	Remove a bib.

void	addFactionBibDrawable (Drawable *factionBuilding, Bool highlight, Real extra=0)
	Add a bib at location.

void	removeFactionBibDrawable (Drawable *factionBuilding)
	Remove a bib.

virtual void	removeAllBibs (void)

virtual void	removeBibHighlighting (void)

virtual void	addProp (const ThingTemplate tt, const Coord3D pos, Real angle)

virtual void	removeTreesAndPropsForConstruction (const Coord3D *pos, const GeometryInfo &geom, Real angle)

virtual void	setRawMapHeight (const ICoord2D *gridPos, Int height)

virtual Int	getRawMapHeight (const ICoord2D *gridPos)

virtual void	replaceSkyboxTextures (const AsciiString oldTexName[NumSkyboxTextures], const AsciiString newTexName[NumSkyboxTextures])
	Replace the skybox texture.

WorldHeightMap *	getLogicHeightMap (void)

WorldHeightMap *	getClientHeightMap (void)

Public Member Functions inherited from TerrainVisual
	TerrainVisual ()

virtual	~TerrainVisual ()

Public Member Functions inherited from Snapshot
	Snapshot (void)

	~Snapshot (void)

Public Member Functions inherited from SubsystemInterface
	SubsystemInterface ()

virtual	~SubsystemInterface ()

virtual void	postProcessLoad ()

virtual void	draw (void)

void	UPDATE (void)

void	DRAW (void)

AsciiString	getName (void)

void	setName (AsciiString name)

Protected Member Functions
virtual void	crc (Xfer *xfer)

virtual void	xfer (Xfer *xfer)

virtual void	loadPostProcess (void)

Protected Attributes
BaseHeightMapRenderObjClass *	m_terrainRenderObject
	W3D render object for terrain.

WaterRenderObjClass *	m_waterRenderObject
	W3D render object for water plane.

WorldHeightMap *	m_logicHeightMap
	height map used for render obj building

Bool	m_isWaterGridRenderingEnabled

AsciiString	m_currentSkyboxTexNames [NumSkyboxTextures]
	store current texture names applied to skybox.

AsciiString	m_initialSkyboxTexNames [NumSkyboxTextures]
	store starting texture/default skybox textures.

Protected Attributes inherited from TerrainVisual
AsciiString	m_filenameString
	file with terrain data

Protected Attributes inherited from SubsystemInterface
AsciiString	m_name

Additional Inherited Members
Public Types inherited from TerrainVisual
enum	{ NumSkyboxTextures = 5 }

Detailed Description

W3D impelmentation of visual terrain details singleton

Definition at line 53 of file W3DTerrainVisual.h.

Constructor & Destructor Documentation

◆ W3DTerrainVisual()

W3DTerrainVisual::W3DTerrainVisual ( )

Definition at line 161 of file W3DTerrainVisual.cpp.

◆ ~W3DTerrainVisual()

W3DTerrainVisual::~W3DTerrainVisual ( )

virtual

Definition at line 188 of file W3DTerrainVisual.cpp.

Member Function Documentation

◆ addFactionBib()

void W3DTerrainVisual::addFactionBib	(	Object *	factionBuilding,
		Bool	highlight,
		Real	extra = 0 )

virtual

Add a bib at location.

Implements TerrainVisual.

Definition at line 1022 of file W3DTerrainVisual.cpp.

◆ addFactionBibDrawable()

void W3DTerrainVisual::addFactionBibDrawable	(	Drawable *	factionBuilding,
		Bool	highlight,
		Real	extra = 0 )

virtual

Add a bib at location.

Implements TerrainVisual.

Definition at line 980 of file W3DTerrainVisual.cpp.

◆ addProp()

void W3DTerrainVisual::addProp	(	const ThingTemplate *	tt,
		const Coord3D *	pos,
		Real	angle )

virtual

Implements TerrainVisual.

Definition at line 1111 of file W3DTerrainVisual.cpp.

◆ addWaterVelocity()

void W3DTerrainVisual::addWaterVelocity	(	Real	worldX,
		Real	worldY,
		Real	velocity,
		Real	preferredHeight )

virtual

adjust the velocity at a water grid point corresponding to the world x,y

Implements TerrainVisual.

Definition at line 907 of file W3DTerrainVisual.cpp.

◆ changeWaterHeight()

void W3DTerrainVisual::changeWaterHeight	(	Real	x,
		Real	y,
		Real	delta )

virtual

adjust the water grid in world coords by the delta

Implements TerrainVisual.

Definition at line 897 of file W3DTerrainVisual.cpp.

◆ crc()

void W3DTerrainVisual::crc ( Xfer * xfer )

protectedvirtual

CRC

Reimplemented from TerrainVisual.

Definition at line 1182 of file W3DTerrainVisual.cpp.

◆ enableWaterGrid()

void W3DTerrainVisual::enableWaterGrid ( Bool enable )

virtual

enable/disable the water grid

Implements TerrainVisual.

Definition at line 718 of file W3DTerrainVisual.cpp.

◆ getClientHeightMap()

WorldHeightMap * W3DTerrainVisual::getClientHeightMap ( void )

inlinevirtual

Reimplemented from TerrainVisual.

Definition at line 144 of file W3DTerrainVisual.h.

◆ getLogicHeightMap()

WorldHeightMap * W3DTerrainVisual::getLogicHeightMap ( void )

inlinevirtual

Reimplemented from TerrainVisual.

Definition at line 143 of file W3DTerrainVisual.h.

◆ getRawMapHeight()

Int W3DTerrainVisual::getRawMapHeight ( const ICoord2D * gridPos )

virtual

Implements TerrainVisual.

Definition at line 965 of file W3DTerrainVisual.cpp.

◆ getTerrainColorAt()

void W3DTerrainVisual::getTerrainColorAt	(	Real	x,
		Real	y,
		RGBColor *	pColor )

virtual

get color of texture on the terrain at location specified

Implements TerrainVisual.

Definition at line 771 of file W3DTerrainVisual.cpp.

◆ getTerrainTile()

TerrainType * W3DTerrainVisual::getTerrainTile	(	Real	x,
		Real	y )

virtual

get the terrain tile type at the world location in the (x,y) plane ignoring Z

Implements TerrainVisual.

Definition at line 786 of file W3DTerrainVisual.cpp.

◆ getWaterGridHeight()

Bool W3DTerrainVisual::getWaterGridHeight	(	Real	worldX,
		Real	worldY,
		Real *	height )

virtual

get height of water grid at specified position

Implements TerrainVisual.

Definition at line 918 of file W3DTerrainVisual.cpp.

◆ getWaterGridResolution()

void W3DTerrainVisual::getWaterGridResolution	(	const WaterHandle *	waterTable,
		Real *	gridCellsX,
		Real *	gridCellsY,
		Real *	cellSize )

virtual

get water grid resolution spacing

Implements TerrainVisual.

Definition at line 885 of file W3DTerrainVisual.cpp.

◆ getWaterTransform()

void W3DTerrainVisual::getWaterTransform	(	const WaterHandle *	waterTable,
		Matrix3D *	transform )

virtual

get the water transform matrix

Implements TerrainVisual.

Definition at line 862 of file W3DTerrainVisual.cpp.

◆ init()

void W3DTerrainVisual::init ( void )

virtual

init

Reimplemented from TerrainVisual.

Definition at line 234 of file W3DTerrainVisual.cpp.

◆ intersectTerrain()

Bool W3DTerrainVisual::intersectTerrain	(	Coord3D *	rayStart,
		Coord3D *	rayEnd,
		Coord3D *	result )

virtual

intersect the ray with the terrain, if a hit occurs TRUE is returned and the result point on the terrain is returned in "result"

Reimplemented from TerrainVisual.

Definition at line 734 of file W3DTerrainVisual.cpp.

◆ load()

Bool W3DTerrainVisual::load ( AsciiString filename )

virtual

load method for W3D visual terrain

Reimplemented from TerrainVisual.

Definition at line 550 of file W3DTerrainVisual.cpp.

◆ loadPostProcess()

void W3DTerrainVisual::loadPostProcess ( void )

protectedvirtual

Load post process

Reimplemented from TerrainVisual.

Definition at line 1303 of file W3DTerrainVisual.cpp.

◆ removeAllBibs()

void W3DTerrainVisual::removeAllBibs ( void )

virtual

Implements TerrainVisual.

Definition at line 1082 of file W3DTerrainVisual.cpp.

◆ removeBibHighlighting()

void W3DTerrainVisual::removeBibHighlighting ( void )

virtual

Implements TerrainVisual.

Definition at line 1091 of file W3DTerrainVisual.cpp.

◆ removeFactionBib()

void W3DTerrainVisual::removeFactionBib ( Object * factionBuilding )

virtual

Remove a bib.

Implements TerrainVisual.

Definition at line 1073 of file W3DTerrainVisual.cpp.

◆ removeFactionBibDrawable()

void W3DTerrainVisual::removeFactionBibDrawable ( Drawable * factionBuilding )

virtual

Remove a bib.

Implements TerrainVisual.

Definition at line 1064 of file W3DTerrainVisual.cpp.

◆ removeTreesAndPropsForConstruction()

void W3DTerrainVisual::removeTreesAndPropsForConstruction	(	const Coord3D *	pos,
		const GeometryInfo &	geom,
		Real	angle )

virtual

Implements TerrainVisual.

Definition at line 1100 of file W3DTerrainVisual.cpp.

◆ replaceSkyboxTextures()

void W3DTerrainVisual::replaceSkyboxTextures	(	const AsciiString *	oldTexName[NumSkyboxTextures],
		const AsciiString *	newTexName[NumSkyboxTextures] )

virtual

Replace the skybox texture.

Implements TerrainVisual.

Definition at line 1159 of file W3DTerrainVisual.cpp.

◆ reset()

void W3DTerrainVisual::reset ( void )

virtual

reset

Reimplemented from TerrainVisual.

Definition at line 313 of file W3DTerrainVisual.cpp.

◆ setRawMapHeight()

void W3DTerrainVisual::setRawMapHeight	(	const ICoord2D *	gridPos,
		Int	height )

virtual

Implements TerrainVisual.

Definition at line 933 of file W3DTerrainVisual.cpp.

◆ setShoreLineDetail()

void W3DTerrainVisual::setShoreLineDetail ( void )

virtual

Implements TerrainVisual.

Definition at line 1150 of file W3DTerrainVisual.cpp.

◆ setTerrainTracksDetail()

void W3DTerrainVisual::setTerrainTracksDetail ( void )

virtual

set detail of terrain tracks.

Implements TerrainVisual.

Definition at line 1142 of file W3DTerrainVisual.cpp.

◆ setWaterAttenuationFactors()

void W3DTerrainVisual::setWaterAttenuationFactors	(	const WaterHandle *	waterTable,
		Real	a,
		Real	b,
		Real	c,
		Real	range )

virtual

adjust fallof parameters for grid change method

Implements TerrainVisual.

Definition at line 827 of file W3DTerrainVisual.cpp.

◆ setWaterGridHeightClamps()

void W3DTerrainVisual::setWaterGridHeightClamps	(	const WaterHandle *	waterTable,
		Real	minZ,
		Real	maxZ )

virtual

set min/max height values allowed in water grid pointed to by waterTable

Implements TerrainVisual.

Definition at line 815 of file W3DTerrainVisual.cpp.

◆ setWaterGridResolution()

void W3DTerrainVisual::setWaterGridResolution	(	const WaterHandle *	waterTable,
		Real	gridCellsX,
		Real	gridCellsY,
		Real	cellSize )

virtual

water grid resolution spacing

Implements TerrainVisual.

Definition at line 873 of file W3DTerrainVisual.cpp.

◆ setWaterTransform() [1/2]

void W3DTerrainVisual::setWaterTransform ( const Matrix3D * transform )

virtual

set water table transform by matrix

Implements TerrainVisual.

Definition at line 851 of file W3DTerrainVisual.cpp.

◆ setWaterTransform() [2/2]

void W3DTerrainVisual::setWaterTransform	(	const WaterHandle *	waterTable,
		Real	angle,
		Real	x,
		Real	y,
		Real	z )

virtual

set the water table position and orientation in world space

Implements TerrainVisual.

Definition at line 839 of file W3DTerrainVisual.cpp.

◆ update()

void W3DTerrainVisual::update ( void )

virtual

update

Reimplemented from TerrainVisual.

Definition at line 355 of file W3DTerrainVisual.cpp.

◆ xfer()

void W3DTerrainVisual::xfer ( Xfer * xfer )

protectedvirtual

Xfer Version Info: 1: Initial version 2: Add height map heights. 3: Add client side trees & props. jba.

Reimplemented from TerrainVisual.

Definition at line 1198 of file W3DTerrainVisual.cpp.

Member Data Documentation

◆ m_currentSkyboxTexNames

AsciiString W3DTerrainVisual::m_currentSkyboxTexNames[NumSkyboxTextures]

protected

store current texture names applied to skybox.

Definition at line 194 of file W3DTerrainVisual.h.

◆ m_initialSkyboxTexNames

AsciiString W3DTerrainVisual::m_initialSkyboxTexNames[NumSkyboxTextures]

protected

store starting texture/default skybox textures.

Definition at line 195 of file W3DTerrainVisual.h.

◆ m_isWaterGridRenderingEnabled

Bool W3DTerrainVisual::m_isWaterGridRenderingEnabled

protected

Definition at line 192 of file W3DTerrainVisual.h.

◆ m_logicHeightMap

WorldHeightMap* W3DTerrainVisual::m_logicHeightMap

protected

height map used for render obj building

Definition at line 186 of file W3DTerrainVisual.h.

◆ m_terrainRenderObject

BaseHeightMapRenderObjClass* W3DTerrainVisual::m_terrainRenderObject

protected

W3D render object for terrain.

Definition at line 183 of file W3DTerrainVisual.h.

◆ m_waterRenderObject

WaterRenderObjClass* W3DTerrainVisual::m_waterRenderObject

protected

W3D render object for water plane.

Definition at line 184 of file W3DTerrainVisual.h.

The documentation for this class was generated from the following files:

Code/GameEngineDevice/Include/W3DDevice/GameClient/W3DTerrainVisual.h
Code/GameEngineDevice/Source/W3DDevice/GameClient/W3DTerrainVisual.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ W3DTerrainVisual()

◆ ~W3DTerrainVisual()

Member Function Documentation

◆ addFactionBib()

◆ addFactionBibDrawable()

◆ addProp()

◆ addWaterVelocity()

◆ changeWaterHeight()

◆ crc()

◆ enableWaterGrid()

◆ getClientHeightMap()

◆ getLogicHeightMap()

◆ getRawMapHeight()

◆ getTerrainColorAt()

◆ getTerrainTile()

◆ getWaterGridHeight()

◆ getWaterGridResolution()

◆ getWaterTransform()

◆ init()

◆ intersectTerrain()

◆ load()

◆ loadPostProcess()

◆ removeAllBibs()

◆ removeBibHighlighting()

◆ removeFactionBib()

◆ removeFactionBibDrawable()

◆ removeTreesAndPropsForConstruction()

◆ replaceSkyboxTextures()

◆ reset()

◆ setRawMapHeight()

◆ setShoreLineDetail()

◆ setTerrainTracksDetail()

◆ setWaterAttenuationFactors()

◆ setWaterGridHeightClamps()

◆ setWaterGridResolution()

◆ setWaterTransform() [1/2]

◆ setWaterTransform() [2/2]

◆ update()

◆ xfer()

Member Data Documentation

◆ m_currentSkyboxTexNames

◆ m_initialSkyboxTexNames

◆ m_isWaterGridRenderingEnabled

◆ m_logicHeightMap

◆ m_terrainRenderObject

◆ m_waterRenderObject