#include <TerrainVisual.h>

Inherits Snapshot, and SubsystemInterface.

Public Types
enum	{ NumSkyboxTextures = 5 }

Public Member Functions
	TerrainVisual ()

virtual	~TerrainVisual ()

virtual void	init (void)

virtual void	reset (void)

virtual void	update (void)

virtual Bool	load (AsciiString filename)

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

virtual TerrainType *	getTerrainTile (Real x, Real y)=0
	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)=0

virtual void	setWaterGridHeightClamps (const WaterHandle *waterTable, Real minZ, Real maxZ)=0
	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)=0
	adjust fallof parameters for grid change method

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

virtual void	setWaterTransform (const Matrix3D *transform)=0

virtual void	getWaterTransform (const WaterHandle waterTable, Matrix3D transform)=0
	get water transform parameters

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

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

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

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

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

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

virtual void	setShoreLineDetail (void)=0

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

virtual void	removeFactionBib (Object *factionBuilding)=0
	Remove a bib.

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

virtual void	removeFactionBibDrawable (Drawable *factionBuilding)=0
	Remove a bib.

virtual void	removeAllBibs (void)=0

virtual void	removeBibHighlighting (void)=0

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

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

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

virtual Int	getRawMapHeight (const ICoord2D *gridPos)=0

virtual WorldHeightMap *	getLogicHeightMap (void)

virtual WorldHeightMap *	getClientHeightMap (void)

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

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
AsciiString	m_filenameString
	file with terrain data

Protected Attributes inherited from SubsystemInterface
AsciiString	m_name

Detailed Description

Device independent implementation for visual terrain

Definition at line 210 of file TerrainVisual.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Enumerator
NumSkyboxTextures

Definition at line 216 of file TerrainVisual.h.

Constructor & Destructor Documentation

◆ TerrainVisual()

TerrainVisual::TerrainVisual ( )

Definition at line 52 of file TerrainVisual.cpp.

◆ ~TerrainVisual()

TerrainVisual::~TerrainVisual ( )

virtual

Definition at line 59 of file TerrainVisual.cpp.

Member Function Documentation

◆ addFactionBib()

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

pure virtual

Add a bib for an object at location.

Implemented in W3DTerrainVisual.

◆ addFactionBibDrawable()

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

pure virtual

Add a bib for a drawable at location.

Implemented in W3DTerrainVisual.

◆ addProp()

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

pure virtual

Implemented in W3DTerrainVisual.

◆ addWaterVelocity()

virtual void TerrainVisual::addWaterVelocity	(	Real	worldX,
		Real	worldY,
		Real	velocity,
		Real	preferredHeight )

pure virtual

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

Implemented in W3DTerrainVisual.

◆ changeWaterHeight()

virtual void TerrainVisual::changeWaterHeight	(	Real	x,
		Real	y,
		Real	delta )

pure virtual

adjust the water grid in world coords by the delta

Implemented in W3DTerrainVisual.

◆ crc()

void TerrainVisual::crc ( Xfer * xfer )

protectedvirtual

CRC

Implements Snapshot.

Reimplemented in W3DTerrainVisual.

Definition at line 109 of file TerrainVisual.cpp.

◆ enableWaterGrid()

virtual void TerrainVisual::enableWaterGrid ( Bool enable )

pure virtual

Implemented in W3DTerrainVisual.

◆ getClientHeightMap()

virtual WorldHeightMap * TerrainVisual::getClientHeightMap ( void )

inlinevirtual

Reimplemented in W3DTerrainVisual.

Definition at line 302 of file TerrainVisual.h.

◆ getLogicHeightMap()

virtual WorldHeightMap * TerrainVisual::getLogicHeightMap ( void )

inlinevirtual

Reimplemented in W3DTerrainVisual.

Definition at line 301 of file TerrainVisual.h.

◆ getRawMapHeight()

virtual Int TerrainVisual::getRawMapHeight ( const ICoord2D * gridPos )

pure virtual

Implemented in W3DTerrainVisual.

◆ getTerrainColorAt()

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

pure virtual

get color of texture on the terrain at location specified

Implemented in W3DTerrainVisual.

◆ getTerrainTile()

virtual TerrainType * TerrainVisual::getTerrainTile	(	Real	x,
		Real	y )

pure virtual

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

Implemented in W3DTerrainVisual.

◆ getWaterGridHeight()

virtual Bool TerrainVisual::getWaterGridHeight	(	Real	worldX,
		Real	worldY,
		Real *	height )

