Files
OpenSpace/include/openspace/rendering/dashboard.h
Alexander Bock 8a364c16e3 Fix layout issues with Dashboards (#3614)
- Correctly render multiline text passed to a DashboardItemText
  - Invert the property for the Dashboard location to no longer need a negative y-axis
  - Use the current lineheight instead of pointsize for the ScreenLog
  - Remove the unused size function from DashboardItems
2025-04-21 01:10:02 +02:00

84 lines
3.9 KiB
C++

/*****************************************************************************************
* *
* OpenSpace *
* *
* Copyright (c) 2014-2025 *
* *
* Permission is hereby granted, free of charge, to any person obtaining a copy of this *
* software and associated documentation files (the "Software"), to deal in the Software *
* without restriction, including without limitation the rights to use, copy, modify, *
* merge, publish, distribute, sublicense, and/or sell copies of the Software, and to *
* permit persons to whom the Software is furnished to do so, subject to the following *
* conditions: *
* *
* The above copyright notice and this permission notice shall be included in all copies *
* or substantial portions of the Software. *
* *
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, *
* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A *
* PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT *
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF *
* CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE *
* OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
****************************************************************************************/
#ifndef __OPENSPACE_CORE___DASHBOARD___H__
#define __OPENSPACE_CORE___DASHBOARD___H__
#include <openspace/properties/propertyowner.h>
#include <openspace/properties/scalar/boolproperty.h>
#include <openspace/properties/scalar/intproperty.h>
#include <openspace/properties/vector/ivec2property.h>
#include <openspace/rendering/dashboarditem.h>
#include <ghoul/glm.h>
#include <memory>
#include <vector>
namespace openspace {
namespace scripting { struct LuaLibrary; }
class Dashboard : public properties::PropertyOwner {
public:
Dashboard();
virtual ~Dashboard() override = default;
/**
* Renders all of the items of this Dashboard at the provided \p penPosition. The
* position is provided in pixels with the top-left corner being located at (0,0). The
* rendering of the DashboardItems will update the \p penPosition according to where
* the next item should be placed.
*
* \param penPosition The location at which we want to render the dashboard items
*/
void render(glm::vec2& penPosition);
void addDashboardItem(std::unique_ptr<DashboardItem> item);
bool hasItem(int index) const;
const DashboardItem& item(int index) const;
void removeDashboardItem(const std::string& identifier);
void removeDashboardItem(int index);
void clearDashboardItems();
glm::ivec2 startPositionOffset();
std::vector<DashboardItem*> dashboardItems() const;
/**
* Returns the Lua library that contains all Lua functions available to affect the
* rendering.
*/
static scripting::LuaLibrary luaLibrary();
private:
properties::BoolProperty _isEnabled;
properties::IVec2Property _startPositionOffset;
properties::IntProperty _refreshRate;
std::vector<std::unique_ptr<DashboardItem>> _items;
std::chrono::steady_clock::time_point _lastRefresh;
};
} // openspace
#endif // __OPENSPACE_CORE___DASHBOARD___H__