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{
7
8enum class MRMESH_CLASS LinesVisualizePropertyType
9{
13 _count [[maybe_unused]],
14};
15template <> struct IsVisualizeMaskEnum<LinesVisualizePropertyType> : std::true_type {};
16
23
27{
28public:
32
33 constexpr static const char* TypeName() noexcept { return "LinesHolder"; }
34 virtual const char* typeName() const override { return TypeName(); }
35
36 MRMESH_API virtual void applyScale( float scaleFactor ) override;
37
38 MRMESH_API virtual bool hasVisualRepresentation() const override;
39
40 [[nodiscard]] virtual bool hasModel() const override { return bool( polyline_ ); }
41
42 MRMESH_API virtual std::shared_ptr<Object> clone() const override;
43 MRMESH_API virtual std::shared_ptr<Object> shallowClone() const override;
44
45 const std::shared_ptr<const Polyline3>& polyline() const
46 { return reinterpret_cast< const std::shared_ptr<const Polyline3>& >( polyline_ ); } // reinterpret_cast to avoid making a copy of shared_ptr
47
48 MRMESH_API virtual void setDirtyFlags( uint32_t mask, bool invalidateCaches = true ) override;
49
55 MRMESH_API virtual void setDashPattern( const DashPattern& pattern, ViewportId vpId = {} );
56 virtual const DashPattern& getDashPattern( ViewportId vpId = {}, bool* isDef = nullptr ) const { return dashPattern_.get( vpId, isDef ); }
57
58 MRMESH_API virtual void setLineWidth( float width );
59 virtual float getLineWidth() const { return lineWidth_; }
60 MRMESH_API virtual void setPointSize( float size );
61 virtual float getPointSize() const { return pointSize_; }
62
65
67 const VertColors& getVertsColorMap() const { return vertsColorMap_; }
68
70 virtual void setVertsColorMap( VertColors vertsColorMap ) { vertsColorMap_ = std::move( vertsColorMap ); setDirtyFlags( DIRTY_VERTS_COLORMAP ); }
71
73 virtual void updateVertsColorMap( VertColors& vertsColorMap ) { std::swap( vertsColorMap_, vertsColorMap ); setDirtyFlags( DIRTY_VERTS_COLORMAP ); }
74
75 const UndirectedEdgeColors& getLinesColorMap() const { return linesColorMap_; }
76 virtual void setLinesColorMap( UndirectedEdgeColors linesColorMap ) { linesColorMap_ = std::move( linesColorMap ); setDirtyFlags( DIRTY_PRIMITIVE_COLORMAP ); }
77 virtual void updateLinesColorMap( UndirectedEdgeColors& updated ) { std::swap( linesColorMap_, updated ); setDirtyFlags( DIRTY_PRIMITIVE_COLORMAP ); }
78
79 [[nodiscard]] MRMESH_API bool supportsVisualizeProperty( AnyVisualizeMaskEnum type ) const override;
84
86 MRMESH_API virtual void copyColors( const ObjectLinesHolder& src, const VertMap& thisToSrc );
87
90 MRMESH_API virtual Box3f getWorldBox( ViewportId = {} ) const override;
91
93 [[nodiscard]] MRMESH_API virtual size_t heapBytes() const override;
94
96 [[nodiscard]] MRMESH_API float avgEdgeLen() const;
97
99 [[nodiscard]] MRMESH_API size_t numUndirectedEdges() const;
100
102 [[nodiscard]] MRMESH_API size_t numComponents() const;
103
105 [[nodiscard]] MRMESH_API float totalLength() const;
106
109
110protected:
111 ObjectLinesHolder( const ObjectLinesHolder& other ) = default;
112
114 MRMESH_API virtual void swapBase_( Object& other ) override;
115
118 MRMESH_API void serializeBaseFields_( Json::Value& root ) const;
120 MRMESH_API virtual void serializeFields_( Json::Value& root ) const override;
121
122 MRMESH_API Expected<void> deserializeModel_( const std::filesystem::path& path, ProgressCallback progressCb = {} ) override;
123
126 MRMESH_API void deserializeBaseFields_( const Json::Value& root );
127
129 MRMESH_API virtual void deserializeFields_( const Json::Value& root ) override;
130
131 MRMESH_API virtual Box3f computeBoundingBox_() const override;
132
133 MRMESH_API virtual void setupRenderObject_() const override;
134
136 MRMESH_API void setAllVisualizeProperties_( const AllVisualizeProperties& properties, std::size_t& pos ) override;
137
138 mutable std::optional<size_t> numUndirectedEdges_;
139 mutable std::optional<size_t> numComponents_;
140 mutable std::optional<float> avgEdgeLen_;
141 mutable std::optional<float> totalLength_;
143
144 VertColors vertsColorMap_;
145 UndirectedEdgeColors linesColorMap_;
146
150 ViewportProperty<DashPattern> dashPattern_ = DashPattern::diagonal( 20 );
151
153 float lineWidth_{ 1.0f };
154 float pointSize_{ 5.f };
155 std::shared_ptr<Polyline3> polyline_;
156
157private:
159 void setDefaultColors_();
160
162 void setDefaultSceneProperties_();
163};
164
165
166} // namespace MR
#define MRMESH_API
Definition MRMesh/MRMeshFwd.h:80
#define MRMESH_CLASS
Definition MRMesh/MRMeshFwd.h:84
Dashed
Definition MRObjectLinesHolder.h:12
Points
Definition MRObjectLinesHolder.h:10
Definition MRVisualObject.h:54
Definition MRObjectLinesHolder.h:27
MRMESH_API size_t numUndirectedEdges() const
returns cached information about the number of undirected edges in the polyline
MRMESH_API ObjectLinesHolder()
virtual MRMESH_API void swapBase_(Object &other) override
swaps this object with other
virtual MRMESH_API void setPointSize(float size)
virtual MRMESH_API void setLineWidth(float width)
std::optional< float > avgEdgeLen_
Definition MRObjectLinesHolder.h:140
const VertColors & getVertsColorMap() const
returns per-vertex colors of the object
Definition MRObjectLinesHolder.h:67
ObjectLinesHolder & operator=(ObjectLinesHolder &&)=default
virtual MRMESH_API void setupRenderObject_() const override
const UndirectedEdgeColors & getLinesColorMap() const
Definition MRObjectLinesHolder.h:75
virtual MRMESH_API void setDirtyFlags(uint32_t mask, bool invalidateCaches=true) override
virtual MRMESH_API Box3f computeBoundingBox_() const override
UndirectedEdgeColors linesColorMap_
Definition MRObjectLinesHolder.h:145
virtual void updateLinesColorMap(UndirectedEdgeColors &updated)
Definition MRObjectLinesHolder.h:77
ViewportMask smoothConnections_
Definition MRObjectLinesHolder.h:148
MRMESH_API void serializeBaseFields_(Json::Value &root) const
MRMESH_API float avgEdgeLen() const
returns cached average edge length
ViewportMask dashed_
Definition MRObjectLinesHolder.h:149
MRMESH_API size_t numComponents() const
returns cached information about the number of components in the polyline
virtual const char * typeName() const override
Definition MRObjectLinesHolder.h:34
static constexpr const char * TypeName() noexcept
Definition MRObjectLinesHolder.h:33
virtual float getPointSize() const
Definition MRObjectLinesHolder.h:61
MRMESH_API void resetFrontColor() override
reset basic object colors to their default values from the current theme
virtual const DashPattern & getDashPattern(ViewportId vpId={}, bool *isDef=nullptr) const
Definition MRObjectLinesHolder.h:56
virtual bool hasModel() const override
Definition MRObjectLinesHolder.h:40
MRMESH_API void setAllVisualizeProperties_(const AllVisualizeProperties &properties, std::size_t &pos) override
set all visualize properties masks
virtual MRMESH_API void applyScale(float scaleFactor) override
scale object size (all point positions)
virtual MRMESH_API void copyColors(const ObjectLinesHolder &src, const VertMap &thisToSrc)
copies vertex colors from given source object
MRMESH_API float totalLength() const
return cached total length
virtual MRMESH_API std::shared_ptr< Object > clone() const override
virtual MRMESH_API void deserializeFields_(const Json::Value &root) override
deserializeFields_: deserializeBaseFields_ plus polyline deserialization
virtual MRMESH_API void setDashPattern(const DashPattern &pattern, ViewportId vpId={})
std::optional< size_t > numUndirectedEdges_
Definition MRObjectLinesHolder.h:138
MRMESH_API bool supportsVisualizeProperty(AnyVisualizeMaskEnum type) const override
Returns true if this class supports the property type. Otherwise passing it to the functions below is...
virtual MRMESH_API std::shared_ptr< Object > shallowClone() const override
ObjectLinesHolder(ObjectLinesHolder &&)=default
MRMESH_API void deserializeBaseFields_(const Json::Value &root)
MRMESH_API const ViewportMask & getVisualizePropertyMask(AnyVisualizeMaskEnum type) const override
returns mask of viewports where given property is set
virtual MRMESH_API bool hasVisualRepresentation() const override
does the object have any visual representation (visible points, triangles, edges, etc....
virtual void updateVertsColorMap(VertColors &vertsColorMap)
swaps per-vertex colors of the object with given argument
Definition MRObjectLinesHolder.h:73
MRMESH_API Expected< void > deserializeModel_(const std::filesystem::path &path, ProgressCallback progressCb={}) override
Reads model from file.
virtual MRMESH_API Box3f getWorldBox(ViewportId={}) const override
std::optional< size_t > numComponents_
Definition MRObjectLinesHolder.h:139
virtual MRMESH_API void serializeFields_(Json::Value &root) const override
serializeFields_: serializeBaseFields_ plus polyline serialization
ObjectLinesHolder(const ObjectLinesHolder &other)=default
ViewportMask showPoints_
Definition MRObjectLinesHolder.h:147
virtual void setLinesColorMap(UndirectedEdgeColors linesColorMap)
Definition MRObjectLinesHolder.h:76
virtual void setVertsColorMap(VertColors vertsColorMap)
sets per-vertex colors of the object
Definition MRObjectLinesHolder.h:70
virtual float getLineWidth() const
Definition MRObjectLinesHolder.h:59
virtual MRMESH_API size_t heapBytes() const override
returns the amount of memory this object occupies on heap
const std::shared_ptr< const Polyline3 > & polyline() const
Definition MRObjectLinesHolder.h:45
VertColors vertsColorMap_
Definition MRObjectLinesHolder.h:144
ObjectLinesHolder(ProtectedStruct, const ObjectLinesHolder &obj)
Definition MRObjectLinesHolder.h:64
std::optional< float > totalLength_
Definition MRObjectLinesHolder.h:141
MRMESH_API AllVisualizeProperties getAllVisualizeProperties() const override
get all visualize properties masks
ViewportProperty< XfBasedCache< Box3f > > worldBox_
Definition MRObjectLinesHolder.h:142
std::shared_ptr< Polyline3 > polyline_
Definition MRObjectLinesHolder.h:155
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
Visual Object.
Definition MRVisualObject.h:119
std::function< bool(float)> ProgressCallback
Definition MRMesh/MRMeshFwd.h:729
std::vector< ViewportMask > AllVisualizeProperties
Definition MRVisualObject.h:72
@ DIRTY_PRIMITIVE_COLORMAP
Definition MRVisualObject.h:88
@ DIRTY_VERTS_COLORMAP
Definition MRVisualObject.h:87
Definition MRCameraOrientationPlugin.h:8
tl::expected< T, E > Expected
Definition MRExpected.h:25
@ Smooth
create mesh using dual marching cubes from OpenVDB library
Definition MRVisualObject.h:32
Definition MRObject.h:279
Definition MRVector4.h:22