Sdk: Add Console
Former-commit-id: c80d3c9dbbb0391fdb48a2710f5b5bf7468c050d
This commit is contained in:
Lynix
parent
adf5946711
commit
55cfd66c7a
|
|
@ -0,0 +1,89 @@
|
||||||
|
// Copyright (C) 2015 Jérôme Leclercq
|
||||||
|
// This file is part of the "Nazara Development Kit"
|
||||||
|
// For conditions of distribution and use, see copyright notice in Prerequesites.hpp
|
||||||
|
|
||||||
|
#pragma once
|
||||||
|
|
||||||
|
#ifndef NDK_CONSOLE_HPP
|
||||||
|
#define NDK_CONSOLE_HPP
|
||||||
|
|
||||||
|
#include <Nazara/Graphics/Sprite.hpp>
|
||||||
|
#include <Nazara/Graphics/TextSprite.hpp>
|
||||||
|
#include <Nazara/Utility/Node.hpp>
|
||||||
|
#include <Nazara/Utility/SimpleTextDrawer.hpp>
|
||||||
|
#include <NDK/EntityOwner.hpp>
|
||||||
|
|
||||||
|
namespace Nz
|
||||||
|
{
|
||||||
|
class LuaInstance;
|
||||||
|
}
|
||||||
|
|
||||||
|
namespace Ndk
|
||||||
|
{
|
||||||
|
class Entity;
|
||||||
|
|
||||||
|
class NDK_API Console : public Nz::Node
|
||||||
|
{
|
||||||
|
public:
|
||||||
|
Console(World& world, const Nz::Vector2f& size, Nz::LuaInstance& instance);
|
||||||
|
Console(const Console& console) = delete;
|
||||||
|
Console(Console&& console) = default;
|
||||||
|
~Console() = default;
|
||||||
|
|
||||||
|
void AddLine(const Nz::String& text, const Nz::Color& color = Nz::Color::White);
|
||||||
|
|
||||||
|
inline const EntityHandle& GetBackground() const;
|
||||||
|
inline unsigned int GetCharacterSize() const;
|
||||||
|
inline const EntityHandle& GetHistory() const;
|
||||||
|
inline const EntityHandle& GetInput() const;
|
||||||
|
inline const Nz::Vector2f& GetSize() const;
|
||||||
|
inline const Nz::FontRef& GetTextFont() const;
|
||||||
|
|
||||||
|
inline bool IsVisible() const;
|
||||||
|
|
||||||
|
void SendCharacter(char32_t character);
|
||||||
|
|
||||||
|
void SetCharacterSize(unsigned int size);
|
||||||
|
void SetSize(const Nz::Vector2f& size);
|
||||||
|
void SetTextFont(Nz::FontRef font);
|
||||||
|
|
||||||
|
void Show(bool show = true);
|
||||||
|
|
||||||
|
Console& operator=(const Console& console) = delete;
|
||||||
|
Console& operator=(Console&& console) = default;
|
||||||
|
|
||||||
|
private:
|
||||||
|
void AddLineInternal(const Nz::String& text, const Nz::Color& color = Nz::Color::White);
|
||||||
|
void ExecuteInput();
|
||||||
|
void Layout();
|
||||||
|
void RefreshHistory();
|
||||||
|
|
||||||
|
struct Line
|
||||||
|
{
|
||||||
|
Nz::Color color;
|
||||||
|
Nz::String text;
|
||||||
|
};
|
||||||
|
|
||||||
|
std::vector<Line> m_historyLines;
|
||||||
|
EntityOwner m_background;
|
||||||
|
EntityOwner m_history;
|
||||||
|
EntityOwner m_input;
|
||||||
|
EntityOwner m_inputBackground;
|
||||||
|
Nz::FontRef m_defaultFont;
|
||||||
|
Nz::LuaInstance& m_instance;
|
||||||
|
Nz::SpriteRef m_backgroundSprite;
|
||||||
|
Nz::SpriteRef m_inputBackgroundSprite;
|
||||||
|
Nz::SimpleTextDrawer m_historyDrawer;
|
||||||
|
Nz::SimpleTextDrawer m_inputDrawer;
|
||||||
|
Nz::TextSpriteRef m_historyTextSprite;
|
||||||
|
Nz::TextSpriteRef m_inputTextSprite;
|
||||||
|
Nz::Vector2f m_size;
|
||||||
|
bool m_opened;
|
||||||
|
unsigned int m_characterSize;
|
||||||
|
unsigned int m_maxHistoryLines;
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
#include <NDK/Console.inl>
|
||||||
|
|
||||||
|
#endif // NDK_CONSOLE_HPP
|
||||||
|
|
@ -0,0 +1,44 @@
|
||||||
|
// Copyright (C) 2015 Jérôme Leclercq
|
||||||
|
// This file is part of the "Nazara Development Kit"
|
||||||
|
// For conditions of distribution and use, see copyright notice in Prerequesites.hpp
|
||||||
|
|
||||||
|
#include <Nazara/Core/Error.hpp>
|
||||||
|
#include "Console.hpp"
|
||||||
|
|
||||||
|
namespace Ndk
|
||||||
|
{
|
||||||
|
inline const EntityHandle& Console::GetBackground() const
|
||||||
|
{
|
||||||
|
return m_background;
|
||||||
|
}
|
||||||
|
|
||||||
|
inline unsigned int Console::GetCharacterSize() const
|
||||||
|
{
|
||||||
|
return m_characterSize;
|
||||||
|
}
|
||||||
|
|
||||||
|
inline const EntityHandle& Console::GetHistory() const
|
||||||
|
{
|
||||||
|
return m_history;
|
||||||
|
}
|
||||||
|
|
||||||
|
inline const EntityHandle& Console::GetInput() const
|
||||||
|
{
|
||||||
|
return m_input;
|
||||||
|
}
|
||||||
|
|
||||||
|
inline const Nz::Vector2f& Console::GetSize() const
|
||||||
|
{
|
||||||
|
return m_size;
|
||||||
|
}
|
||||||
|
|
||||||
|
inline const Nz::FontRef& Console::GetTextFont() const
|
||||||
|
{
|
||||||
|
return m_defaultFont;
|
||||||
|
}
|
||||||
|
|
||||||
|
inline bool Console::IsVisible() const
|
||||||
|
{
|
||||||
|
return m_opened;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,219 @@
|
||||||
|
// Copyright (C) 2015 Jérôme Leclercq
|
||||||
|
// This file is part of the "Nazara Development Kit"
|
||||||
|
// For conditions of distribution and use, see copyright notice in Prerequesites.hpp
|
||||||
|
|
||||||
|
#include <NDK/Console.hpp>
|
||||||
|
#include <Nazara/Core/Unicode.hpp>
|
||||||
|
#include <Nazara/Lua/LuaInstance.hpp>
|
||||||
|
#include <NDK/Components/GraphicsComponent.hpp>
|
||||||
|
#include <NDK/Components/NodeComponent.hpp>
|
||||||
|
#include <NDK/World.hpp>
|
||||||
|
|
||||||
|
///TODO: For now is unable to display different color in the history, it needs a RichTextDrawer to do so
|
||||||
|
|
||||||
|
namespace Ndk
|
||||||
|
{
|
||||||
|
namespace
|
||||||
|
{
|
||||||
|
const char s_inputPrefix[] = "> ";
|
||||||
|
constexpr std::size_t s_inputPrefixSize = Nz::CountOf(s_inputPrefix) - 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
Console::Console(World& world, const Nz::Vector2f& size, Nz::LuaInstance& instance) :
|
||||||
|
m_defaultFont(Nz::Font::GetDefault()),
|
||||||
|
m_instance(instance),
|
||||||
|
m_size(size),
|
||||||
|
m_opened(false),
|
||||||
|
m_characterSize(24)
|
||||||
|
{
|
||||||
|
Nz::MaterialRef backgroundMaterial = Nz::Material::New();
|
||||||
|
backgroundMaterial->Enable(Nz::RendererParameter_Blend, true);
|
||||||
|
backgroundMaterial->Enable(Nz::RendererParameter_DepthBuffer, false);
|
||||||
|
backgroundMaterial->SetDstBlend(Nz::BlendFunc_InvSrcAlpha);
|
||||||
|
backgroundMaterial->SetSrcBlend(Nz::BlendFunc_SrcAlpha);
|
||||||
|
|
||||||
|
// History bakckground
|
||||||
|
m_historyBackgroundSprite = Nz::Sprite::New();
|
||||||
|
m_historyBackgroundSprite->SetColor(Nz::Color(80, 80, 160, 128));
|
||||||
|
m_historyBackgroundSprite->SetMaterial(backgroundMaterial);
|
||||||
|
|
||||||
|
m_historyBackground = world.CreateEntity();
|
||||||
|
m_historyBackground->Enable(m_opened);
|
||||||
|
m_historyBackground->AddComponent<Ndk::GraphicsComponent>().Attach(m_historyBackgroundSprite, -1);
|
||||||
|
m_historyBackground->AddComponent<Ndk::NodeComponent>().SetParent(this);
|
||||||
|
|
||||||
|
// History
|
||||||
|
m_historyDrawer.SetCharacterSize(m_characterSize);
|
||||||
|
m_historyDrawer.SetColor(Nz::Color(200, 200, 200));
|
||||||
|
m_historyDrawer.SetFont(m_defaultFont);
|
||||||
|
|
||||||
|
m_historyTextSprite = Nz::TextSprite::New();
|
||||||
|
|
||||||
|
m_history = world.CreateEntity();
|
||||||
|
m_history->Enable(m_opened);
|
||||||
|
m_history->AddComponent<Ndk::GraphicsComponent>().Attach(m_historyTextSprite);
|
||||||
|
|
||||||
|
Ndk::NodeComponent& historyNode = m_history->AddComponent<Ndk::NodeComponent>();
|
||||||
|
historyNode.SetParent(this);
|
||||||
|
|
||||||
|
// Input background
|
||||||
|
m_inputBackgroundSprite = Nz::Sprite::New();
|
||||||
|
m_inputBackgroundSprite->SetColor(Nz::Color(255, 255, 255, 200));
|
||||||
|
m_inputBackgroundSprite->SetMaterial(backgroundMaterial);
|
||||||
|
|
||||||
|
m_inputBackground = world.CreateEntity();
|
||||||
|
m_inputBackground->Enable(m_opened);
|
||||||
|
m_inputBackground->AddComponent<Ndk::GraphicsComponent>().Attach(m_inputBackgroundSprite, -1);
|
||||||
|
m_inputBackground->AddComponent<Ndk::NodeComponent>().SetParent(this);
|
||||||
|
|
||||||
|
// Input
|
||||||
|
m_inputDrawer.SetColor(Nz::Color::Black);
|
||||||
|
m_inputDrawer.SetCharacterSize(m_characterSize);
|
||||||
|
m_inputDrawer.SetFont(m_defaultFont);
|
||||||
|
m_inputDrawer.SetText(s_inputPrefix);
|
||||||
|
|
||||||
|
m_inputTextSprite = Nz::TextSprite::New();
|
||||||
|
m_inputTextSprite->Update(m_inputDrawer);
|
||||||
|
|
||||||
|
m_input = world.CreateEntity();
|
||||||
|
m_input->Enable(m_opened);
|
||||||
|
m_input->AddComponent<Ndk::GraphicsComponent>().Attach(m_inputTextSprite);
|
||||||
|
|
||||||
|
Ndk::NodeComponent& inputNode = m_input->AddComponent<Ndk::NodeComponent>();
|
||||||
|
inputNode.SetParent(this);
|
||||||
|
|
||||||
|
Layout();
|
||||||
|
}
|
||||||
|
|
||||||
|
void Console::AddLine(const Nz::String& text, const Nz::Color& color)
|
||||||
|
{
|
||||||
|
AddLineInternal(text, color);
|
||||||
|
RefreshHistory();
|
||||||
|
}
|
||||||
|
|
||||||
|
void Console::SendCharacter(char32_t character)
|
||||||
|
{
|
||||||
|
switch (character)
|
||||||
|
{
|
||||||
|
case '\b':
|
||||||
|
{
|
||||||
|
Nz::String input = m_inputDrawer.GetText();
|
||||||
|
if (input.GetLength() <= s_inputPrefixSize) // Prevent removal of the input prefix
|
||||||
|
return; // Ignore if no user character is there
|
||||||
|
|
||||||
|
input.Resize(-1, Nz::String::HandleUtf8);
|
||||||
|
m_inputDrawer.SetText(input);
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
|
||||||
|
case '\r':
|
||||||
|
case '\n':
|
||||||
|
ExecuteInput();
|
||||||
|
break;
|
||||||
|
|
||||||
|
default:
|
||||||
|
{
|
||||||
|
if (Nz::Unicode::GetCategory(character) == Nz::Unicode::Category_Other_Control)
|
||||||
|
return;
|
||||||
|
|
||||||
|
m_inputDrawer.AppendText(Nz::String::Unicode(character));
|
||||||
|
break;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
m_inputTextSprite->Update(m_inputDrawer);
|
||||||
|
}
|
||||||
|
|
||||||
|
void Console::SetCharacterSize(unsigned int size)
|
||||||
|
{
|
||||||
|
m_characterSize = size;
|
||||||
|
Layout();
|
||||||
|
}
|
||||||
|
|
||||||
|
void Console::SetSize(const Nz::Vector2f& size)
|
||||||
|
{
|
||||||
|
m_size = size;
|
||||||
|
m_historyBackgroundSprite->SetSize(m_size);
|
||||||
|
Layout();
|
||||||
|
}
|
||||||
|
|
||||||
|
void Console::SetTextFont(Nz::FontRef font)
|
||||||
|
{
|
||||||
|
Layout();
|
||||||
|
}
|
||||||
|
|
||||||
|
void Console::Show(bool show)
|
||||||
|
{
|
||||||
|
if (m_opened != show)
|
||||||
|
{
|
||||||
|
m_historyBackground->Enable(show);
|
||||||
|
m_history->Enable(show);
|
||||||
|
m_input->Enable(show);
|
||||||
|
m_inputBackground->Enable(show);
|
||||||
|
|
||||||
|
m_opened = show;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
void Console::AddLineInternal(const Nz::String& text, const Nz::Color& color)
|
||||||
|
{
|
||||||
|
m_historyLines.emplace_back(Line{color, text});
|
||||||
|
}
|
||||||
|
|
||||||
|
void Console::ExecuteInput()
|
||||||
|
{
|
||||||
|
Nz::String input = m_inputDrawer.GetText().SubString(s_inputPrefixSize);
|
||||||
|
m_inputDrawer.SetText(s_inputPrefix);
|
||||||
|
|
||||||
|
AddLineInternal(input);
|
||||||
|
|
||||||
|
if (!m_instance.Execute(input))
|
||||||
|
AddLineInternal(m_instance.GetLastError(), Nz::Color::Red);
|
||||||
|
|
||||||
|
RefreshHistory();
|
||||||
|
}
|
||||||
|
|
||||||
|
void Console::Layout()
|
||||||
|
{
|
||||||
|
unsigned int lineHeight = m_defaultFont->GetSizeInfo(m_characterSize).lineHeight;
|
||||||
|
|
||||||
|
Ndk::NodeComponent& inputNode = m_input->GetComponent<Ndk::NodeComponent>();
|
||||||
|
inputNode.SetPosition(0.f, m_size.y - lineHeight - 5.f);
|
||||||
|
|
||||||
|
float historyHeight = m_size.y - lineHeight - 5.f - 2.f;
|
||||||
|
m_historyBackgroundSprite->SetSize(m_size.x, historyHeight);
|
||||||
|
|
||||||
|
m_maxHistoryLines = static_cast<unsigned int>(std::ceil(historyHeight / lineHeight));
|
||||||
|
|
||||||
|
Ndk::NodeComponent& historyNode = m_history->GetComponent<Ndk::NodeComponent>();
|
||||||
|
historyNode.SetPosition(0.f, historyHeight - m_maxHistoryLines * lineHeight);
|
||||||
|
|
||||||
|
Ndk::NodeComponent& inputBackgroundNode = m_inputBackground->GetComponent<Ndk::NodeComponent>();
|
||||||
|
inputBackgroundNode.SetPosition(0.f, historyHeight + 2.f);
|
||||||
|
|
||||||
|
m_inputBackgroundSprite->SetSize(m_size.x, m_size.y - historyHeight);
|
||||||
|
}
|
||||||
|
|
||||||
|
void Console::RefreshHistory()
|
||||||
|
{
|
||||||
|
m_historyDrawer.Clear();
|
||||||
|
auto it = m_historyLines.end();
|
||||||
|
if (m_historyLines.size() > m_maxHistoryLines)
|
||||||
|
it -= m_maxHistoryLines;
|
||||||
|
else
|
||||||
|
it = m_historyLines.begin();
|
||||||
|
|
||||||
|
for (unsigned int i = 0; i < m_maxHistoryLines; ++i)
|
||||||
|
{
|
||||||
|
if (m_maxHistoryLines - i <= m_historyLines.size() && it != m_historyLines.end())
|
||||||
|
{
|
||||||
|
m_historyDrawer.AppendText(it->text);
|
||||||
|
++it;
|
||||||
|
}
|
||||||
|
|
||||||
|
m_historyDrawer.AppendText(Nz::String('\n'));
|
||||||
|
}
|
||||||
|
|
||||||
|
m_historyTextSprite->Update(m_historyDrawer);
|
||||||
|
}
|
||||||
|
}
|
||||||
Loading…
Reference in New Issue