IStateProvider.h

浏览该文件的文档.

#pragma once
 
#include "common/Export.h"
#include "common/StateValue.h"
 
#include <string>
 
namespace eve::caps {
 
enum class StateReloadPolicy {
    Preserve, 
    Reset,    
};
 
class EVENGINE_API_FOUNDATION_INLINE IStateProvider {
public:
    static constexpr const char* capabilityName = "IStateProvider";
    virtual ~IStateProvider()                   = default;
 
    virtual const char* stateKind() const = 0;
 
    virtual bool captureState(StateValue& out) = 0;
 
    virtual bool restoreState(const StateValue& in, std::string* err = nullptr) = 0;
 
    virtual bool resetToDefaults() = 0;
 
    virtual StateReloadPolicy reloadPolicy() const { return StateReloadPolicy::Preserve; }
};
 
}  // namespace eve::caps