blob: 9f1e8cebd698e37259756785e76f7c844381be8d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
#pragma once
#include <string>
#include "../manager/Mediator.h"
#include "../util/OptionalRef.h"
namespace crepe {
class SceneManager;
class ComponentManager;
/**
* \brief Represents a Scene
*
* This class represents a Scene. The Scene class is only used as an interface for the game
* programmer.
*/
class Scene {
protected:
// NOTE: This must be the only constructor on Scene, see "Late references" below
Scene() = default;
//! SceneManager instances Scene
friend class SceneManager;
public:
virtual ~Scene() = default;
public:
//! Load the scene
virtual void load_scene() = 0;
/**
* \brief Get the scene's name
* \return The scene's name
*/
virtual std::string get_name() const = 0;
// TODO: Late references should ALWAYS be private! This is currently kept as-is so unit tests
// keep passing, but this reference should not be directly accessible by the user!!!
protected:
/**
* \name Late references
*
* These references are set by SceneManager immediately after calling the constructor of Scene.
*
* \note Scene must have a constructor without arguments so the game programmer doesn't need to
* manually add `using Scene::Scene` to their concrete scene class, if they want to add a
* constructor with arguments (e.g. for passing references to their own concrete Scene classes).
*
* \{
*/
//! Mediator reference
OptionalRef<Mediator> mediator;
//! \}
};
} // namespace crepe
|