PlacementTypeMask Class Reference

#include <PlacementTypeMask.h>

Inheritance diagram for PlacementTypeMask:

List of all members.

Public Member Functions
	PlacementTypeMask ()
virtual	~PlacementTypeMask ()
virtual PlacementType::Type	getType ()
virtual bool	readXML (XMLNode *node)
virtual void	getPositions (ScorchedContext &context, RandomGenerator &generator, std::list< Position > &returnPositions, ProgressCounter *counter=0)
Protected Attributes
int	numobjects
std::string	mask
fixed	minheight
fixed	maxheight
fixed	mincloseness
fixed	minslope
fixed	xsnap
fixed	ysnap

---

Detailed Description

Definition at line 26 of file PlacementTypeMask.h.

---

Constructor & Destructor Documentation

PlacementTypeMask::PlacementTypeMask

(

)

Definition at line 30 of file PlacementTypeMask.cpp.

PlacementTypeMask::~PlacementTypeMask

(

)

[virtual]

Definition at line 34 of file PlacementTypeMask.cpp.

---

Member Function Documentation

virtual PlacementType::Type PlacementTypeMask::getType

(

)

[inline, virtual]

Implements PlacementType.

Definition at line 32 of file PlacementTypeMask.h.

References PlacementType::eMask.

bool PlacementTypeMask::readXML

(

XMLNode *

node

)

[virtual]

Reimplemented from PlacementType.

Definition at line 38 of file PlacementTypeMask.cpp.

References XMLNode::getNamedChild(), mask, maxheight, mincloseness, minheight, minslope, numobjects, PlacementType::readXML(), xsnap, and ysnap.

void PlacementTypeMask::getPositions	(	ScorchedContext &	context,
		RandomGenerator &	generator,
		std::list< Position > &	returnPositions,
		ProgressCounter *	counter = 0
	)			[virtual]

Definition at line 51 of file PlacementTypeMask.cpp.

References fixed::asInt(), PlacementType::checkCloseness(), S3D::dialogExit(), S3D::formatStringBuffer(), ImageHandle::getBits(), S3D::getDataFile(), LandscapeMaps::getGroundMaps(), ImageHandle::getHeight(), GroundMaps::getInterpHeight(), GroundMaps::getLandscapeHeight(), ScorchedContext::getLandscapeMaps(), GroundMaps::getLandscapeWidth(), RandomGenerator::getRandFixed(), ImageHandle::getWidth(), ImageFactory::loadImageHandle(), mask, MAX, maxheight, MIN, mincloseness, minheight, minslope, numobjects, ProgressCounter::setNewPercentage(), xsnap, and ysnap.

---

Member Data Documentation

int PlacementTypeMask::numobjects [protected]

Definition at line 40 of file PlacementTypeMask.h.

Referenced by getPositions(), and readXML().

std::string PlacementTypeMask::mask [protected]

Definition at line 41 of file PlacementTypeMask.h.

Referenced by getPositions(), and readXML().

fixed PlacementTypeMask::minheight [protected]

Definition at line 42 of file PlacementTypeMask.h.

Referenced by getPositions(), and readXML().

fixed PlacementTypeMask::maxheight [protected]

Definition at line 42 of file PlacementTypeMask.h.

Referenced by getPositions(), and readXML().

fixed PlacementTypeMask::mincloseness [protected]

Definition at line 43 of file PlacementTypeMask.h.

Referenced by getPositions(), and readXML().

fixed PlacementTypeMask::minslope [protected]

Definition at line 43 of file PlacementTypeMask.h.

Referenced by getPositions(), and readXML().

fixed PlacementTypeMask::xsnap [protected]

Definition at line 44 of file PlacementTypeMask.h.

Referenced by getPositions(), and readXML().

fixed PlacementTypeMask::ysnap [protected]

Definition at line 44 of file PlacementTypeMask.h.

Referenced by getPositions(), and readXML().

---

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

• src/common/placement/PlacementTypeMask.h
• src/common/placement/PlacementTypeMask.cpp

---