cProtIntGen Class Reference

Interface that all the generator classes provide. More...

#include <ProtIntGen.h>

Inheritance diagram for cProtIntGen:

Public Types
using	Underlying = std::shared_ptr< cProtIntGen >
	Type of the generic interface used for storing links to the underlying generators. More...

Public Member Functions
virtual void	GetInts (int a_MinX, int a_MinZ, size_t a_SizeX, size_t a_SizeZ, int *a_Values)=0
	Generates the array of specified size into a_Values, based on given min coords. More...
virtual	~cProtIntGen ()
	Force a virtual destructor in all descendants. More...

Static Protected Attributes
static const int	m_BufferSize = PROT_INT_BUFFER_SIZE
	Maximum size of the generated area. More...

Detailed Description

Interface that all the generator classes provide.

Definition at line 44 of file ProtIntGen.h.

Member Typedef Documentation

Underlying

using cProtIntGen::Underlying = std::shared_ptr<cProtIntGen>

Type of the generic interface used for storing links to the underlying generators.

Definition at line 54 of file ProtIntGen.h.

Constructor & Destructor Documentation

~cProtIntGen()

virtual cProtIntGen::~cProtIntGen ( )

inlinevirtual

Force a virtual destructor in all descendants.

Descendants contain virtual functions and are referred to via pointer-to-base, so they need a virtual destructor.

Definition at line 59 of file ProtIntGen.h.

Member Function Documentation

GetInts()

virtual void cProtIntGen::GetInts ( int  a_MinX, int  a_MinZ, size_t  a_SizeX, size_t  a_SizeZ, int *  a_Values  )

pure virtual

Generates the array of specified size into a_Values, based on given min coords.

Implemented in cProtIntGenMBiomes, cProtIntGenBiomeEdges, cProtIntGenAlternateBiomes, cProtIntGenRareBiomeGroups, cProtIntGenSetRandomly, cProtIntGenAddToOcean, cProtIntGenRiver, cProtIntGenMixRivers, cProtIntGenReplaceRandomly, cProtIntGenBiomes, cProtIntGenBiomeGroupEdges, cProtIntGenAddIslands, cProtIntGenBeaches, cProtIntGenRndBetween, cProtIntGenRndAvg, cProtIntGenAddRnd, cProtIntGenRndChoice, cProtIntGenWeightAvg< WeightCenter, WeightCardinal, WeightDiagonal >, cProtIntGenAvg4Values, cProtIntGenAvgValues, cProtIntGenSmooth, cProtIntGenZoom, cProtIntGenLandOcean, and cProtIntGenChoice.

Member Data Documentation

m_BufferSize

const int cProtIntGen::m_BufferSize = PROT_INT_BUFFER_SIZE

staticprotected

Maximum size of the generated area.

Adjust the constant if you need larger areas, these are just so that we can use fixed-size buffers.

Definition at line 49 of file ProtIntGen.h.

---

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

• src/Generating/ProtIntGen.h