aboutsummaryrefslogtreecommitdiff
path: root/src/crepe/api/Scene.h
blob: cba4e10b3ce9f1641b47c5f2a8cc821ed28ebfb4 (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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
#pragma once

#include <string>

#include "../manager/ComponentManager.h"
#include "../manager/Mediator.h"
#include "../manager/ResourceManager.h"
#include "../util/OptionalRef.h"
#include "../util/Log.h"

#include "GameObject.h"

namespace crepe {

class SceneManager;
class ComponentManager;
class Asset;

/**
 * \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!!!

private:
	/**
	 * \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;
	//! \}

protected:
	/**
	* \brief Retrieve the reference to the SaveManager instance
	*
	* \returns A reference to the SaveManager instance held by the Mediator.
	*/
	SaveManager & get_save_manager() const;

	/**
	 * \copydoc ComponentManager::new_object
	 */
	GameObject new_object(const std::string & name, const std::string & tag = "",
						  const vec2 & position = {0, 0}, double rotation = 0,
						  double scale = 1) {
		// Forward the call to ComponentManager's new_object method
		return mediator->component_manager->new_object(name, tag, position, rotation, scale);
	}

	/**
	 * \copydoc ResourceManager::set_persistent
	 */
	void set_persistent(const Asset & asset, bool persistent) {
		mediator->resource_manager->set_persistent(asset, persistent);
	}

	/**
	* \name Logging functions
	* \see Log
	* \{
	*/
	//! \copydoc Log::logf
	template <class... Args>
	void logf(const Log::Level & level, std::format_string<Args...> fmt, Args &&... args);
	//! \copydoc Log::logf
	template <class... Args>
	void logf(std::format_string<Args...> fmt, Args &&... args);
	//! \}
};

} // namespace crepe

#include "Scene.hpp"