#include <RoughRavines.h>

Inheritance diagram for cRoughRavines:

Collaboration diagram for cRoughRavines:

[legend]

Public Member Functions
	cRoughRavines (int a_Seed, int a_MaxSize, int a_MinSize, float a_MaxCenterWidth, float a_MinCenterWidth, float a_MaxRoughness, float a_MinRoughness, float a_MaxFloorHeightEdge, float a_MinFloorHeightEdge, float a_MaxFloorHeightCenter, float a_MinFloorHeightCenter, float a_MaxCeilingHeightEdge, float a_MinCeilingHeightEdge, float a_MaxCeilingHeightCenter, float a_MinCeilingHeightCenter, int a_GridSize, int a_MaxOffset)

Public Member Functions inherited from cGridStructGen
	cGridStructGen (int a_Seed)
	Creates a new instance that has the generation parameters set to defaults. More...

	cGridStructGen (int a_Seed, int a_GridSizeX, int a_GridSizeZ, int a_MaxOffsetX, int a_MaxOffsetZ, int a_MaxStructureSizeX, int a_MaxStructureSizeZ, size_t a_MaxCacheSize)

virtual void	GenFinish (cChunkDesc &a_ChunkDesc) override

void	SetGeneratorParams (const AStringMap &a_GeneratorParams)
	Sets the generator params based on the dictionary passed in. More...

Public Member Functions inherited from cFinishGen
virtual	~cFinishGen ()

Protected Member Functions
virtual cStructurePtr	CreateStructure (int a_GridX, int a_GridZ, int a_OriginX, int a_OriginZ) override
	Create a new structure at the specified gridpoint. More...

Protected Member Functions inherited from cGridStructGen
void	ClearCache (void)
	Clears everything from the cache. More...

void	GetStructuresForChunk (int a_ChunkX, int a_ChunkZ, cStructurePtrs &a_Structures)
	Returns all structures that may intersect the given chunk. More...

Protected Attributes
float	m_MaxCeilingHeightCenter
	Maximum ceiling height at the ravine's center. More...

float	m_MaxCeilingHeightEdge
	Maximum ceiling height at the ravine's edge. More...

float	m_MaxCenterWidth
	Maximum width of the ravine's center, in blocks. More...

float	m_MaxFloorHeightCenter
	Maximum floor height at the ravine's center. More...

float	m_MaxFloorHeightEdge
	Maximum floor height at the ravine's edge. More...

float	m_MaxRoughness
	Maximum roughness of the ravine. More...

int	m_MaxSize
	Maximum size of the ravine, in each of the X / Z axis. More...

float	m_MinCeilingHeightCenter
	Minimum ceiling height at the ravine's center. More...

float	m_MinCeilingHeightEdge
	Minimum ceiling height at the ravine's edge. More...

float	m_MinCenterWidth
	Minimum width of the ravine's center, in blocks. More...

float	m_MinFloorHeightCenter
	Minimum floor height at the ravine's center. More...

float	m_MinFloorHeightEdge
	Minimum floor height at the ravine's edge. More...

float	m_MinRoughness
	Minimum roughness of the ravine. More...

int	m_MinSize
	Minimum size of the ravine. More...

Protected Attributes inherited from cGridStructGen
int	m_BaseSeed
	Base seed of the world for which the generator generates chunk. More...

cStructurePtrs	m_Cache
	Cache for the most recently generated structures, ordered by the recentness. More...

int	m_GridSizeX
	The size of each grid's cell in the X axis. More...

int	m_GridSizeZ
	The size of each grid's cell in the Z axis. More...

size_t	m_MaxCacheSize
	Maximum allowed sum of costs for items in the cache. More...

int	m_MaxOffsetX
	The maximum offset of the structure's origin from the grid midpoint, in X coord. More...

int	m_MaxOffsetZ
	The maximum offset of the structure's origin from the grid midpoint, in Z coord. More...

int	m_MaxStructureSizeX
	Maximum theoretical size of the structure in the X axis. More...

int	m_MaxStructureSizeZ
	Maximum theoretical size of the structure in the Z axis. More...

cNoise	m_Noise
	The noise used for generating grid offsets. More...

int	m_Seed
	Seed for generating grid offsets and also available for descendants. More...

Private Types
using	Super = cGridStructGen

Additional Inherited Members
Public Types inherited from cGridStructGen
typedef std::shared_ptr< cStructure >	cStructurePtr

typedef std::list< cStructurePtr >	cStructurePtrs

Detailed Description

Definition at line 17 of file RoughRavines.h.

Member Typedef Documentation

◆ Super

using cRoughRavines::Super = cGridStructGen

private

Definition at line 20 of file RoughRavines.h.

Constructor & Destructor Documentation

