diff options
| -rw-r--r-- | mwe/events/include/event.h | 2 | ||||
| -rw-r--r-- | readme.md | 1 | ||||
| -rw-r--r-- | src/CMakeLists.txt | 4 | ||||
| -rw-r--r-- | src/crepe/api/CMakeLists.txt | 2 | ||||
| -rw-r--r-- | src/crepe/api/Config.h | 11 | ||||
| -rw-r--r-- | src/crepe/api/LoopManager.h | 4 | ||||
| -rw-r--r-- | src/crepe/api/Text.cpp | 14 | ||||
| -rw-r--r-- | src/crepe/api/Text.h | 67 | ||||
| -rw-r--r-- | src/crepe/facade/CMakeLists.txt | 4 | ||||
| -rw-r--r-- | src/crepe/facade/Font.cpp | 21 | ||||
| -rw-r--r-- | src/crepe/facade/Font.h | 42 | ||||
| -rw-r--r-- | src/crepe/facade/FontFacade.cpp | 51 | ||||
| -rw-r--r-- | src/crepe/facade/FontFacade.h | 34 | ||||
| -rw-r--r-- | src/crepe/facade/SDLContext.cpp | 10 | ||||
| -rw-r--r-- | src/crepe/facade/SDLContext.h | 16 | ||||
| -rw-r--r-- | src/crepe/system/RenderSystem.cpp | 26 | ||||
| -rw-r--r-- | src/crepe/system/RenderSystem.h | 10 | ||||
| -rw-r--r-- | src/example/CMakeLists.txt | 2 | ||||
| -rw-r--r-- | src/example/FontExample.cpp | 55 | ||||
| -rw-r--r-- | src/example/loadfont.cpp | 46 | 
20 files changed, 416 insertions, 6 deletions
| diff --git a/mwe/events/include/event.h b/mwe/events/include/event.h index ee1bf52..e1b220b 100644 --- a/mwe/events/include/event.h +++ b/mwe/events/include/event.h @@ -148,7 +148,7 @@ private:  };  class ShutDownEvent : public Event {  public: -	ShutDownEvent() : Event("ShutDownEvent") {}; +	ShutDownEvent() : Event("ShutDownEvent"){};  	REGISTER_EVENT_TYPE(ShutDownEvent) @@ -60,6 +60,7 @@ Then, follow these steps for each library you want to install:     $ cd lib/googletest     $ cd lib/sdl2     $ cd lib/soloud/contrib +   $ cd lib/sdl_ttf     $ cd lib/sdl_image     $ cd lib/sdl_ttf     $ cd lib/whereami diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index 97b21f0..696856c 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -9,10 +9,12 @@ project(crepe C CXX)  find_package(SDL2 REQUIRED)  find_package(SDL2_image REQUIRED) +find_package(SDL2_ttf REQUIRED)  find_package(SoLoud REQUIRED)  find_package(GTest REQUIRED)  find_package(whereami REQUIRED)  find_library(BERKELEY_DB db) +find_library(FONTCONFIG_LIB fontconfig)  add_library(crepe SHARED)  add_executable(test_main EXCLUDE_FROM_ALL) @@ -24,9 +26,11 @@ target_include_directories(crepe  target_link_libraries(crepe  	PRIVATE soloud  	PUBLIC SDL2 +	PUBLIC SDL2_ttf  	PUBLIC SDL2_image  	PUBLIC ${BERKELEY_DB}  	PUBLIC whereami +	PUBLIC ${FONTCONFIG_LIB}  )  add_subdirectory(crepe) diff --git a/src/crepe/api/CMakeLists.txt b/src/crepe/api/CMakeLists.txt index 8f84f06..e8d6f92 100644 --- a/src/crepe/api/CMakeLists.txt +++ b/src/crepe/api/CMakeLists.txt @@ -20,6 +20,7 @@ target_sources(crepe PUBLIC  	Button.cpp  	UIObject.cpp  	AI.cpp +	Text.cpp  	Scene.cpp  ) @@ -51,4 +52,5 @@ target_sources(crepe PUBLIC FILE_SET HEADERS FILES  	Button.h  	UIObject.h  	AI.h +	Text.h  ) diff --git a/src/crepe/api/Config.h b/src/crepe/api/Config.h index ed1cf38..6b9e3ca 100644 --- a/src/crepe/api/Config.h +++ b/src/crepe/api/Config.h @@ -76,6 +76,17 @@ struct Config final {  		 */  		std::string root_pattern = ".crepe-root";  	} asset; +	//! Default font options +	struct { +		/** +		 * \brief Default font size +		 * +		 * Using the SDL_ttf library the font size needs to be set when loading the font.  +		 * This config option is the font size at which all fonts will be loaded initially. +		 *  +		 */ +		unsigned int size = 16; +	} font;  	//! Configuration for click tolerance.  	struct {  		//! The maximum number of pixels the mouse can move between MouseDown and MouseUp events to be considered a click. diff --git a/src/crepe/api/LoopManager.h b/src/crepe/api/LoopManager.h index 40e6b38..1d23cbf 100644 --- a/src/crepe/api/LoopManager.h +++ b/src/crepe/api/LoopManager.h @@ -72,6 +72,8 @@ private:  	//! Global context  	Mediator mediator; +	//! SDLContext instance +	SDLContext sdl_context{mediator};  	//! Component manager instance  	ComponentManager component_manager{mediator};  	//! Scene manager instance @@ -84,8 +86,6 @@ private:  	ResourceManager resource_manager{mediator};  	//! Save manager instance  	SaveManager save_manager{mediator}; -	//! SDLContext instance -	SDLContext sdl_context{mediator};  private:  	/** diff --git a/src/crepe/api/Text.cpp b/src/crepe/api/Text.cpp new file mode 100644 index 0000000..58dc6c6 --- /dev/null +++ b/src/crepe/api/Text.cpp @@ -0,0 +1,14 @@ +#include "../facade/FontFacade.h" + +#include "Text.h" + +using namespace crepe; + +Text::Text(game_object_id_t id, const vec2 & dimensions, const vec2 & offset, +		   const std::string & font_family, const Data & data, const std::string & text, +		   std::optional<Asset> font) +	: UIObject(id, dimensions, offset), +	  text(text), +	  data(data), +	  font_family(font_family), +	  font(font) {} diff --git a/src/crepe/api/Text.h b/src/crepe/api/Text.h new file mode 100644 index 0000000..92cca18 --- /dev/null +++ b/src/crepe/api/Text.h @@ -0,0 +1,67 @@ +#pragma once + +#include <optional> +#include <string> + +#include "../Component.h" + +#include "Asset.h" +#include "Color.h" +#include "UIObject.h" + +namespace crepe { +/** + * \brief Text UIObject component for displaying text + *  + * This class can be used to display text on screen. By setting the font_family to a font already stored on the current device it will automatically be loaded in. + */ +class Text : public UIObject { +public: +	//! Text data that does not have to be set in the constructor +	struct Data { +		/** +		 *  \brief fontsize for text rendering +		 *  +		 * \note this is not the actual font size that is loaded in. +		 *  +		 * Since SDL_TTF requires the font size when loading in the font it is not possible to switch the font size. +		 * The default font size that is loaded is set in the Config. +		 * Instead this value is used to upscale the font texture which can cause blurring or distorted text when upscaling or downscaling too much. +		 */ +		unsigned int font_size = 16; + +		//! Layer sorting level of the text +		const int sorting_in_layer = 0; + +		//! Order within the sorting text +		const int order_in_layer = 0; + +		//! Label text color. +		Color text_color = Color::BLACK; +	}; + +public: +	/** +	 *  +	 * \param dimensions Width and height of the UIObject. +	 * \param offset Offset of the UIObject relative to its transform +	 * \param text The text to be displayed. +	 * \param font_family The font style name to be displayed. +	 * \param data Data struct containing extra text parameters. +	 * \param font Optional font asset that can be passed or left empty. +	 */ +	Text(game_object_id_t id, const vec2 & dimensions, const vec2 & offset, +		 const std::string & font_family, const Data & data, const std::string & text = "", +		 std::optional<Asset> font = std::nullopt); + +	//! Label text. +	std::string text = ""; +	//! font family name +	std::string font_family = ""; +	//! Font asset variable if this is not set, it will use the font_family to create an asset. +	std::optional<Asset> font; +	//! Data instance +	Data data; +}; + +} // namespace crepe diff --git a/src/crepe/facade/CMakeLists.txt b/src/crepe/facade/CMakeLists.txt index 0598e16..243ae46 100644 --- a/src/crepe/facade/CMakeLists.txt +++ b/src/crepe/facade/CMakeLists.txt @@ -4,6 +4,8 @@ target_sources(crepe PUBLIC  	SoundContext.cpp  	SDLContext.cpp  	DB.cpp +	FontFacade.cpp +	Font.cpp  )  target_sources(crepe PUBLIC FILE_SET HEADERS FILES @@ -12,5 +14,7 @@ target_sources(crepe PUBLIC FILE_SET HEADERS FILES  	SoundContext.h  	SDLContext.h  	DB.h +	FontFacade.h +	Font.h  ) diff --git a/src/crepe/facade/Font.cpp b/src/crepe/facade/Font.cpp new file mode 100644 index 0000000..771002f --- /dev/null +++ b/src/crepe/facade/Font.cpp @@ -0,0 +1,21 @@ +#include <SDL2/SDL_ttf.h> + +#include "../api/Asset.h" +#include "../api/Config.h" + +#include "Font.h" + +using namespace std; +using namespace crepe; + +Font::Font(const Asset & src, Mediator & mediator) : Resource(src, mediator) { +	const Config & config = Config::get_instance(); +	const std::string FONT_PATH = src.get_path(); +	TTF_Font * loaded_font = TTF_OpenFont(FONT_PATH.c_str(), config.font.size); +	if (loaded_font == NULL) { +		throw runtime_error(format("Font: {} (path: {})", TTF_GetError(), FONT_PATH)); +	} +	this->font = {loaded_font, [](TTF_Font * close_font) { TTF_CloseFont(close_font); }}; +} + +TTF_Font * Font::get_font() const { return this->font.get(); } diff --git a/src/crepe/facade/Font.h b/src/crepe/facade/Font.h new file mode 100644 index 0000000..b208d96 --- /dev/null +++ b/src/crepe/facade/Font.h @@ -0,0 +1,42 @@ +#pragma once + +#include <SDL2/SDL_ttf.h> +#include <memory> + +#include "../Resource.h" +#include "../api/Config.h" + +namespace crepe { + +class Asset; +/** + * \brief Resource for managing font creation and destruction + * + * This class is a wrapper around an SDL_ttf font instance, encapsulating font loading and usage. + * It loads a font from an Asset and manages its lifecycle. The font is automatically unloaded + * when this object is destroyed. + */ +class Font : public Resource { + +public: +	/** +     * \param src The Asset containing the font file path and metadata to load the font. +     * \param mediator The Mediator object used for managing the SDL context or related systems. +     */ +	Font(const Asset & src, Mediator & mediator); +	/** +     * \brief Gets the underlying TTF_Font resource. +     *  +     * This function returns the raw pointer to the SDL_ttf TTF_Font object that represents +     * the loaded font. This can be used with SDL_ttf functions to render text. +     *  +     * \return The raw TTF_Font object wrapped in a unique pointer. +     */ +	TTF_Font * get_font() const; + +private: +	//! The SDL_ttf font object with custom deleter. +	std::unique_ptr<TTF_Font, std::function<void(TTF_Font *)>> font = nullptr; +}; + +} // namespace crepe diff --git a/src/crepe/facade/FontFacade.cpp b/src/crepe/facade/FontFacade.cpp new file mode 100644 index 0000000..7edfeb8 --- /dev/null +++ b/src/crepe/facade/FontFacade.cpp @@ -0,0 +1,51 @@ +#include <fontconfig/fontconfig.h> +#include <stdexcept> + +#include "FontFacade.h" + +using namespace crepe; +using namespace std; + +FontFacade::FontFacade() { +	if (!FcInit()) { +		throw runtime_error("Failed to initialize Fontconfig."); +	} +} +FontFacade::~FontFacade() { FcFini(); } +Asset FontFacade::get_font_asset(const string & font_family) { + +	// Create a pattern to search for the font family +	FcPattern * pattern = FcNameParse(reinterpret_cast<const FcChar8 *>(font_family.c_str())); +	if (pattern == NULL) { +		throw runtime_error("Failed to create font pattern."); +	} + +	// Default configuration +	FcConfig * config = FcConfigGetCurrent(); +	if (config == NULL) { +		// FcPatternDestroy(pattern); +		throw runtime_error("Failed to get current Fontconfig configuration."); +	} + +	// Match the font pattern +	FcResult result; +	FcPattern * matched_pattern = FcFontMatch(config, pattern, &result); +	FcPatternDestroy(pattern); + +	if (matched_pattern == NULL) { +		FcPatternDestroy(matched_pattern); +		throw runtime_error("No matching font found."); +	} +	// Extract the file path +	FcChar8 * file_path = nullptr; +	if (FcPatternGetString(matched_pattern, FC_FILE, 0, &file_path) != FcResultMatch +		|| file_path == NULL) { +		// FcPatternDestroy(matched_pattern); +		throw runtime_error("Failed to get font file path."); +	} + +	// Convert the file path to a string +	string font_file_path = reinterpret_cast<const char *>(file_path); +	FcPatternDestroy(matched_pattern); +	return Asset(font_file_path); +} diff --git a/src/crepe/facade/FontFacade.h b/src/crepe/facade/FontFacade.h new file mode 100644 index 0000000..9761070 --- /dev/null +++ b/src/crepe/facade/FontFacade.h @@ -0,0 +1,34 @@ +#pragma once + +#include <memory> + +#include "../api/Asset.h" + +namespace crepe { + +/** + *  + * \brief Font facade class for converting font family names to absolute file paths + *  + */ +class FontFacade { +public: +	FontFacade(); +	~FontFacade(); +	FontFacade(const FontFacade & other) = delete; +	FontFacade & operator=(const FontFacade & other) = delete; +	FontFacade(FontFacade && other) noexcept = delete; +	FontFacade & operator=(FontFacade && other) noexcept = delete; +	/** +	 *  +	 * \brief Facade function to convert a font_family into an asset. +	 *  +	 * This function uses the FontConfig library to convert a font family name (Arial, Inter, Helvetica) and converts it to the font source path. +	 * This function returns a default font path if the font_family name doesnt exist or cant be found +	 * \param font_family Name of the font family name. +	 * \return Asset with filepath to the corresponding font. +	 */ +	Asset get_font_asset(const std::string & font_family); +}; + +} // namespace crepe diff --git a/src/crepe/facade/SDLContext.cpp b/src/crepe/facade/SDLContext.cpp index f331517..fffbe34 100644 --- a/src/crepe/facade/SDLContext.cpp +++ b/src/crepe/facade/SDLContext.cpp @@ -6,6 +6,8 @@  #include <SDL2/SDL_rect.h>  #include <SDL2/SDL_render.h>  #include <SDL2/SDL_surface.h> +#include <SDL2/SDL_ttf.h> +#include <SDL2/SDL_video.h>  #include <array>  #include <cmath>  #include <cstddef> @@ -30,6 +32,9 @@ using namespace std;  SDLContext::SDLContext(Mediator & mediator) {  	dbg_trace(); +	if (TTF_Init() == -1) { +		throw runtime_error(format("SDL_ttf initialization failed: {}", TTF_GetError())); +	}  	if (SDL_Init(SDL_INIT_VIDEO) != 0) {  		throw runtime_error(format("SDLContext: SDL_Init error: {}", SDL_GetError()));  	} @@ -71,6 +76,7 @@ SDLContext::~SDLContext() {  	// thread that SDL_Init() was called on? This has caused problems for me  	// before.  	IMG_Quit(); +	TTF_Quit();  	SDL_Quit();  } @@ -407,3 +413,7 @@ void SDLContext::set_color_texture(const Texture & texture, const Color & color)  	SDL_SetTextureColorMod(texture.get_img(), color.r, color.g, color.b);  	SDL_SetTextureAlphaMod(texture.get_img(), color.a);  } + +Asset SDLContext::get_font_from_name(const std::string & font_family) { +	return this->font_facade.get_font_asset(font_family); +} diff --git a/src/crepe/facade/SDLContext.h b/src/crepe/facade/SDLContext.h index b9c7fbd..b687f87 100644 --- a/src/crepe/facade/SDLContext.h +++ b/src/crepe/facade/SDLContext.h @@ -17,8 +17,10 @@  #include "api/KeyCodes.h"  #include "api/Sprite.h"  #include "api/Transform.h" +#include "types.h"  #include "EventData.h" +#include "FontFacade.h"  namespace crepe {  class Texture; @@ -242,6 +244,20 @@ private:  	CameraAuxiliaryData cam_aux_data;  private: +	//! instance of the font_facade +	FontFacade font_facade{}; + +public: +	/** +	 * \brief Function to Get asset from font_family +	 *  +	 * This function uses the FontFacade function to convert a font_family to an asset. +	 *  +	 * \param font_family name of the font style that needs to be used (will return an asset with default font path of the font_family doesnt exist) +	 *  +	 * \return asset with the font style absolute path +	 */ +	Asset get_font_from_name(const std::string & font_family);  	//! variable to store the state of each key (true = pressed, false = not pressed)  	keyboard_state_t keyboard_state;  	//! lookup table for converting SDL_SCANCODES to Keycodes diff --git a/src/crepe/system/RenderSystem.cpp b/src/crepe/system/RenderSystem.cpp index 505433a..62d42ec 100644 --- a/src/crepe/system/RenderSystem.cpp +++ b/src/crepe/system/RenderSystem.cpp @@ -2,13 +2,16 @@  #include <cassert>  #include <cmath>  #include <functional> +#include <optional>  #include <stdexcept>  #include <vector>  #include "../api/Camera.h"  #include "../api/ParticleEmitter.h"  #include "../api/Sprite.h" +#include "../api/Text.h"  #include "../api/Transform.h" +#include "../facade/Font.h"  #include "../facade/SDLContext.h"  #include "../facade/Texture.h"  #include "../manager/ComponentManager.h" @@ -120,8 +123,14 @@ void RenderSystem::render() {  	this->update_camera();  	RefVector<Sprite> sprites = mgr.get_components_by_type<Sprite>(); +	ResourceManager & resource_manager = this->mediator.resource_manager;  	RefVector<Sprite> sorted_sprites = this->sort(sprites); - +	RefVector<Text> text_components = mgr.get_components_by_type<Text>(); +	for (Text & text : text_components) { +		const Transform & transform +			= mgr.get_components_by_id<Transform>(text.game_object_id).front().get(); +		this->render_text(text, transform); +	}  	for (const Sprite & sprite : sorted_sprites) {  		if (!sprite.active) continue;  		const Transform & transform @@ -134,3 +143,18 @@ void RenderSystem::render() {  		this->render_normal(sprite, transform);  	}  } +void RenderSystem::render_text(Text & text, const Transform & tm) { +	SDLContext & ctx = this->mediator.sdl_context; + +	if (!text.font.has_value()) { +		text.font.emplace(ctx.get_font_from_name(text.font_family)); +	} + +	ResourceManager & resource_manager = this->mediator.resource_manager; + +	if (!text.font.has_value()) { +		return; +	} +	const Asset & font_asset = text.font.value(); +	const Font & res = resource_manager.get<Font>(font_asset); +} diff --git a/src/crepe/system/RenderSystem.h b/src/crepe/system/RenderSystem.h index fc7b46e..56a0553 100644 --- a/src/crepe/system/RenderSystem.h +++ b/src/crepe/system/RenderSystem.h @@ -10,7 +10,7 @@ namespace crepe {  class Camera;  class Sprite;  class Transform; - +class Text;  /**   * \brief Manages rendering operations for all game objects.   * @@ -50,7 +50,13 @@ private:  	 * \return true if particles have been rendered  	 */  	bool render_particle(const Sprite & sprite, const double & scale); - +	/** +	 * \brief Renders all Text components +	 * +	 * \param text The text component to be rendered. +	 * \param tm the Transform component that holds the position,rotation and scale +	 */ +	void render_text(Text & text, const Transform & tm);  	/**  	 * \brief renders a sprite with a Transform component on the screen  	 * diff --git a/src/example/CMakeLists.txt b/src/example/CMakeLists.txt index 187ed46..f62414e 100644 --- a/src/example/CMakeLists.txt +++ b/src/example/CMakeLists.txt @@ -19,4 +19,6 @@ endfunction()  add_example(rendering_particle)  add_example(game)  add_example(button) +add_example(loadfont) +add_example(FontExample)  add_example(AITest) diff --git a/src/example/FontExample.cpp b/src/example/FontExample.cpp new file mode 100644 index 0000000..6a334b1 --- /dev/null +++ b/src/example/FontExample.cpp @@ -0,0 +1,55 @@ +#include <SDL2/SDL_ttf.h> +#include <chrono> +#include <crepe/api/Camera.h> +#include <crepe/api/Config.h> +#include <crepe/api/GameObject.h> +#include <crepe/api/LoopManager.h> +#include <crepe/api/Scene.h> +#include <crepe/api/Script.h> +#include <crepe/api/Text.h> +#include <crepe/facade/Font.h> +#include <crepe/facade/SDLContext.h> +#include <crepe/manager/EventManager.h> +#include <crepe/manager/Mediator.h> +#include <crepe/manager/ResourceManager.h> +#include <exception> +#include <iostream> +#include <memory> +using namespace crepe; +using namespace std; +using namespace std::chrono; +class TestScript : public Script { +public: +	steady_clock::time_point start_time; +	virtual void init() override { start_time = steady_clock::now(); } +	virtual void update() override { +		auto now = steady_clock::now(); +		auto elapsed = duration_cast<seconds>(now - start_time).count(); + +		if (elapsed >= 5) { +			Mediator & med = mediator; +			EventManager & event_mgr = med.event_manager; +			event_mgr.trigger_event<ShutDownEvent>(); +		} +	} +}; +class TestScene : public Scene { +public: +	void load_scene() override { +		GameObject text_object = this->new_object("test", "test", vec2{0, 0}, 0, 1); +		text_object.add_component<Text>(vec2(100, 100), vec2(0, 0), "OpenSymbol", +										Text::Data{}); +		text_object.add_component<BehaviorScript>().set_script<TestScript>(); +		text_object.add_component<Camera>(ivec2{300, 300}, vec2{100, 100}, Camera::Data{}); +	} +	std::string get_name() const override { return "hey"; } +}; +int main() { +	// Config& config = Config::get_instance(); +	// config.log.level = Log::Level::TRACE; +	LoopManager engine; +	engine.add_scene<TestScene>(); +	engine.start(); + +	return 0; +} diff --git a/src/example/loadfont.cpp b/src/example/loadfont.cpp new file mode 100644 index 0000000..78b3adb --- /dev/null +++ b/src/example/loadfont.cpp @@ -0,0 +1,46 @@ +#include <SDL2/SDL_ttf.h> +#include <crepe/api/Asset.h> +#include <crepe/api/Text.h> +#include <crepe/facade/Font.h> +#include <crepe/facade/SDLContext.h> +#include <crepe/manager/Mediator.h> +#include <crepe/manager/ResourceManager.h> +#include <exception> +#include <iostream> +#include <memory> +#include <optional> +using namespace crepe; +int main() { + +	// SDLFontContext font_facade; +	Mediator mediator; +	SDLContext sdl_context{mediator}; +	// ComponentManager component_manager{mediator}; +	ResourceManager resource_manager{mediator}; +	try { +		// Correct way to create a unique pointer for Text +		std::unique_ptr<Text> label = std::make_unique<Text>( +			1, vec2(100, 100), vec2(0, 0), "OpenSymbol", Text::Data{}, "test text", Asset("")); +		// std::cout << "Path: " << label->font.get_path() << std::endl; + +		std::unique_ptr<Text> label2 = std::make_unique<Text>( +			1, vec2(100, 100), vec2(0, 0), "fsaafdafsdafsdafsdasfdds", Text::Data{}); +		Asset asset = Asset("test test"); +		label->font.emplace(asset); +		std::cout << label->font.value().get_path() << std::endl; +		// label2->font = std::make_optional(asset); +		// std::cout << "Path: " << label2->font.get_path() << std::endl; +		ResourceManager & resource_mgr = mediator.resource_manager; +		const Font & res = resource_manager.get<Font>(label->font.value()); +		// TTF_Font * test_font = res.get_font(); +		// if (test_font == NULL) { +		// 	std::cout << "error with font" << std::endl; +		// } else { +		// 	std::cout << "correct font retrieved" << std::endl; +		// } +	} catch (const std::exception & e) { +		std::cout << "Standard exception thrown: " << e.what() << std::endl; +	} + +	return 0; +} |