pure virtual

get height of water grid at specified position

Implemented in W3DTerrainVisual.

◆ getWaterGridResolution()

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

pure virtual

Implemented in W3DTerrainVisual.

◆ getWaterTransform()

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

pure virtual

get water transform parameters

Implemented in W3DTerrainVisual.

◆ init()

void TerrainVisual::init ( void )

virtual

initialize the device independent functionality of the visual terrain

Implements SubsystemInterface.

Reimplemented in W3DTerrainVisual.

Definition at line 67 of file TerrainVisual.cpp.

◆ intersectTerrain()

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

inlinevirtual

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 in W3DTerrainVisual.

Definition at line 235 of file TerrainVisual.h.

◆ load()

Bool TerrainVisual::load ( AsciiString filename )

virtual

device independent implementation for common terrain visual systems

Reimplemented in W3DTerrainVisual.

Definition at line 93 of file TerrainVisual.cpp.

◆ loadPostProcess()

void TerrainVisual::loadPostProcess ( void )

protectedvirtual

Load post process

Implements Snapshot.

Reimplemented in W3DTerrainVisual.

Definition at line 132 of file TerrainVisual.cpp.

◆ removeAllBibs()

virtual void TerrainVisual::removeAllBibs ( void )

pure virtual

Implemented in W3DTerrainVisual.

◆ removeBibHighlighting()

virtual void TerrainVisual::removeBibHighlighting ( void )

pure virtual

Implemented in W3DTerrainVisual.

◆ removeFactionBib()

virtual void TerrainVisual::removeFactionBib ( Object * factionBuilding )

pure virtual

Remove a bib.

Implemented in W3DTerrainVisual.

◆ removeFactionBibDrawable()

virtual void TerrainVisual::removeFactionBibDrawable ( Drawable * factionBuilding )

pure virtual

Remove a bib.

Implemented in W3DTerrainVisual.

◆ removeTreesAndPropsForConstruction()

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

pure virtual

Implemented in W3DTerrainVisual.

◆ replaceSkyboxTextures()

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

pure virtual

Replace the skybox texture.

Implemented in W3DTerrainVisual.

◆ reset()

void TerrainVisual::reset ( void )

virtual

Reset

Implements SubsystemInterface.

Reimplemented in W3DTerrainVisual.

Definition at line 75 of file TerrainVisual.cpp.

◆ setRawMapHeight()

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

pure virtual

Implemented in W3DTerrainVisual.

◆ setShoreLineDetail()

virtual void TerrainVisual::setShoreLineDetail ( void )

pure virtual

Implemented in W3DTerrainVisual.

◆ setTerrainTracksDetail()

virtual void TerrainVisual::setTerrainTracksDetail ( void )

pure virtual

set detail of terrain tracks.

Implemented in W3DTerrainVisual.

◆ setWaterAttenuationFactors()

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

pure virtual

adjust fallof parameters for grid change method

Implemented in W3DTerrainVisual.

◆ setWaterGridHeightClamps()

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

pure virtual

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

Implemented in W3DTerrainVisual.

◆ setWaterGridResolution()

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

pure virtual

water grid resolution spacing

Implemented in W3DTerrainVisual.

◆ setWaterTransform() [1/2]

virtual void TerrainVisual::setWaterTransform ( const Matrix3D * transform )

pure virtual

Implemented in W3DTerrainVisual.

◆ setWaterTransform() [2/2]

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

pure virtual

set the water table position and orientation in world space

Implemented in W3DTerrainVisual.

◆ update()

void TerrainVisual::update ( void )

virtual

Update

Implements SubsystemInterface.

Reimplemented in W3DTerrainVisual.

Definition at line 85 of file TerrainVisual.cpp.

◆ xfer()

void TerrainVisual::xfer ( Xfer * xfer )

protectedvirtual

Xfer Version Info: 1: Initial version

Implements Snapshot.

Reimplemented in W3DTerrainVisual.

Definition at line 119 of file TerrainVisual.cpp.

Member Data Documentation

◆ m_filenameString

AsciiString TerrainVisual::m_filenameString

protected

file with terrain data

Definition at line 319 of file TerrainVisual.h.

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

Code/GameEngine/Include/GameClient/TerrainVisual.h
Code/GameEngine/Source/GameClient/Terrain/TerrainVisual.cpp

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Enumeration Documentation

◆ anonymous enum

Constructor & Destructor Documentation

◆ TerrainVisual()

◆ ~TerrainVisual()

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_filenameString