TerrainType Class Reference

#include <TerrainTypes.h>

Inherits MemoryPoolObject.

Public Member Functions
	TerrainType (void)
AsciiString	getName (void)
	get the name for this terrain
Bool	isBlendEdge (void)
	get whether this terrain is blend edge terrain.
TerrainClass	getClass (void)
	get the type of this terrain
Bool	getRestrictConstruction (void)
	get the construction restrictions
AsciiString	getTexture (void)
	get the texture file for this terrain
TerrainType *	friend_getNext (void)
	get next terrain in list, only for use by the terrain collection
void	friend_setName (AsciiString name)
	set the name for this terrain, for use by terrain collection only
void	friend_setNext (TerrainType *next)
	set the next pointer for the terrain list, for use by terrain collection only
void	friend_setTexture (AsciiString texture)
	set the texture, for use by terrain collection only
void	friend_setClass (TerrainClass terrainClass)
	set the class, for use by terrain collection only
void	friend_setRestrictConstruction (Bool restrict)
	set the restrict construction flag, for use by terrain collection only
void	friend_setBlendEdge (Bool isBlend)
	set whether this terrain is blend edge terrain, for use by terrain collection only
const FieldParse *	getFieldParse (void)
	get the parsing table for INI
Public Member Functions inherited from MemoryPoolObject
void	deleteInstance ()

Protected Attributes
AsciiString	m_name
	terrain entry name
AsciiString	m_texture
	texture.tga file for terrain
Bool	m_blendEdgeTexture
	contains custom blend edges
TerrainClass	m_class
	type classification of name
Bool	m_restrictConstruction
	do not allow construction on this terrain tile
TerrainType *	m_next
	next in terrain list

Static Protected Attributes
static const FieldParse	m_terrainTypeFieldParseTable []
	the parse table for INI definition

Additional Inherited Members
Protected Member Functions inherited from MemoryPoolObject
virtual	~MemoryPoolObject ()
void *	operator new (size_t s)
void	operator delete (void *p)
virtual MemoryPool *	getObjectMemoryPool ()=0

Detailed Description

A terrain type definition

Definition at line 151 of file TerrainTypes.h.

Constructor & Destructor Documentation

TerrainType()

TerrainType::TerrainType

(

void

)

Definition at line 56 of file TerrainTypes.cpp.

Member Function Documentation

friend_getNext()

TerrainType * TerrainType::friend_getNext ( void )

inline

get next terrain in list, only for use by the terrain collection

Definition at line 177 of file TerrainTypes.h.

friend_setBlendEdge()

void TerrainType::friend_setBlendEdge ( Bool isBlend )

inline

set whether this terrain is blend edge terrain, for use by terrain collection only

Definition at line 195 of file TerrainTypes.h.

friend_setClass()

void TerrainType::friend_setClass ( TerrainClass terrainClass )

inline

set the class, for use by terrain collection only

Definition at line 189 of file TerrainTypes.h.

friend_setName()

void TerrainType::friend_setName ( AsciiString name )

inline

set the name for this terrain, for use by terrain collection only

Definition at line 180 of file TerrainTypes.h.

friend_setNext()

void TerrainType::friend_setNext ( TerrainType * next )

inline

set the next pointer for the terrain list, for use by terrain collection only

Definition at line 183 of file TerrainTypes.h.

friend_setRestrictConstruction()

void TerrainType::friend_setRestrictConstruction ( Bool restrict )

inline

set the restrict construction flag, for use by terrain collection only

Definition at line 192 of file TerrainTypes.h.

friend_setTexture()

void TerrainType::friend_setTexture ( AsciiString texture )

inline

set the texture, for use by terrain collection only

Definition at line 186 of file TerrainTypes.h.

getClass()

TerrainClass TerrainType::getClass ( void )

inline

get the type of this terrain

Definition at line 168 of file TerrainTypes.h.

getFieldParse()

const FieldParse * TerrainType::getFieldParse ( void )

inline

get the parsing table for INI

Definition at line 198 of file TerrainTypes.h.

getName()

AsciiString TerrainType::getName ( void )

inline

get the name for this terrain

Definition at line 162 of file TerrainTypes.h.

getRestrictConstruction()

Bool TerrainType::getRestrictConstruction ( void )

inline

get the construction restrictions

Definition at line 171 of file TerrainTypes.h.

getTexture()

AsciiString TerrainType::getTexture ( void )

inline

get the texture file for this terrain

Definition at line 174 of file TerrainTypes.h.

isBlendEdge()

Bool TerrainType::isBlendEdge ( void )

inline

get whether this terrain is blend edge terrain.

Definition at line 165 of file TerrainTypes.h.

Member Data Documentation

m_blendEdgeTexture

Bool TerrainType::m_blendEdgeTexture

protected

contains custom blend edges

Definition at line 204 of file TerrainTypes.h.

m_class

TerrainClass TerrainType::m_class

protected

type classification of name

Definition at line 205 of file TerrainTypes.h.

m_name

AsciiString TerrainType::m_name

protected

terrain entry name

Definition at line 202 of file TerrainTypes.h.

m_next

TerrainType* TerrainType::m_next

protected

next in terrain list

Definition at line 207 of file TerrainTypes.h.

m_restrictConstruction

Bool TerrainType::m_restrictConstruction

protected

do not allow construction on this terrain tile

Definition at line 206 of file TerrainTypes.h.

m_terrainTypeFieldParseTable

const FieldParse TerrainType::m_terrainTypeFieldParseTable

staticprotected

Initial value:

= 
{
 
    { "Texture",        INI::parseAsciiString,         NULL,       offsetof( TerrainType, m_texture ) },
    { "BlendEdges", INI::parseBool,                           NULL,       offsetof( TerrainType, m_blendEdgeTexture ) },
    { "Class",          INI::parseIndexList,             terrainTypeNames, offsetof( TerrainType, m_class ) },
    { "RestrictConstruction", INI::parseBool,     NULL,       offsetof( TerrainType, m_restrictConstruction ) },
 
    { NULL,                 NULL,                                               NULL,       0 },
 
}

the parse table for INI definition

Definition at line 42 of file TerrainTypes.h.

m_texture

AsciiString TerrainType::m_texture

protected

texture.tga file for terrain

Definition at line 203 of file TerrainTypes.h.

---

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

• Code/GameEngine/Include/Common/TerrainTypes.h
• Code/GameEngine/Source/Common/TerrainTypes.cpp