Files
OpenSpace/modules/space/labelscomponent.h
Emma Broman 554373eb3e Fading of propertyowners through GUI, and more owners with fade property (#2557)
* Add property in OpenSpaceEngine for fading duration when enabling / disabling

* Add interface for fadeable components and apply to renderable

* Make layers a fadeable component

* Make globelabels a fadeable component

* Make labelscomponent a fadeable, and give it an enabled property

* Make screenspace renderables fadeable components

* Introduce concept of parent fadeables, to fade out subowners with parent

* Make rings fadeable as well

---------

Co-authored-by: Alexander Bock <alexander.bock@liu.se>
2023-04-06 12:49:49 +02:00

89 lines
3.9 KiB
C++

/*****************************************************************************************
* *
* OpenSpace *
* *
* Copyright (c) 2014-2023 *
* *
* 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_MODULE_SPACE___LABELSCOMPONENT___H__
#define __OPENSPACE_MODULE_SPACE___LABELSCOMPONENT___H__
#include <openspace/properties/propertyowner.h>
#include <openspace/rendering/fadeable.h>
#include <modules/space/speckloader.h>
#include <openspace/properties/scalar/boolproperty.h>
#include <openspace/properties/scalar/floatproperty.h>
#include <openspace/properties/vector/ivec2property.h>
#include <openspace/properties/vector/vec3property.h>
#include <openspace/util/distanceconversion.h>
#include <ghoul/glm.h>
#include <filesystem>
namespace ghoul::fontrendering { class Font; }
namespace openspace {
struct RenderData;
namespace documentation { struct Documentation; }
class LabelsComponent : public properties::PropertyOwner, public Fadeable {
public:
explicit LabelsComponent(const ghoul::Dictionary& dictionary);
~LabelsComponent() override = default;
speck::Labelset& labelSet();
const speck::Labelset& labelSet() const;
void initialize();
void loadLabels();
bool isReady() const;
bool enabled() const;
void render(const RenderData& data, const glm::dmat4& modelViewProjectionMatrix,
const glm::vec3& orthoRight, const glm::vec3& orthoUp,
float fadeInVariable = 1.f);
static documentation::Documentation Documentation();
private:
std::filesystem::path _labelFile;
DistanceUnit _unit = DistanceUnit::Parsec;
speck::Labelset _labelset;
std::shared_ptr<ghoul::fontrendering::Font> _font = nullptr;
glm::dmat4 _transformationMatrix = glm::dmat4(1.0);
// Properties
properties::BoolProperty _enabled;
properties::Vec3Property _color;
properties::FloatProperty _size;
properties::FloatProperty _fontSize;
properties::IVec2Property _minMaxSize;
properties::BoolProperty _faceCamera;
};
} // namespace openspace
#endif // __OPENSPACE_MODULE_SPACE___LABELSCOMPONENT___H__