The TerrainT class represents a terrain in a map. More...

#include "MapTerrain.hpp"

Inheritance diagram for MapTerrainT:

Public Member Functions
	MapTerrainT (const BoundingBox3fT &Box=BoundingBox3fT(Vector3fT()), const wxString &HeightMapFile="", EditorMaterialI *Material=NULL)
	Constructor. More...

	MapTerrainT (const MapTerrainT &Terrain)
	The copy constructor for copying a terrain. More...

MapTerrainT *	Clone () const override
	The virtual copy constructor. More...

void	SetTerrainBounds (const BoundingBox3fT &Bounds)
	Sets the bounds of the terrain. More...

void	SetMaterial (EditorMaterialI *Material)
	Sets the terrain material. More...

EditorMaterialI *	GetMaterial () const
	Gets the terrains current material. More...

unsigned long	GetResolution () const
	Gets the terrains heigth data resolution side length. More...

const ArrayT< unsigned short > &	GetHeightData () const
	Gets a constant reference to the terrains height data. More...

void	LoadHeightData (const wxString &FileName)
	Initializes the terrains height data from a file. More...

wxPoint	TraceRay (const Vector3fT &Source, const Vector3fT &Direction) const
	Traces the given ray and returns the position in the terrains height data when a hit with the terrain has occured. More...

void	SetToolBounds (int PosX, int PosY, int Radius)
	Sets the bounds if the terrain edit tool. More...

BoundingBox3fT	GetBB () const
	Returns the spatial bounding-box of this map element. More...

void	Render2D (Renderer2DT &Renderer) const

void	Render3D (Renderer3DT &Renderer) const

bool	TraceRay (const Vector3fT &RayOrigin, const Vector3fT &RayDir, float &Fraction, unsigned long &FaceNr) const
	Traces a ray against this map element, and returns whether it was hit. More...

bool	TracePixel (const wxPoint &Pixel, int Radius, const ViewWindow2DT &ViewWin) const
	This method determines if this map element is intersected/affected by the specified disc in ViewWin. More...

TrafoMementoT *	GetTrafoState () const override
	Returns a memento that encapsulates the transform-related state of this element. More...

void	RestoreTrafoState (const TrafoMementoT *TM) override
	Restores the transform-related state of this element from the given memento. More...

void	TrafoMove (const Vector3fT &Delta, bool LockTexCoords) override
	Translates this element by the given vector (in world-space). More...

void	TrafoRotate (const Vector3fT &RefPoint, const cf::math::AnglesfT &Angles, bool LockTexCoords) override
	Rotates this element about the given reference point (in world-space). More...

void	TrafoScale (const Vector3fT &RefPoint, const Vector3fT &Scale, bool LockTexCoords) override
	Scales this element about the given reference point (in world-space). More...

void	TrafoMirror (unsigned int NormalAxis, float Dist, bool LockTexCoords) override
	Mirrors this element along the given mirror plane (in world-space). More...

void	Transform (const Matrix4x4fT &Matrix, bool LockTexCoords) override
	Why does this method not replace all the other Trafo*() methods? This method is the most generic, allowing transformations that e.g. More...

wxString	GetDescription () const

void	Load_cmap (TextParserT &TP, MapDocumentT &MapDoc, bool IgnoreGroups) override

void	Save_cmap (std::ostream &OutFile, unsigned long TerrainNr, const MapDocumentT &MapDoc) const

virtual const cf::TypeSys::TypeInfoT *	GetType () const

Public Member Functions inherited from MapPrimitiveT
	MapPrimitiveT (const wxColour &Color)
	The default constructor. More...

	MapPrimitiveT (const MapPrimitiveT &Prim)
	The copy constructor for copying a primitive. More...

wxColour	GetColor (bool ConsiderGroup=true) const
	This method returns the "inherent" color of this map element. More...

Public Member Functions inherited from MapElementT
	MapElementT ()
	The default constructor. More...

	MapElementT (const MapElementT &Elem)
	The copy constructor for copying a map element. More...

virtual	~MapElementT ()
	The virtual destructor. More...

MapEditor::CompMapEntityT *	GetParent () const
	Returns the entity that this element is a part of, or `NULL` if the element has no parent entity. More...

void	SetParent (MapEditor::CompMapEntityT *Ent)
	Sets the parent entity that is element is a part of. More...

bool	IsSelected () const
	Returns whether this element is currently selected in the map document. More...

void	SetSelected (bool Selected=true)
	Sets the selection state of this element. More...

virtual bool	IsTranslucent () const
	Returns whether this map element is (entirely or partially) translucent. More...

GroupT *	GetGroup () const
	Returns NULL when this map element is in no group, or the pionter to the group it is a member of otherwise. More...

void	SetGroup (GroupT *Group)
	Sets the group this element is a member of (use NULL for "no group"). More...

bool	IsVisible () const
	Returns whether this map element is currently visible (in the 2D, 3D and other views). More...

bool	CanSelect () const
	Returns whether this map element can currently be selected (in the 2D, 3D and other views). More...