◆ cRoughRavines()

cRoughRavines::cRoughRavines	(	int	a_Seed,
		int	a_MaxSize,
		int	a_MinSize,
		float	a_MaxCenterWidth,
		float	a_MinCenterWidth,
		float	a_MaxRoughness,
		float	a_MinRoughness,
		float	a_MaxFloorHeightEdge,
		float	a_MinFloorHeightEdge,
		float	a_MaxFloorHeightCenter,
		float	a_MinFloorHeightCenter,
		float	a_MaxCeilingHeightEdge,
		float	a_MinCeilingHeightEdge,
		float	a_MaxCeilingHeightCenter,
		float	a_MinCeilingHeightCenter,
		int	a_GridSize,
		int	a_MaxOffset
	)

Definition at line 224 of file RoughRavines.cpp.

Member Function Documentation

◆ CreateStructure()

cGridStructGen::cStructurePtr cRoughRavines::CreateStructure	(	int	a_GridX,
		int	a_GridZ,
		int	a_OriginX,
		int	a_OriginZ
	)

overrideprotectedvirtual

Create a new structure at the specified gridpoint.

Implements cGridStructGen.

Definition at line 276 of file RoughRavines.cpp.

Member Data Documentation

◆ m_MaxCeilingHeightCenter

float cRoughRavines::m_MaxCeilingHeightCenter

protected

Maximum ceiling height at the ravine's center.

Definition at line 74 of file RoughRavines.h.

◆ m_MaxCeilingHeightEdge

float cRoughRavines::m_MaxCeilingHeightEdge

protected

Maximum ceiling height at the ravine's edge.

Definition at line 68 of file RoughRavines.h.

◆ m_MaxCenterWidth

float cRoughRavines::m_MaxCenterWidth

protected

Maximum width of the ravine's center, in blocks.

Definition at line 44 of file RoughRavines.h.

◆ m_MaxFloorHeightCenter

float cRoughRavines::m_MaxFloorHeightCenter

protected

Maximum floor height at the ravine's center.

Definition at line 62 of file RoughRavines.h.

◆ m_MaxFloorHeightEdge

float cRoughRavines::m_MaxFloorHeightEdge

protected

Maximum floor height at the ravine's edge.

Definition at line 56 of file RoughRavines.h.

◆ m_MaxRoughness

float cRoughRavines::m_MaxRoughness

protected

Maximum roughness of the ravine.

Definition at line 50 of file RoughRavines.h.

◆ m_MaxSize

int cRoughRavines::m_MaxSize

protected

Maximum size of the ravine, in each of the X / Z axis.

Definition at line 38 of file RoughRavines.h.

◆ m_MinCeilingHeightCenter

float cRoughRavines::m_MinCeilingHeightCenter

protected

Minimum ceiling height at the ravine's center.

Definition at line 77 of file RoughRavines.h.

◆ m_MinCeilingHeightEdge

float cRoughRavines::m_MinCeilingHeightEdge

protected

Minimum ceiling height at the ravine's edge.

Definition at line 71 of file RoughRavines.h.

◆ m_MinCenterWidth

float cRoughRavines::m_MinCenterWidth

protected

Minimum width of the ravine's center, in blocks.

Definition at line 47 of file RoughRavines.h.

◆ m_MinFloorHeightCenter

float cRoughRavines::m_MinFloorHeightCenter

protected

Minimum floor height at the ravine's center.

Definition at line 65 of file RoughRavines.h.

◆ m_MinFloorHeightEdge

float cRoughRavines::m_MinFloorHeightEdge

protected

Minimum floor height at the ravine's edge.

Definition at line 59 of file RoughRavines.h.

◆ m_MinRoughness

float cRoughRavines::m_MinRoughness

protected

Minimum roughness of the ravine.

Definition at line 53 of file RoughRavines.h.

◆ m_MinSize

int cRoughRavines::m_MinSize

protected

Minimum size of the ravine.

Definition at line 41 of file RoughRavines.h.

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

src/Generating/RoughRavines.h
src/Generating/RoughRavines.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Super

Constructor & Destructor Documentation

◆ cRoughRavines()

Member Function Documentation

◆ CreateStructure()

Member Data Documentation

◆ m_MaxCeilingHeightCenter

◆ m_MaxCeilingHeightEdge

◆ m_MaxCenterWidth

◆ m_MaxFloorHeightCenter

◆ m_MaxFloorHeightEdge

◆ m_MaxRoughness

◆ m_MaxSize

◆ m_MinCeilingHeightCenter

◆ m_MinCeilingHeightEdge

◆ m_MinCenterWidth

◆ m_MinFloorHeightCenter

◆ m_MinFloorHeightEdge

◆ m_MinRoughness

◆ m_MinSize