mirror of
https://github.com/OpenSpace/OpenSpace.git
synced 2026-01-03 10:09:40 -06:00
72 lines
3.4 KiB
C++
72 lines
3.4 KiB
C++
/*****************************************************************************************
|
|
* *
|
|
* OpenSpace *
|
|
* *
|
|
* Copyright (c) 2014-2023 *
|
|
* *
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy of this *
|
|
* software and associated documentation files (the "Software"), to deal in the Software *
|
|
* without restriction, including without limitation the rights to use, copy, modify, *
|
|
* merge, publish, distribute, sublicense, and/or sell copies of the Software, and to *
|
|
* permit persons to whom the Software is furnished to do so, subject to the following *
|
|
* conditions: *
|
|
* *
|
|
* The above copyright notice and this permission notice shall be included in all copies *
|
|
* or substantial portions of the Software. *
|
|
* *
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, *
|
|
* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A *
|
|
* PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT *
|
|
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF *
|
|
* CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE *
|
|
* OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
|
|
****************************************************************************************/
|
|
|
|
#ifndef __OPENSPACE_MODULE_STATEMACHINE___STATEMACHINE___H__
|
|
#define __OPENSPACE_MODULE_STATEMACHINE___STATEMACHINE___H__
|
|
|
|
#include <modules/statemachine/include/state.h>
|
|
#include <modules/statemachine/include/transition.h>
|
|
#include <vector>
|
|
|
|
namespace openspace {
|
|
|
|
namespace documentation { struct Documentation; }
|
|
|
|
class StateMachine {
|
|
public:
|
|
explicit StateMachine(const ghoul::Dictionary& dictionary);
|
|
~StateMachine() = default;
|
|
|
|
void setInitialState(const std::string initialState);
|
|
const State* currentState() const;
|
|
void transitionTo(const std::string& newState);
|
|
bool canTransitionTo(const std::string& state) const;
|
|
|
|
/**
|
|
* Return the identifiers of all possible transitions from the current state
|
|
*/
|
|
std::vector<std::string> possibleTransitions() const;
|
|
|
|
/**
|
|
* Saves the state machine to a .dot file, as a directed graph.
|
|
* filename is the full name of the file, including the directory,
|
|
* but without the extension.
|
|
*/
|
|
void saveToDotFile(const std::string& filename) const;
|
|
|
|
static documentation::Documentation Documentation();
|
|
|
|
private:
|
|
int findTransitionTo(const std::string& state) const;
|
|
int findState(const std::string& state) const;
|
|
|
|
int _currentStateIndex = -1;
|
|
std::vector<State> _states;
|
|
std::vector<Transition> _transitions;
|
|
};
|
|
|
|
} // namespace openspace
|
|
|
|
#endif // __OPENSPACE_MODULE_STATEMACHINE___STATEMACHINE___H__
|