ph::EngineInitSettings Class Reference

Options for initializing core engine. These settings are loaded on engine startup and remains constant till engine exit. Changing the settings will require an engine restart to see the effect. More...

#include <EngineInitSettings.h>

Public Member Functions
bool	tryLoad (const std::string &settingsFile)
	Tries to load from a saved file. If the loading failed, settings are not changed; othersie, settings will be updated to the values saved in the file.
void	load (const std::string &settingsFile)
void	save (const std::string &settingsFile) const

Static Public Member Functions
static EngineInitSettings	loadStandardConfig ()
	Load from a standard location. Create one if the file does not exist.

Public Attributes
std::vector< LogHandler >	additionalLogHandlers
	Additional log handlers for the core engine's internal logger. Important note: Handler may be called concurrently hence its implementation must ensure proper thread-safety. It is also inadvisable to perform time consuming tasks in the handler.
ESurfaceRefineMode	surfaceRefineMode = ESurfaceRefineMode::Default
real	selfIntersectDelta = 0.0002_r
std::size_t	numIterativeSurfaceRefinements = 1
bool	useRandomSeed = false
	Randomly seed the engine RNGs, so the output is not deterministic. This is useful if multiple machines are working on the same scene using a mergeable algorithm.
uint32	fixedSeed = 42
uint32	fixedSeedStep = 1

Detailed Description

Options for initializing core engine. These settings are loaded on engine startup and remains constant till engine exit. Changing the settings will require an engine restart to see the effect.

Member Function Documentation

load()

void ph::EngineInitSettings::load

(

const std::string &

settingsFile

)

loadStandardConfig()

EngineInitSettings ph::EngineInitSettings::loadStandardConfig ( )

static

Load from a standard location. Create one if the file does not exist.

save()

void ph::EngineInitSettings::save

(

const std::string &

settingsFile

)

const

tryLoad()

bool ph::EngineInitSettings::tryLoad

(

const std::string &

settingsFile

)

Tries to load from a saved file. If the loading failed, settings are not changed; othersie, settings will be updated to the values saved in the file.

Returns

Whether the load was successful.

Member Data Documentation

additionalLogHandlers

std::vector<LogHandler> ph::EngineInitSettings::additionalLogHandlers

Additional log handlers for the core engine's internal logger. Important note: Handler may be called concurrently hence its implementation must ensure proper thread-safety. It is also inadvisable to perform time consuming tasks in the handler.

fixedSeed

uint32 ph::EngineInitSettings::fixedSeed = 42

fixedSeedStep

uint32 ph::EngineInitSettings::fixedSeedStep = 1

numIterativeSurfaceRefinements

std::size_t ph::EngineInitSettings::numIterativeSurfaceRefinements = 1

selfIntersectDelta

real ph::EngineInitSettings::selfIntersectDelta = 0.0002_r

surfaceRefineMode

ESurfaceRefineMode ph::EngineInitSettings::surfaceRefineMode = ESurfaceRefineMode::Default

useRandomSeed

bool ph::EngineInitSettings::useRandomSeed = false

Randomly seed the engine RNGs, so the output is not deterministic. This is useful if multiple machines are working on the same scene using a mergeable algorithm.

---

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

• Include/EngineInitSettings.h
• Source/Api/EngineInitSettings.cpp