void	GetToggleEffects (ArrayT< MapElementT * > &RemoveFromSel, ArrayT< MapElementT * > &AddToSel, bool AutoGroupEntities)
	Computes how the selection must be changed in order to toggle the given element when the element's entity and group memberships are taken into account. More...

virtual void	AdvanceTime (float t)
	This is periodically called in order to have the element advance its internal clock by t seconds. More...

unsigned int	GetFrameCount () const

void	SetFrameCount (unsigned int FrameCount)

Static Public Member Functions
static void *	CreateInstance (const cf::TypeSys::CreateParamsT &Params)

Static Public Member Functions inherited from MapPrimitiveT
static void *	CreateInstance (const cf::TypeSys::CreateParamsT &Params)

Static Public Member Functions inherited from MapElementT
static void *	CreateInstance (const cf::TypeSys::CreateParamsT &Params)

Static Public Attributes
static const cf::TypeSys::TypeInfoT	TypeInfo

Static Public Attributes inherited from MapPrimitiveT
static const cf::TypeSys::TypeInfoT	TypeInfo

Static Public Attributes inherited from MapElementT
static const cf::TypeSys::TypeInfoT	TypeInfo

Friends
class	CommandModifyTerrainT

class	CommandChangeTerrainResT

class	ToolTerrainEditorT

Additional Inherited Members
Protected Attributes inherited from MapElementT
MapEditor::CompMapEntityT *	m_Parent
	The entity that this element is a part of. More...

bool	m_IsSelected
	Is this element currently selected in the map document? More...

GroupT *	m_Group
	The group this element is in, NULL if in no group. More...

unsigned int	m_FrameCount
	The number of the frame in which this element was last rendered in a 3D view, used in order to avoid processing/rendering it twice. More...

Detailed Description

The TerrainT class represents a terrain in a map.

A terrain consists of height data and a material that is used to render the terrain. The dimensions of the terrain are described by a bounding box and all tranformations are performed on this bounding box.

Constructor & Destructor Documentation

MapTerrainT::MapTerrainT	(	const BoundingBox3fT &	Box = `BoundingBox3fT(Vector3fT())`,
		const wxString &	HeightMapFile = `""`,
		EditorMaterialI *	Material = `NULL`
	)

Constructor.

If no parameters are passed, an even terrain with dummy material and no size is created at 0,0,0. It is possible to adjust all these parameters later on, so you can create an "empty" terrain here and fill it later.

Parameters

Box	The initial bounds of the terrain.
HeightMapFile	The heightmap data from which this terrain should be initialized.
Material	The material to render this terrain with.

MapTerrainT::MapTerrainT ( const MapTerrainT & Terrain )

The copy constructor for copying a terrain.

Parameters

Terrain The terrain to copy-construct this terrain from.

Member Function Documentation

MapTerrainT * MapTerrainT::Clone ( ) const

overridevirtual

The virtual copy constructor.

