Gui.h

Go to the documentation of this file.

#pragma once
 
#include <stack>
#include <string>
 
#include "sgui/Widgets/Style.h"
#include "sgui/Widgets/Panel.h"
#include "sgui/Internals/Counters.h"
#include "sgui/Internals/GuiGroup.h"
#include "sgui/Internals/GuiStates.h"
#include "sgui/Internals/ScrollerInformation.h"
 
#include "sgui/Core/ObjectPool.h"
#include "sgui/Core/Interpolation.h"
#include "sgui/Render/Plotter.h"
#include "sgui/Render/GuiRender.h"
#include "sgui/Resources/SoundPlayer.h"
#include "sgui/Resources/TextContainer.h"
 
namespace sgui 
{
class Gui : public sf::Drawable, public sf::Transformable
{
public:
  Gui ();
  Gui (
      sf::Font& font,
      sf::Texture& widgetTexture,
      const TextureAtlas& widgetAtlas,
      const sf::RenderWindow& window);
  void initialize (
      sf::Font& font,
      sf::Texture& widgetTexture,
      const TextureAtlas& widgetAtlas,
      const sf::RenderWindow& window);


  void setResources (
      sf::Font& font,
      sf::Texture& widgetTexture);
  void setTextureAtlas (const TextureAtlas& widgetAtlas);
  void setSounds (SoundHolder& sounds);
  void setStyle (
      const Style& newStyle,
      const bool defaultPadding = true);
  void setPadding (const sf::Vector2f& padding = {0.5f, 0.125f});
  void setPixelsPerScroll (const float amount);


  void setView (const sf::View& view);
  void beginFrame ();
  void endFrame (const float tooltipDelay = 0.5f);
  void update (
      const sf::RenderWindow& window,
      const std::optional <sf::Event>& event);
  void setScreenSize (const sf::Vector2f& size);
  void updateTimer ();


  Style& style ();
  const Style& style () const;
  sf::Vector2f textSize (
      const std::string& text,
      const TextType type = TextType::Normal) const;
  float textHeight (const TextType type = TextType::Normal) const;
  sf::Vector2f activePanelSize () const;
  sf::Vector2f normalizeSize (const sf::Vector2f& panelSize) const;
  sf::Vector2f denormalizeSize (const sf::Vector2f& panelSize) const;
  sf::Vector2f lastSpacing () const;
  void addSpacing (const sf::Vector2f& amount);
  void addLastSpacing (const float amount = 1.f);
  void setAnchor (const std::string& key = "");
  void backToAnchor (const std::string& key = "");
  sf::Vector2f cursorPosition () const;
  void sameLine ();
  bool isActive () const;
  sf::Vector2f parentGroupSize ();
  sf::Vector2f textureSize (const std::string& texture) const;


  bool beginWindow (
      Panel& settings,
      const Constraints& constraint = {},
      const WidgetOptions& options = {});
  bool beginWindow (
      Window& window,
      const TextContainer& texts = {});
  void endWindow ();

  void beginPanel (
      Panel& settings,
      const Constraints& constraint = {},
      const WidgetOptions& options = {});
  void beginPanel (Window& window);
  void endPanel ();


  void beginMenu ();
  void endMenu ();
  bool menuItem (
      const std::string& text,
      const WidgetOptions& options = {});

  // as a general note for all widgets, displacement in options (if different from zero) 
  // will override automatic placement and are relative to group
  void separation (const float thickness = 0.75f);
  void image (
      const std::string& textureId,
      const sf::Vector2f& size = {},
      const WidgetOptions& options = {});
  bool clickable (
      const sf::Vector2f& size,
      const WidgetOptions& options = {});
  bool button (
      const std::string& text,
      const WidgetOptions& options = {});
  bool icon (
      const std::string& iconName,
      const WidgetOptions& options = {});
  bool checkBox (
      bool& checked,
      const WidgetOptions& options = {});


  void text (
      const std::string& text,
      const TextOptions& textOptions = {},
      const WidgetOptions& options = {});
  void fontawesome (
      const std::string& iconName,
      const TextType type = TextType::Normal);


