PCG Lib
Library for procedural content generation
Public Member Functions | Public Attributes | List of all members
skr::pcg::FloorGeneratorParameter Class Reference

holds parameters for floor generator More...

#include <FloorGenerator.h>

Public Member Functions

 FloorGeneratorParameter ()
 default constructor More...
 
 FloorGeneratorParameter (int noRooms, FloorLayoutStrategy layoutStategy)
 constrcutor More...
 
void SetGlobalParameter (int noRooms, FloorLayoutStrategy layoutstrategy)
 sets global parameters number of rooms and layout strategy More...
 
void SetDimensions (float minW, float maxW, float minL, float maxL, float minH, float maxH)
 set minimum and maximum dimension of rooms to be generatred More...
 

Public Attributes

uint8_t _noRooms
 number of rooms level consist of and are generated More...
 
FloorLayoutStrategy _layoutStrategy
 used layout strategy for rooms More...
 
float _minWidth
 minimum width of a room More...
 
float _maxWidth
 maximum width or a room More...
 
float _minLength
 minimum length of a room More...
 
float _maxLength
 maximum length of a room More...
 
float _minHeight
 minimum height of a room More...
 
float _maxHeight
 maximum height of a room More...
 
bool _rng_randomSeed
 specifies if a random or fixed seed is used for generation More...
 
uint32_t _rng_seed
 specified fixed seed. Will be ignored if random seed is used More...
 
bool _rng_printSeed
 specifies if seed will be printed to console and log or not More...
 

Detailed Description

holds parameters for floor generator

Constructor & Destructor Documentation

◆ FloorGeneratorParameter() [1/2]

skr::pcg::FloorGeneratorParameter::FloorGeneratorParameter ( )

default constructor

◆ FloorGeneratorParameter() [2/2]

skr::pcg::FloorGeneratorParameter::FloorGeneratorParameter ( int  noRooms,
FloorLayoutStrategy  layoutStategy 
)

constrcutor

Parameters
noRoomsnumber of rooms to generate
layoutStategylayout strategy used in generation

Member Function Documentation

◆ SetDimensions()

void skr::pcg::FloorGeneratorParameter::SetDimensions ( float  minW,
float  maxW,
float  minL,
float  maxL,
float  minH,
float  maxH 
)

set minimum and maximum dimension of rooms to be generatred

Parameters
minWminimum width
maxWmaxium width
minLminumum length
maxLmaximum length
minHminimum height
maxHmaximum height

◆ SetGlobalParameter()

void skr::pcg::FloorGeneratorParameter::SetGlobalParameter ( int  noRooms,
FloorLayoutStrategy  layoutstrategy 
)

sets global parameters number of rooms and layout strategy

Parameters
noRoomsnumber of rooms to generate
layoutstrategylayout strategy used in generation

Member Data Documentation

◆ _layoutStrategy

FloorLayoutStrategy skr::pcg::FloorGeneratorParameter::_layoutStrategy

used layout strategy for rooms

◆ _maxHeight

float skr::pcg::FloorGeneratorParameter::_maxHeight

maximum height of a room

◆ _maxLength

float skr::pcg::FloorGeneratorParameter::_maxLength

maximum length of a room

◆ _maxWidth

float skr::pcg::FloorGeneratorParameter::_maxWidth

maximum width or a room

◆ _minHeight

float skr::pcg::FloorGeneratorParameter::_minHeight

minimum height of a room

◆ _minLength

float skr::pcg::FloorGeneratorParameter::_minLength

minimum length of a room

◆ _minWidth

float skr::pcg::FloorGeneratorParameter::_minWidth

minimum width of a room

◆ _noRooms

uint8_t skr::pcg::FloorGeneratorParameter::_noRooms

number of rooms level consist of and are generated

◆ _rng_printSeed

bool skr::pcg::FloorGeneratorParameter::_rng_printSeed

specifies if seed will be printed to console and log or not

◆ _rng_randomSeed

bool skr::pcg::FloorGeneratorParameter::_rng_randomSeed

specifies if a random or fixed seed is used for generation

◆ _rng_seed

uint32_t skr::pcg::FloorGeneratorParameter::_rng_seed

specified fixed seed. Will be ignored if random seed is used


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