Sly Engine
TerrainManager Class Reference

#include <TerrainManager.h>

Collaboration diagram for TerrainManager:
Collaboration graph

Static Public Member Functions

static TerrainObject * GetCurrentTerrain ()
 Gets the current terrain. More...
 
static void SetCurrentTerrain (TerrainObject *newTerrain)
 Sets current terrain. More...
 
static void DeinitializeCurrentTerrain ()
 Deinitialize the current terrain. Required if a scene will be revisited later on. More...
 

Private Member Functions

 TerrainManager ()
 Default constructor. More...
 
 TerrainManager (const TerrainManager &)=delete
 Copy constructor. More...
 
 TerrainManager (TerrainManager &&)=delete
 Move constructor. More...
 
TerrainManager & operator= (const TerrainManager &)=delete
 Assignment operator. More...
 
TerrainManager & operator= (TerrainManager &&)=delete
 Move assignment operator. More...
 
 ~TerrainManager ()=default
 Deconstructor. More...
 
TerrainObject * privGetCurrentTerrain ()
 Internal call to return the current terrain. More...
 
void privSetCurrentTerrain (TerrainObject *newTerrain)
 Internal call to change the current terrain. More...
 
void privDelete ()
 Internal call to delete the pointer of TerrainManager instance. More...
 
void privSceneEnd ()
 Private scene end, forces a draw deregistration. More...
 
void privSceneStart ()
 Private scene start, gently asks for a draw registration. More...
 

Static Private Member Functions

static TerrainManager & Instance ()
 Gets the instance of TerrainManager. More...
 
static void Delete ()
 Delete the TerrainManager. More...
 

Private Attributes

TerrainObject * pCurrentTerrain
 The current terrain. More...
 

Static Private Attributes

static TerrainManager * ptrInstance = nullptr
 Dictates the usage of TerrainManager's internals. More...
 

Friends

class TerrainManagerAttorney
 

Constructor & Destructor Documentation

◆ TerrainManager() [1/3]

TerrainManager::TerrainManager ( )
private

Default constructor.

Here is the caller graph for this function:

◆ TerrainManager() [2/3]

TerrainManager::TerrainManager ( const TerrainManager &  )
privatedelete

Copy constructor.

◆ TerrainManager() [3/3]

TerrainManager::TerrainManager ( TerrainManager &&  )
privatedelete

Move constructor.

◆ ~TerrainManager()

TerrainManager::~TerrainManager ( )
privatedefault

Deconstructor.

Member Function Documentation

◆ DeinitializeCurrentTerrain()

static void TerrainManager::DeinitializeCurrentTerrain ( )
inlinestatic

Deinitialize the current terrain. Required if a scene will be revisited later on.

Here is the call graph for this function:

◆ Delete()

static void TerrainManager::Delete ( )
inlinestaticprivate

Delete the TerrainManager.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ GetCurrentTerrain()

static TerrainObject * TerrainManager::GetCurrentTerrain ( )
inlinestatic

Gets the current terrain.

Returns
Null if it fails, else the current terrain.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ Instance()

static TerrainManager & TerrainManager::Instance ( )
inlinestaticprivate

Gets the instance of TerrainManager.

Returns
A reference to a TerrainManager.
Here is the call graph for this function:
Here is the caller graph for this function:

◆ operator=() [1/2]

TerrainManager& TerrainManager::operator= ( const TerrainManager &  )
privatedelete

Assignment operator.

◆ operator=() [2/2]

TerrainManager& TerrainManager::operator= ( TerrainManager &&  )
privatedelete

Move assignment operator.

◆ privDelete()

void TerrainManager::privDelete ( )
private

Internal call to delete the pointer of TerrainManager instance.

Here is the caller graph for this function:

◆ privGetCurrentTerrain()

TerrainObject * TerrainManager::privGetCurrentTerrain ( )
private

Internal call to return the current terrain.

Returns
Null if it fails, else a pointer to a TerrainObject.
Here is the caller graph for this function:

◆ privSceneEnd()

void TerrainManager::privSceneEnd ( )
private

Private scene end, forces a draw deregistration.

Here is the call graph for this function:
Here is the caller graph for this function:

◆ privSceneStart()

void TerrainManager::privSceneStart ( )
private

Private scene start, gently asks for a draw registration.

◆ privSetCurrentTerrain()

void TerrainManager::privSetCurrentTerrain ( TerrainObject *  newTerrain)
private

Internal call to change the current terrain.

Parameters
[in,out]newTerrainIf non-null, the new terrain.
Here is the caller graph for this function:

◆ SetCurrentTerrain()

static void TerrainManager::SetCurrentTerrain ( TerrainObject *  newTerrain)
inlinestatic

Sets current terrain.

Parameters
[in,out]newTerrainIf non-null, the new terrain.
Here is the call graph for this function:

Friends And Related Function Documentation

◆ TerrainManagerAttorney

friend class TerrainManagerAttorney
friend

Member Data Documentation

◆ pCurrentTerrain

TerrainObject* TerrainManager::pCurrentTerrain
private

The current terrain.

◆ ptrInstance

TerrainManager * TerrainManager::ptrInstance = nullptr
staticprivate

Dictates the usage of TerrainManager's internals.


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