  template <typename Type>
  void inputNumber (
      Type& number,
      const WidgetOptions& options = {},
      const Type min = 0,
      const Type max = 0,
      const std::string& label = "",
      const bool fixedWidth = false);
  template <typename Type>
  void inputVector2 (
      sf::Vector2<Type>& vector,
      const WidgetOptions& options = {},
      const sf::Vector2<Type>& min = {},
      const sf::Vector2<Type>& max = {});
  template <typename Type>
  void inputVector3 (
      sf::Vector3<Type>& vector,
      const WidgetOptions& options = {},
      const sf::Vector3<Type>& min = {},
      const sf::Vector3<Type>& max = {});
  void inputColor (
      sf::Color& color,
      const WidgetOptions& options = {});
  void inputText (
      std::string& text,
      const TextOptions& textOptions = {},
      const WidgetOptions& options = {});
  void inputKey (
      char& key,
      const WidgetOptions& options = {});


  void progressBar (
      const float progress,
      const WidgetOptions& options = {});


  std::string comboBox (
      const std::vector <std::string>& list,
      const WidgetOptions& options = {});


  template <typename Type>
  void slider (
      Type& value,
      const Type min,
      const Type max,
      const WidgetOptions& options = {});


  void setPlotRange (
      const PlotRange xRange,
      const PlotRange yRange);
  void setSample (const uint32_t sample);
  void setPlotBound (const sf::Vector2f& bound);
  void unsetPlotBound ();
  void plot (
      const std::function<float (float)>& slope,
      const float thickness = 1.f,
      const sf::Color& lineColor = sf::Color::White);
  void plot (
      const std::function<sf::Vector2f (float)>& slope,
      const float thickness = 1.f,
      const sf::Color& lineColor = sf::Color::White);
  void plot (
      const std::vector<sf::Vector2f>& points,
      const float thickness = 1.f,
      const sf::Color& lineColor = sf::Color::White);
  void forcePlotUpdate ();
private:
  // draw gui
  void draw (sf::RenderTarget& target, sf::RenderStates states) const override;
  // to remove or add last vertical or horizontal spacing
  void addLastVerticalSpacing (const float amount = 1.f);
  void addLastHorizontalSpacing (const float amount = 1.f);
  // begin/end a group (subjacent struct of window/box/etc.)
  void beginGroup (const bool horizontal, const sf::FloatRect& box);
  void endGroup ();
  // window or panel utility functions
  sf::Vector2f computePosition (const Panel& settings, const Constraints& constraint);
  // for nested clipping layer, this need to be called before beginGroup.
  sf::FloatRect handleParentClipBox (const sf::FloatRect& box);
  // this need to be called after endGroup to clean clipping layer.
  void removeClipping ();
  // move a group with the mouse if its possible
  ItemState interactWithMouse (Panel& settings, const sf::FloatRect& box, const std::string& name, const Tooltip& info);
  // cache plot data
  void cachePlotData (const std::function<float (float)>& slope);
  void cachePlotData (const std::function<sf::Vector2f (float)>& slope);
  // set plot bound depending of the current context
  void handlePlotBound ();
  // for scrollable panel or window
  bool isPanelScrollable (const Impl::GroupData& panel);
  bool scrollThroughPanel (Impl::GroupData& panel, const sf::FloatRect& panelBox, const ItemState panelState, const bool horizontal);
  sf::Vector2f scroller (float& scrollPercent, const sf::FloatRect& panelBox, const sf::Vector2f& scrollSize, const ItemState panelState, const bool horizontal);
  // to handle scroll bar in a slider
  float sliderBar (const sf::FloatRect& parentBox, const ItemState state, const float scrollPercent, const bool horizontal);
  // to handle scroll bar in a scroller
  float scrollerBar (const sf::FloatRect& parentBox, const ItemState state, const float scrollPercent, const float extraSize, const bool horizontal);
  // to handle shifting value of scroller/slider
  template <typename Type>
  Type sliderValue (const sf::FloatRect& box, const Type min, const Type max, const bool horizontal);
  // draw tooltip of the hovered item
  void tooltip (const float apparitionDelay);
  bool tooltipNeedReset ();
  // to manage each item in a dropList
  bool dropListItem (float& clock, const std::string& selectedName, const std::string& itemName, const sf::Vector2f& itemSize);
  // Utility function that return status of widget, it is not clickable by default
  ItemState itemStatus (const sf::FloatRect& boundingbox, const std::string& item, const bool condition, const Tooltip& tooltip = {}, const bool forceActive = false);
  // handle all edge cases and special keys
  void handleKeyInput (std::string& text, size_t& textCursorIndex);
  void drawTextCursor (sf::Vector2f position, const std::string& inputTextId, const std::string& text, const TextOptions& options);
  size_t utf8Length (const std::string& text) const;
  // handle key for inputNumber
  template <typename Type>
  void handleNumberKeyInput (Type& number, size_t& cursorIndex, const bool focused, const Type min, const Type max);
  template <typename Type>
  Type convertKeyIntoNumber (std::string& key, const Type min, const Type max) const;
  template <typename Type>
  std::string formatNumberToString (const Type& number) const;
  // format text to fit in a box
  std::vector<std::string> formatText (const std::string& text, const sf::Vector2f& boxSize, const TextType type = TextType::Normal) const;
  // get font size
  uint32_t getFontSize (const TextType type) const;
  // fit text in a constrained line
  std::string truncateText (const std::string& text, const float width) const;
  // format text for fontawesome use
  void handleTextDrawing (const sf::Vector2f& position, const std::string& text, const TextType fontSize = TextType::Normal);
  // draw a fontawesome icon
  void fontawesomeIcon (const sf::Vector2f& position, const std::string& icon, const uint32_t fontSize);
  // to compute widget name and relative position to the cursor/group
  std::string initializeActivable (const std::string& key);
  sf::Vector2f computeRelativePosition (const sf::Vector2f& displacement = {}) const;
  // to handle appearance options
  WidgetDrawOptions drawOptions (const WidgetAspect& standard, const WidgetAspect& custom = {}, const bool horizontal = true, const float progress = 1.f) const;
  bool isValid (const Widget widget) const;
  bool isValid (const Slices slices) const;
  bool isValid (const ItemState state) const;
  bool isValid (const std::string& image) const;
  // to draw text description of widgets
  sf::Vector2f widgetDescription (const sf::Vector2f& position, const std::string& description);
  // to compute widget spacing and scrolling
  void updateSpacing (const sf::Vector2f& size);
  void updateScrolling ();
  Impl::GroupData getParentGroup ();
  // to process sfml events and store it in the internal state
  void handleMouseInputs (const sf::RenderWindow& window, const std::optional <sf::Event>& event);
  void handleKeyboardInputs (const std::optional <sf::Event>& event);
  // to play sounds
  void playSound (const ItemState state);
private:
  // plot parameters
  bool mPlotIsBounded = false;
  uint32_t mPlotSample = 50u;
  // Tooltip clock
  sf::Clock mInternalClock = {};
  float mTipAppearClock = 0.f;
  float mTipDisappearClock = 100.f;
  float mTextCursorClock = 0.f;
  // Scroll intensity
  float mPixelsPerScroll = 40.f;
  // data to keep track of same line call
  sf::Vector2f mResetCursorPosition = {};
  std::stack <sf::Vector2f> mSameLinePosition;
  // counters to keep track of gui objects
  Impl::Counters mCounters = {};
  Impl::GroupChecker mChecker = {};
  std::string mWidgetChain = "";
  // alignement data
  sf::Vector2f mCursorPosition = {};
  sf::Vector2f mPadding = {6.f, 1.5f};
  sf::Vector2f mLastSpacing = {};
  sf::Vector2f mWindowSize;
  sf::Vector2f mPlotBound;
  std::string mActiveInputNumberStr;
  // to play sound
  bool mSoundIsOn = false;
  std::string mPreviousWidgetSoundId = "";
  std::string mActiveWidgetSoundId = "";
  SoundPlayer mSoundPlayer;
  // render for gui, plot and primitive shape
  Style mStyle;
  sf::Font* mFont;
  sf::Font mFontawesome;
  Plotter mPlotter;
  GuiRender mRender;
  PrimitiveShapeRender mColorRender;
  // inputs and gui state
  Impl::InputState mInputState;
  Impl::InternalItemState mGuiState;
  // gui internal data
  std::stack <sf::Vector2f> mAnchors;
  std::unordered_map <std::string, sf::Vector2f> mAnchorsWithKeys;
  std::stack <uint32_t> mMenuClippingLayer;
  std::stack <Impl::GroupData> mGroups;
  ObjectPool <Impl::GroupHoverBox> mGroupsHoverBoxes;
  ObjectPool <uint32_t> mGroupsActiveItem;
  ObjectPool <std::string> mComboBoxActiveItem;
  ObjectPool <size_t, std::string> mTextCursorPositions;
  ObjectPool <uint8_t, std::string> mTextHasCursor;
  ObjectPool <float> mComboBoxClocks;
  ObjectPool <Panel, std::string> mInputTextPanels;
  ObjectPool <std::vector <sf::Vector2f>> mPlotsData;
  ObjectPool <Impl::ScrollerInformation> mGroupsScrollerData;
};
 
} // namespace sgui
 
#include "sgui/Gui.tpp"