Skip to content

StateManager ​

Handles app state management.

#include "State/StateManager.h"

Inherits from Module

Public Functions ​

Name
StateManager() =default
voidaddOriginator(IStateful * originator)
boolappendScene(const fs::path & path)
boolcanRedo() const
boolcanUndo() const
const fs::pathfetchTmpDirectory()<br>Returns the temporary directory path just like getTmpDirectory() but creates it if it doesn't exist yet.
Scene *getCurrentScene()
const Memento &getCurrentState() const
intgetMementosCount() const
intgetPossibleRedosCount() const
intgetPossibleUndosCount() const
const fs::pathgetTmpDirectory() const
fs::pathgetTmpDirectoryLockFileName()
boolhasScene()
boolisDirty() const
boolloadGlobal()
boolloadScene(const fs::path & path)
voidloadUserData()
voidnewScene(bool firstRun =false)
virtual voidonBeginFrame() override
virtual voidonClose() override
virtual voidonEndFrame() override
virtual voidonInit() override
voidredo()
voidrequestRewritableSnapshot()
voidrequestSnapshot()
voidresetGlobal()
boolsaveGlobal()
boolsaveScene()
boolsaveScene(const fs::path & scene)
voidsaveUserData()
voidtakeSnapshot()
voidundo()
boolisValidScenePath(const fs::path path)

Friends ​

Name
classApplication

Additional inherited members ​

Public Functions inherited from Module

Name
Module() =default
virtual~Module() =default
virtual voidonBeforeFrame()
virtual voidonUpdate(double deltaSeconds)

Public Functions Documentation ​

function StateManager ​

cpp
StateManager() =default

function addOriginator ​

cpp
inline void addOriginator(
    IStateful * originator
)

function appendScene ​

cpp
bool appendScene(
    const fs::path & path
)

function canRedo ​

cpp
bool canRedo() const

function canUndo ​

cpp
bool canUndo() const

function fetchTmpDirectory ​

cpp
const fs::path fetchTmpDirectory()

Returns the temporary directory path just like getTmpDirectory() but creates it if it doesn't exist yet.

function getCurrentScene ​

cpp
inline Scene * getCurrentScene()

function getCurrentState ​

cpp
const Memento & getCurrentState() const

function getMementosCount ​

cpp
int getMementosCount() const

function getPossibleRedosCount ​

cpp
int getPossibleRedosCount() const

TodoTest me!

function getPossibleUndosCount ​

cpp
int getPossibleUndosCount() const

function getTmpDirectory ​

cpp
const fs::path getTmpDirectory() const

function getTmpDirectoryLockFileName ​

cpp
inline fs::path getTmpDirectoryLockFileName()

function hasScene ​

cpp
inline bool hasScene()

Return: Whether a previously saved scene is currently loaded.

function isDirty ​

cpp
inline bool isDirty() const

function loadGlobal ​

cpp
bool loadGlobal()

function loadScene ​

cpp
bool loadScene(
    const fs::path & path
)

function loadUserData ​

cpp
void loadUserData()

function newScene ​

cpp
void newScene(
    bool firstRun =false
)

function onBeginFrame ​

cpp
virtual void onBeginFrame() override

Reimplements: Module::onBeginFrame

function onClose ​

cpp
virtual void onClose() override

Reimplements: Module::onClose

function onEndFrame ​

cpp
virtual void onEndFrame() override

Reimplements: Module::onEndFrame

function onInit ​

cpp
virtual void onInit() override

Reimplements: Module::onInit

function redo ​

cpp
void redo()

function requestRewritableSnapshot ​

cpp
inline void requestRewritableSnapshot()

function requestSnapshot ​

cpp
inline void requestSnapshot()

function resetGlobal ​

cpp
void resetGlobal()

function saveGlobal ​

cpp
bool saveGlobal()

function saveScene ​

cpp
bool saveScene()

function saveScene ​

cpp
bool saveScene(
    const fs::path & scene
)

function saveUserData ​

cpp
void saveUserData()

function takeSnapshot ​

cpp
void takeSnapshot()

function undo ​

cpp
void undo()

function isValidScenePath ​

cpp
static bool isValidScenePath(
    const fs::path path
)

Friends ​

friend Application ​

cpp
friend class Application(
    Application 
);

Updated on 2026-09-11 at 21:24:24 +0000