MeshLib C++ Docs
Loading...
Searching...
No Matches
MRObjectLinesHolder.h
Go to the documentation of this file.
1#pragma once
2#include "MRVisualObject.h"
3#include "MRXfBasedCache.h"
4
5namespace MR
6{
9
10
11enum class MRMESH_CLASS LinesVisualizePropertyType
12{
16 _count [[maybe_unused]],
17};
18template <> struct IsVisualizeMaskEnum<LinesVisualizePropertyType> : std::true_type {};
19
26
30{
31public:
35
36 constexpr static const char* StaticTypeName() noexcept { return "LinesHolder"; }
37 virtual const char* typeName() const override { return StaticTypeName(); }
38
39 MRMESH_API virtual void applyScale( float scaleFactor ) override;
40
41 MRMESH_API virtual bool hasVisualRepresentation() const override;
42
43 [[nodiscard]] virtual bool hasModel() const override { return bool( polyline_ ); }
44
45 MRMESH_API virtual std::shared_ptr<Object> clone() const override;
46 MRMESH_API virtual std::shared_ptr<Object> shallowClone() const override;
47
48 #ifdef __GNUC__
49 #pragma GCC diagnostic push
50 #pragma GCC diagnostic ignored "-Wstrict-aliasing"
51 #endif
52 const std::shared_ptr<const Polyline3>& polyline() const
53 { return reinterpret_cast< const std::shared_ptr<const Polyline3>& >( polyline_ ); }
54 #ifdef __GNUC__
55 #pragma GCC diagnostic pop
56 #endif
57
58 MRMESH_API virtual void setDirtyFlags( uint32_t mask, bool invalidateCaches = true ) override;
59
65 MRMESH_API virtual void setDashPattern( const DashPattern& pattern, ViewportId vpId = {} );
66 virtual const DashPattern& getDashPattern( ViewportId vpId = {}, bool* isDef = nullptr ) const { return dashPattern_.get( vpId, isDef ); }
67
68 MRMESH_API virtual void setLineWidth( float width );
69 virtual float getLineWidth() const { return lineWidth_; }
70 MRMESH_API virtual void setPointSize( float size );
71 virtual float getPointSize() const { return pointSize_; }
72
75
77 const VertColors& getVertsColorMap() const { return vertsColorMap_; }
78
80 virtual void setVertsColorMap( VertColors vertsColorMap ) { vertsColorMap_ = std::move( vertsColorMap ); setDirtyFlags( DIRTY_VERTS_COLORMAP ); }
81
83 virtual void updateVertsColorMap( VertColors& vertsColorMap ) { std::swap( vertsColorMap_, vertsColorMap ); setDirtyFlags( DIRTY_VERTS_COLORMAP ); }
84
85 const UndirectedEdgeColors& getLinesColorMap() const { return linesColorMap_; }
86 virtual void setLinesColorMap( UndirectedEdgeColors linesColorMap ) { linesColorMap_ = std::move( linesColorMap ); setDirtyFlags( DIRTY_PRIMITIVE_COLORMAP ); }
87 virtual void updateLinesColorMap( UndirectedEdgeColors& updated ) { std::swap( linesColorMap_, updated ); setDirtyFlags( DIRTY_PRIMITIVE_COLORMAP ); }
88
89 [[nodiscard]] MRMESH_API bool supportsVisualizeProperty( AnyVisualizeMaskEnum type ) const override;
94
96 MRMESH_API virtual void copyColors( const ObjectLinesHolder& src, const VertMap& thisToSrc );
97
100 MRMESH_API virtual Box3f getWorldBox( ViewportId = {} ) const override;
101
103 [[nodiscard]] MRMESH_API virtual size_t heapBytes() const override;
104
106 [[nodiscard]] MRMESH_API float avgEdgeLen() const;
107
109 [[nodiscard]] MRMESH_API size_t numUndirectedEdges() const;
110
112 [[nodiscard]] MRMESH_API size_t numComponents() const;
113
115 [[nodiscard]] MRMESH_API float totalLength() const;
116
119
121 using LinesChangedSignal = Signal<void( uint32_t mask )>;
123
124protected:
126
128 MRMESH_API virtual void swapBase_( Object& other ) override;
129
132 MRMESH_API virtual void swapSignals_( Object& other ) override;
133
136 MRMESH_API void serializeBaseFields_( Json::Value& root ) const;
138 MRMESH_API virtual void serializeFields_( Json::Value& root ) const override;
139
140 MRMESH_API Expected<void> deserializeModel_( const std::filesystem::path& path, ProgressCallback progressCb = {} ) override;
141
144 MRMESH_API void deserializeBaseFields_( const Json::Value& root );
145
147 MRMESH_API virtual void deserializeFields_( const Json::Value& root ) override;
148
149 MRMESH_API virtual Box3f computeBoundingBox_() const override;
150
151 MRMESH_API virtual void setupRenderObject_() const override;
152
154 MRMESH_API void setAllVisualizeProperties_( const AllVisualizeProperties& properties, std::size_t& pos ) override;
155
156 mutable std::optional<size_t> numUndirectedEdges_;
157 mutable std::optional<size_t> numComponents_;
158 mutable std::optional<float> avgEdgeLen_;
159 mutable std::optional<float> totalLength_;
161
162 VertColors vertsColorMap_;
163 UndirectedEdgeColors linesColorMap_;
164
169
171 float lineWidth_{ 1.0f };
172 float pointSize_{ 5.f };
173 std::shared_ptr<Polyline3> polyline_;
174
175private:
177 void setDefaultColors_();
178
180 void setDefaultSceneProperties_();
181};
182
183
184}
#define MRMESH_API
Definition MRMeshFwd.h:82
#define MRMESH_CLASS
Definition MRMeshFwd.h:89
Definition MRVisualObject.h:53
named object in the data model
Definition MRObject.h:62
Definition MRViewportId.h:16
stores mask of viewport unique identifiers
Definition MRViewportId.h:42
Definition MRViewportProperty.h:17
std::function< bool(float)> ProgressCallback
Definition MRMeshFwd.h:751
auto width(const Box< V > &box)
returns size along x axis
Definition MRBox.h:354
size_t numComponents() const
returns cached information about the number of components in the polyline
const ViewportMask & getVisualizePropertyMask(AnyVisualizeMaskEnum type) const override
returns mask of viewports where given property is set
virtual void copyColors(const ObjectLinesHolder &src, const VertMap &thisToSrc)
copies vertex colors from given source object
void resetFrontColor() override
reset basic object colors to their default values from the current theme
void setAllVisualizeProperties_(const AllVisualizeProperties &properties, std::size_t &pos) override
set all visualize properties masks
void serializeBaseFields_(Json::Value &root) const
virtual void setupRenderObject_() const override
virtual std::shared_ptr< Object > clone() const override
std::optional< float > avgEdgeLen_
Definition MRObjectLinesHolder.h:158
virtual void setDirtyFlags(uint32_t mask, bool invalidateCaches=true) override
reinterpret_cast to avoid making a copy of shared_ptr
const VertColors & getVertsColorMap() const
returns per-vertex colors of the object
Definition MRObjectLinesHolder.h:77
ImVec2 size(const ViewportRectangle &rect)
Definition MRViewport.h:32
ObjectLinesHolder & operator=(ObjectLinesHolder &&)=default
Dashed
Definition MRObjectLinesHolder.h:15
const UndirectedEdgeColors & getLinesColorMap() const
Definition MRObjectLinesHolder.h:85
virtual void serializeFields_(Json::Value &root) const override
serializeFields_: serializeBaseFields_ plus polyline serialization
LinesChangedSignal linesChangedSignal
Definition MRObjectLinesHolder.h:122
Signal< void(uint32_t mask)> LinesChangedSignal
signal about lines changing, triggered in setDirtyFlag
Definition MRObjectLinesHolder.h:121
Points
Definition MRObjectLinesHolder.h:13
size_t numUndirectedEdges() const
returns cached information about the number of undirected edges in the polyline
UndirectedEdgeColors linesColorMap_
Definition MRObjectLinesHolder.h:163
virtual void updateLinesColorMap(UndirectedEdgeColors &updated)
Definition MRObjectLinesHolder.h:87
virtual void swapSignals_(Object &other) override
ViewportMask smoothConnections_
Definition MRObjectLinesHolder.h:166
float totalLength() const
return cached total length
ViewportMask dashed_
Definition MRObjectLinesHolder.h:167
virtual const char * typeName() const override
Definition MRObjectLinesHolder.h:37
_count
If true, show additional details on the name tag, such as point coordinates. Not all features use thi...
Definition MRFeatureObject.h:90
virtual void setDashPattern(const DashPattern &pattern, ViewportId vpId={})
tl::expected< T, E > Expected
Definition MRExpected.h:31
virtual float getPointSize() const
Definition MRObjectLinesHolder.h:71
virtual const DashPattern & getDashPattern(ViewportId vpId={}, bool *isDef=nullptr) const
Definition MRObjectLinesHolder.h:66
virtual bool hasModel() const override
Definition MRObjectLinesHolder.h:43
virtual std::shared_ptr< Object > shallowClone() const override
virtual Box3f getWorldBox(ViewportId={}) const override
bool supportsVisualizeProperty(AnyVisualizeMaskEnum type) const override
Returns true if this class supports the property type. Otherwise passing it to the functions below is...
float pointSize_
Definition MRObjectLinesHolder.h:172
static constexpr const char * StaticTypeName() noexcept
Definition MRObjectLinesHolder.h:36
std::optional< size_t > numUndirectedEdges_
Definition MRObjectLinesHolder.h:156
virtual void deserializeFields_(const Json::Value &root) override
deserializeFields_: deserializeBaseFields_ plus polyline deserialization
Smooth
Definition MRObjectLinesHolder.h:14
AllVisualizeProperties getAllVisualizeProperties() const override
get all visualize properties masks
ObjectLinesHolder(ObjectLinesHolder &&)=default
static constexpr Vector4 diagonal(uint8_t a) noexcept
Definition MRVector4.h:41
virtual void updateVertsColorMap(VertColors &vertsColorMap)
swaps per-vertex colors of the object with given argument
Definition MRObjectLinesHolder.h:83
float lineWidth_
width on lines on screen in pixels
Definition MRObjectLinesHolder.h:171
float avgEdgeLen() const
returns cached average edge length
ViewportProperty< DashPattern > dashPattern_
Definition MRObjectLinesHolder.h:168
Expected< void > deserializeModel_(const std::filesystem::path &path, ProgressCallback progressCb={}) override
Reads model from file.
std::optional< size_t > numComponents_
Definition MRObjectLinesHolder.h:157
ObjectLinesHolder(const ObjectLinesHolder &other)=default
virtual void setPointSize(float size)
ViewportMask showPoints_
Definition MRObjectLinesHolder.h:165
virtual void swapBase_(Object &other) override
swaps this object with other
virtual void setLinesColorMap(UndirectedEdgeColors linesColorMap)
Definition MRObjectLinesHolder.h:86
virtual void setVertsColorMap(VertColors vertsColorMap)
sets per-vertex colors of the object
Definition MRObjectLinesHolder.h:80
void deserializeBaseFields_(const Json::Value &root)
virtual Box3f computeBoundingBox_() const override
virtual float getLineWidth() const
Definition MRObjectLinesHolder.h:69
virtual bool hasVisualRepresentation() const override
does the object have any visual representation (visible points, triangles, edges, etc....
const std::shared_ptr< const Polyline3 > & polyline() const
Definition MRObjectLinesHolder.h:52
virtual void setLineWidth(float width)
Vector4< uint8_t > DashPattern
Definition MRObjectLinesHolder.h:25
VertColors vertsColorMap_
Definition MRObjectLinesHolder.h:162
ObjectLinesHolder(ProtectedStruct, const ObjectLinesHolder &obj)
Definition MRObjectLinesHolder.h:74
std::optional< float > totalLength_
Definition MRObjectLinesHolder.h:159
virtual size_t heapBytes() const override
returns the amount of memory this object occupies on heap
ViewportProperty< XfBasedCache< Box3f > > worldBox_
Definition MRObjectLinesHolder.h:160
std::shared_ptr< Polyline3 > polyline_
Definition MRObjectLinesHolder.h:173
virtual void applyScale(float scaleFactor) override
scale object size (all point positions)
@ other
Angle, normally float. Measure in radians.
Definition MRFeatureObject.h:27
std::vector< ViewportMask > AllVisualizeProperties
Definition MRVisualObject.h:71
@ DIRTY_PRIMITIVE_COLORMAP
Definition MRVisualObject.h:86
@ DIRTY_VERTS_COLORMAP
Definition MRVisualObject.h:85
only for bindings generation
Definition MRCameraOrientationPlugin.h:8
Definition MRVisualObject.h:31
Definition MRObject.h:284
Definition MRSignal.h:28
Definition MRVector4.h:26