Creates a copy of this primitive that is of the same class as the original, even when called via a base class pointer (the caller doesn't need to know the exact derived class).

Implements MapPrimitiveT.

BoundingBox3fT MapTerrainT::GetBB ( ) const

virtual

Returns the spatial bounding-box of this map element.

Implements MapElementT.

const ArrayT<unsigned short>& MapTerrainT::GetHeightData ( ) const

inline

Gets a constant reference to the terrains height data.

Returns: The terrains height data.

EditorMaterialI* MapTerrainT::GetMaterial ( ) const

inline

Gets the terrains current material.

Returns: Current terrain material.

unsigned long MapTerrainT::GetResolution ( ) const

inline

Gets the terrains heigth data resolution side length.

Returns: Height data side length.

TrafoMementoT * MapTerrainT::GetTrafoState ( ) const

overridevirtual

Returns a memento that encapsulates the transform-related state of this element.

The method saves all state in the memento that calls to the Trafo*() methods can possibly modify.

Reimplemented from MapElementT.

void MapTerrainT::LoadHeightData ( const wxString & FileName )

Initializes the terrains height data from a file.

Warning: This will overwrite any data that the terrain currently has.

Parameters

FileName The file from which the height data should be loaded.

void MapTerrainT::RestoreTrafoState ( const TrafoMementoT * TM )

overridevirtual

Restores the transform-related state of this element from the given memento.

The method restores all state from the memento that calls to the Trafo*() methods have possibly modified.

Reimplemented from MapElementT.

void MapTerrainT::SetMaterial ( EditorMaterialI * Material )

inline

Sets the terrain material.

Parameters

Material New terrain material.

void MapTerrainT::SetTerrainBounds ( const BoundingBox3fT & Bounds )

Sets the bounds of the terrain.

Parameters

Bounds The new bounds of the terrain.

void MapTerrainT::SetToolBounds	(	int	PosX,
		int	PosY,
		int	Radius
	)

Sets the bounds if the terrain edit tool.

The tools bounds are calculated from the given parameters.

Parameters

PosX	The x position of the tool in the terrains height data.
PosY	The y position of the tool in the terrains height data.
Radius	The tools radius.

bool MapTerrainT::TracePixel	(	const wxPoint &	Pixel,
		int	Radius,
		const ViewWindow2DT &	ViewWin
	)		const

virtual

This method determines if this map element is intersected/affected by the specified disc in ViewWin.

The disc for the test is defined by the given center pixel and the given radius. For example, the caller can learn by the result of this method whether the map element should respond to a mouse-click at the same pixel. Therefore, this method can be considered as the 2D analogue of the TraceRay() method.

Reimplemented from MapElementT.

wxPoint MapTerrainT::TraceRay	(	const Vector3fT &	Source,
		const Vector3fT &	Direction
	)		const

Traces the given ray and returns the position in the terrains height data when a hit with the terrain has occured.

Parameters

Source	The point from were the trace is emanating.
Direction	The direction into which the ray is cast.

Returns: Point of intersection in the height map or -1,-1 if ray doesn't intersect with terrain.

bool MapTerrainT::TraceRay	(	const Vector3fT &	RayOrigin,
		const Vector3fT &	RayDir,
		float &	Fraction,
		unsigned long &	FaceNr
	)		const

virtual

Traces a ray against this map element, and returns whether it was hit.

The ray for the trace is defined by RayOrigin + RayDir*Fraction, where Fraction is a scalar >= 0. If a hit was detected, the Fraction is returned. Hit brushes return the number of the hit face as well. This method has been implemented mainly for "picking", that is, left-click selection in the 3D views (it makes sure that also objects that "clip nothing" in the engine can be picked), but it can also be used for any other purpose.

Parameters

RayOrigin	The point in world space where the ray starts.
RayDir	A unit vector in world space that describes the direction the ray extends to.
Fraction	On hit, the scalar along RayDir at which the hit occurred is returned here.
FaceNr	If this map element is a brush and it was hit, the number of the hit face is returned here.

Returns: true if the ray hit this map element, false otherwise. Additional hit data (i.e. Fraction and FaceNr) is returned via reference paramaters.

Reimplemented from MapElementT.

void MapTerrainT::TrafoMirror	(	unsigned int	NormalAxis,
		float	Dist,
		bool	LockTexCoords
	)

overridevirtual

Mirrors this element along the given mirror plane (in world-space).

Parameters

NormalAxis	The number of the axis along which the normal vector of the mirror plane points: 0, 1 or 2 for the x-, y- or z-axis respectively.
Dist	The position of the mirror plane along its normal vector, where it intersects the NormalAxis.
LockTexCoords	Transform the texture-space along with the geometry. Note that the mirroring is not necessarily "perfect", because for some elements like models or plants, only their point of origin can be mirrored, but not their mesh.

Reimplemented from MapElementT.

void MapTerrainT::TrafoMove	(	const Vector3fT &	Delta,
		bool	LockTexCoords
	)

overridevirtual

Translates this element by the given vector (in world-space).

Parameters

Delta	The offset by which to translate the element.
LockTexCoords	Transform the texture-space along with the geometry.

Reimplemented from MapElementT.

void MapTerrainT::TrafoRotate	(	const Vector3fT &	RefPoint,
		const cf::math::AnglesfT &	Angles,
		bool	LockTexCoords
	)

overridevirtual

Rotates this element about the given reference point (in world-space).

Parameters

RefPoint	The reference point (origin) for the rotation.
Angles	The rotation angles for the three axes.
LockTexCoords	Transform the texture-space along with the geometry.

Reimplemented from MapElementT.

void MapTerrainT::TrafoScale	(	const Vector3fT &	RefPoint,
		const Vector3fT &	Scale,
		bool	LockTexCoords
	)

overridevirtual

Scales this element about the given reference point (in world-space).

Parameters

RefPoint	The reference point (origin) for the scale.
Scale	The scale factors for the three axes.
LockTexCoords	Transform the texture-space along with the geometry.

Exceptions

DivisionByZeroE,e.g. when Scale is too small and the element becomes degenerate (e.g. a brush with too small faces).

Reimplemented from MapElementT.

void MapTerrainT::Transform	(	const Matrix4x4fT &	Matrix,
		bool	LockTexCoords
	)

overridevirtual

Why does this method not replace all the other Trafo*() methods? This method is the most generic, allowing transformations that e.g.

are non-orthogonal (like shears or non-uniform scales). This in turn conflicts with map primitives that can only store and deal with a restricted fixed set of transformations, e.g. an origin, a rotation and a uniform scale. These values cannot properly be re-computed from a general matrix with non-orthogonal basis vectors.

Parameters

Matrix	The matrix that describes the transform to be applied.
LockTexCoords	Transform the texture-space along with the geometry.

Reimplemented from MapElementT.

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

CaWE/MapEditor/MapTerrain.hpp
CaWE/MapEditor/LoadSave_cmap.cpp
CaWE/MapEditor/MapTerrain.cpp

Public Member Functions

Static Public Member Functions

Static Public Attributes

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation