MRObjectLabel.h

Go to the documentation of this file.

#pragma once
 
#include "MRSymbolMeshFwd.h"
#include "MRSymbolMesh.h"
 
#include "MRMesh/MRVisualObject.h"
#include "MRMesh/MRPositionedText.h"
 
namespace MR
{
 
 
enum class MRSYMBOLMESH_CLASS LabelVisualizePropertyType
{
    SourcePoint,
    LeaderLine,
    Background,
    Contour,
    _count [[maybe_unused]],
};
template <> struct IsVisualizeMaskEnum<LabelVisualizePropertyType> : std::true_type {};

class MRSYMBOLMESH_CLASS ObjectLabel : public VisualObject
{
public:
    MRSYMBOLMESH_API ObjectLabel();
 
    ObjectLabel( ObjectLabel&& ) noexcept = default;
    ObjectLabel& operator = ( ObjectLabel&& ) noexcept = default;
 
    constexpr static const char* StaticTypeName() noexcept
    {
        return "ObjectLabel";
    }
    virtual const char* typeName() const override
    {
        return StaticTypeName();
    }
 
    MRSYMBOLMESH_API virtual void applyScale( float scaleFactor ) override;
 
    virtual bool hasVisualRepresentation() const override { return true; }
 
    MRSYMBOLMESH_API virtual std::shared_ptr<Object> clone() const override;
    MRSYMBOLMESH_API virtual std::shared_ptr<Object> shallowClone() const override;

    MRSYMBOLMESH_API virtual void setFontHeight( float size );
    float getFontHeight() const { return fontHeight_; }

    MRSYMBOLMESH_API void setLabel( const PositionedText& label );
    const PositionedText& getLabel() const { return label_; }

    MRSYMBOLMESH_API void setFontPath( const std::filesystem::path& pathToFont );
    const std::filesystem::path& getFontPath() const { return pathToFont_; }

    MRSYMBOLMESH_API void setPivotPoint( const Vector2f& pivotPoint );

    const Vector2f& getPivotPoint() const { return pivotPoint_; }

    const Vector2f& getPivotShift() const { return pivotShift_; }

    MRSYMBOLMESH_API virtual void setLeaderLineWidth( float width );
    float getLeaderLineWidth() const { return leaderLineWidth_; }
    MRSYMBOLMESH_API virtual void setSourcePointSize( float size );
    float getSourcePointSize() const { return sourcePointSize_; }
    MRSYMBOLMESH_API virtual void setBackgroundPadding( float padding );
    float getBackgroundPadding() const { return backgroundPadding_; }

    MRSYMBOLMESH_API virtual void setSourcePointColor( const Color& color, ViewportId id = {} );
    const Color& getSourcePointColor( ViewportId id = {} ) const
    {
        return sourcePointColor_.get( id );
    }

    MRSYMBOLMESH_API virtual void setLeaderLineColor( const Color& color, ViewportId id = {} );
    const Color& getLeaderLineColor( ViewportId id = {} ) const
    {
        return leaderLineColor_.get( id );
    }

    MRSYMBOLMESH_API void setContourColor( const Color& color, ViewportId id = {} );
    const Color& getContourColor( ViewportId id = {} ) const
    {
        return contourColor_.get( id );
    }
 
    MRSYMBOLMESH_API const ViewportProperty<Color>& getSourcePointColorsForAllViewports() const;
    MRSYMBOLMESH_API virtual void setSourcePointColorsForAllViewports( ViewportProperty<Color> val );
 
    MRSYMBOLMESH_API const ViewportProperty<Color>& getLeaderLineColorsForAllViewports() const;
    MRSYMBOLMESH_API virtual void setLeaderLineColorsForAllViewports( ViewportProperty<Color> val );
 
    MRSYMBOLMESH_API const ViewportProperty<Color>& getContourColorsForAllViewports() const;
    MRSYMBOLMESH_API virtual void setContourColorsForAllViewports( ViewportProperty<Color> val );

    ObjectLabel( ProtectedStruct, const ObjectLabel& obj ) : ObjectLabel( obj )
    {}

    MRSYMBOLMESH_API virtual Box3f getWorldBox( ViewportId = {} ) const override;

    const std::shared_ptr<Mesh>& labelRepresentingMesh() const { return mesh_; }

    [[nodiscard]] MRSYMBOLMESH_API virtual size_t heapBytes() const override;

    MRSYMBOLMESH_API AllVisualizeProperties getAllVisualizeProperties() const override;
    MRSYMBOLMESH_API const ViewportMask& getVisualizePropertyMask( AnyVisualizeMaskEnum type ) const override;

    MRSYMBOLMESH_API void buildMeshFromText() const;
 
protected:
    PositionedText label_;
    std::filesystem::path pathToFont_;
    Vector2f pivotPoint_;

    float fontHeight_{ 25.0f };
    float leaderLineWidth_{ 1.0f };
    float sourcePointSize_{ 5.f };
    float backgroundPadding_{ 8.f };
 
    ViewportMask sourcePoint_;
    ViewportMask background_;
    ViewportMask contour_;
    ViewportMask leaderLine_;
 
    ViewportProperty<Color> sourcePointColor_;
    ViewportProperty<Color> leaderLineColor_;
    ViewportProperty<Color> contourColor_;
 
    ObjectLabel( const ObjectLabel& other ) = default;

    MRSYMBOLMESH_API virtual void swapBase_( Object& other ) override;
 
    MRSYMBOLMESH_API virtual Box3f computeBoundingBox_() const override;
 
    MRSYMBOLMESH_API virtual void serializeFields_( Json::Value& root ) const override;
 
    MRSYMBOLMESH_API virtual void deserializeFields_( const Json::Value& root ) override;
 
    MRSYMBOLMESH_API virtual void setupRenderObject_() const override;

    MRSYMBOLMESH_API void setAllVisualizeProperties_( const AllVisualizeProperties& properties, std::size_t& pos ) override;
 
private:
    void setDefaultColors_();

    void setDefaultSceneProperties_();
 
    void updatePivotShift_() const;
 
    mutable bool needRebuild_{ true };
    mutable Vector2f pivotShift_;
    mutable std::shared_ptr<Mesh> mesh_;
    mutable Box3f meshBox_; 
};
 
}