MeshLib C++ Docs
Loading...
Searching...
No Matches
MRVisualObject.h
Go to the documentation of this file.
1#pragma once
2
3#include "MRObject.h"
4#include "MRMeshTexture.h"
5#include "MRVector.h"
6#include "MRColor.h"
7#include "MRPositionedText.h"
8#include "MRIRenderObject.h"
9#include "MRUniquePtr.h"
10#include "MREnums.h"
11
12namespace MR
13{
14
18
19// Note! Must use `MRMESH_CLASS` on this enum and all enums that extend this one,
20// otherwise you'll get silent wrong behavior on Mac.
21enum class MRMESH_CLASS VisualizeMaskType
22{
30 _count [[maybe_unused]],
31};
32
33// If a type derived from `VisualObject` wants to extend `VisualizeMaskType`, it must create a separate enum and specialize this to `true` for it.
34// NOTE! All those enums can start from 0, don't worry about collisions.
35template <typename T> struct IsVisualizeMaskEnum : std::false_type {};
36template <> struct IsVisualizeMaskEnum<VisualizeMaskType> : std::true_type {};
37
38// Wraps `IsVisualizeMaskEnum` and adds some sanity checks.
39template <typename T>
41 IsVisualizeMaskEnum<T>::value &&
42 std::is_same_v<std::underlying_type_t<T>, int> &&
43 std::is_same_v<T, std::remove_cvref_t<T>>;
44
45// Stores a `VisualizeMaskType` or any other enum that extends it (i.e. which specializes `IsVisualizeMaskEnum`).
46// To extract the value, do this:
47// if ( auto value = x.tryGet<MyEnum>() )
48// {
49// switch ( *value )
50// {
51// case MyEnum::foo: ...
52// case MyEnum::bar: ...
53// }
54// }
55// else // forward to the parent class
57{
58 std::type_index type_;
59 int value_ = 0;
60
61public:
62 template <AnyVisualizeMaskEnumType T>
63 AnyVisualizeMaskEnum( T value ) : type_( typeid(T) ), value_( decltype(value_)( value ) ) {}
64
65 template <AnyVisualizeMaskEnumType T>
66 [[nodiscard]] std::optional<T> tryGet() const
67 {
68 if ( type_ == typeid(T) )
69 return T( value_ );
70 else
71 return {};
72 }
73};
74
75using AllVisualizeProperties = std::vector<ViewportMask>;
76
101
105struct Dirty
106{
107 uint32_t f{DIRTY_ALL};
108 operator uint32_t&() { return f; }
109 operator uint32_t() const { return f; }
110
111 Dirty() noexcept = default;
112 Dirty( const Dirty& ) noexcept {}
113 Dirty( Dirty&& ) noexcept = default;
114 Dirty& operator =( const Dirty& ) noexcept { return *this; }
115 Dirty& operator =( Dirty&& ) noexcept = default;
116 Dirty& operator =( uint32_t b ) noexcept { f = b; return *this; }
117};
118
121{
122public:
124
126 VisualObject& operator = ( VisualObject&& ) = default;
127 virtual ~VisualObject() = default;
128
129 constexpr static const char* TypeName() noexcept { return "VisualObject"; }
130 virtual const char* typeName() const override { return TypeName(); }
131
132 std::string getClassName() const override { return "Visual Object"; }
133 std::string getClassNameInPlural() const override { return "Visual Objects"; }
134
136 [[nodiscard]] MRMESH_API virtual bool supportsVisualizeProperty( AnyVisualizeMaskEnum type ) const;
138 MRMESH_API void setVisualizeProperty( bool value, AnyVisualizeMaskEnum type, ViewportMask viewportMask );
147
152 {
153 std::size_t counter = 0;
154 setAllVisualizeProperties_( properties, counter );
155 }
156
158 [[deprecated( "please use ObjectLabel mechanism instead" )]]
159 void showLabels( bool on ) { return setVisualizeProperty( on, VisualizeMaskType::Labels, ViewportMask::all() ); }
160 [[deprecated( "please use ObjectLabel mechanism instead" )]]
161 bool showLabels() const { return getVisualizeProperty( VisualizeMaskType::Labels, ViewportMask::any() ); }
162
164 void showName( bool on ) { return setVisualizeProperty( on, VisualizeMaskType::Name, ViewportMask::all() ); }
166 bool showName() const { return getVisualizeProperty( VisualizeMaskType::Name, ViewportMask::any() ); }
167
169 MRMESH_API const Color& getFrontColor( bool selected = true, ViewportId viewportId = {} ) const;
171 MRMESH_API virtual void setFrontColor( const Color& color, bool selected, ViewportId viewportId = {} );
172
174 MRMESH_API virtual const ViewportProperty<Color>& getFrontColorsForAllViewports( bool selected = true ) const;
176 MRMESH_API virtual void setFrontColorsForAllViewports( ViewportProperty<Color> val, bool selected = true );
177
182
184 MRMESH_API const Color& getBackColor( ViewportId viewportId = {} ) const;
186 MRMESH_API virtual void setBackColor( const Color& color, ViewportId viewportId = {} );
187
189 MRMESH_API const uint8_t& getGlobalAlpha( ViewportId viewportId = {} ) const;
191 MRMESH_API virtual void setGlobalAlpha( uint8_t alpha, ViewportId viewportId = {} );
192
197
198 [[deprecated( "please use ObjectLabel mechanism instead" )]]
199 MRMESH_API const Color& getLabelsColor( ViewportId viewportId = {} ) const;
200 [[deprecated( "please use ObjectLabel mechanism instead" )]]
201 MRMESH_API virtual void setLabelsColor( const Color& color, ViewportId viewportId = {} );
202
203 [[deprecated( "please use ObjectLabel mechanism instead" )]]
205
206 [[deprecated( "please use ObjectLabel mechanism instead" )]]
208
212 MRMESH_API virtual void setDirtyFlags( uint32_t mask, bool invalidateCaches = true );
214 MRMESH_API uint32_t getDirtyFlags() const { return dirty_; }
216 MRMESH_API void resetDirty() const;
218 MRMESH_API virtual void resetDirtyExceptMask( uint32_t mask ) const;
219
224 MRMESH_API virtual Box3f getWorldBox( ViewportId = {} ) const override;
226 virtual bool getRedrawFlag( ViewportMask viewportMask ) const override
227 {
228 return Object::getRedrawFlag( viewportMask ) ||
229 ( isVisible( viewportMask ) &&
230 ( dirty_ & ( ~( DIRTY_CACHES ) ) ) );
231 }
232
234 bool isPickable( ViewportMask viewportMask = ViewportMask::any() ) const{return !(pickable_ & viewportMask).empty();}
236 MRMESH_API virtual void setPickable( bool on, ViewportMask viewportMask = ViewportMask::all() );
237
239 ColoringType getColoringType() const { return coloringType_; }
240
242 MRMESH_API virtual void setColoringType( ColoringType coloringType );
243
245 float getShininess() const { return shininess_; }
247 virtual void setShininess( float shininess ) { shininess_ = shininess; needRedraw_ = true; }
248
250 float getSpecularStrength() const { return specularStrength_; }
252 virtual void setSpecularStrength( float specularStrength ) { specularStrength_ = specularStrength; needRedraw_ = true; }
253
255 float getAmbientStrength() const { return ambientStrength_; }
257 virtual void setAmbientStrength( float ambientStrength ) { ambientStrength_ = ambientStrength; needRedraw_ = true; }
258
259 [[deprecated( "please use ObjectLabel mechanism instead" )]]
260 const std::vector<PositionedText>& getLabels() const { return labels_; }
261 [[deprecated( "please use ObjectLabel mechanism instead" )]]
262 virtual void setLabels( std::vector<PositionedText> labels ) { labels_ = std::move( labels ); needRedraw_ = true; }
263
266 MRMESH_API virtual std::shared_ptr<Object> clone() const override;
269 MRMESH_API virtual std::shared_ptr<Object> shallowClone() const override;
270
273 MRMESH_API virtual bool render( const ModelRenderParams& ) const;
275 MRMESH_API virtual void renderForPicker( const ModelBaseRenderParams&, unsigned ) const;
277 MRMESH_API virtual void renderUi( const UiRenderParams& params ) const;
278
281
283 [[nodiscard]] MRMESH_API virtual size_t heapBytes() const override;
285 MRMESH_API virtual std::vector<std::string> getInfoLines() const override;
286
289 [[nodiscard]] MRMESH_API bool useDefaultScenePropertiesOnDeserialization() const { return useDefaultScenePropertiesOnDeserialization_; }
292 MRMESH_API void setUseDefaultScenePropertiesOnDeserialization( bool useDefaultScenePropertiesOnDeserialization )
293 { useDefaultScenePropertiesOnDeserialization_ = useDefaultScenePropertiesOnDeserialization; }
294
295protected:
296 VisualObject( const VisualObject& obj ) = default;
297
299 MRMESH_API virtual void swapBase_( Object& other ) override;
300
303 virtual void setupRenderObject_() const {}
304
306
313 ViewportMask cropLabels_ = ViewportMask::all();
314 ViewportMask pickable_ = ViewportMask::all();
316 ViewportMask depthTest_ = ViewportMask::all();
317
318 ViewportProperty<Color> labelsColor_ = {};
319
320 float shininess_{35.0f};
321 float specularStrength_{ 0.5f }; // reflection intensity
322 float ambientStrength_{ 0.1f }; //non - directional light intensity
323
325 ColoringType coloringType_{ColoringType::SolidColor};
329 ViewportProperty<uint8_t> globalAlpha_{ 255 };
330
331 std::vector<PositionedText> labels_;
332
333 bool useDefaultScenePropertiesOnDeserialization_{ false };
334
336
337 MRMESH_API virtual void serializeFields_( Json::Value& root ) const override;
338
339 MRMESH_API void deserializeFields_( const Json::Value& root ) override;
340
341 virtual Box3f computeBoundingBox_() const { return Box3f(); }
342
344 MRMESH_API void boundingBoxToInfoLines_( std::vector<std::string> & res ) const;
345
346 MRMESH_API virtual void setAllVisualizeProperties_( const AllVisualizeProperties& properties, std::size_t& pos );
347
348 // Derived classes should use this to implement `setAllVisualizeProperties()`.
349 template <AnyVisualizeMaskEnumType T>
350 void setAllVisualizePropertiesForEnum( const AllVisualizeProperties& properties, std::size_t& pos )
351 {
352 for ( int i = 0; i < int( T::_count ); i++ )
353 setVisualizePropertyMask( T( i ), properties[pos++] );
354 }
355 // Derived classes should use this to implement `getAllVisualizeProperties()`.
356 template <AnyVisualizeMaskEnumType T>
358 {
359 properties.reserve( properties.size() + std::size_t( T::_count ) );
360 for ( int i = 0; i < int( ( T::_count ) ); i++ )
361 properties.push_back( getVisualizePropertyMask( T( i ) ) );
362 }
363
364private:
365 mutable Dirty dirty_; // private dirty, to force all using setDirtyFlags, instead of direct change
366
367 mutable Box3f boundingBoxCache_;
368
370 void setDefaultColors_();
371
373 void setDefaultSceneProperties_();
374};
375
377
378} // namespace MR
#define MRMESH_API
Definition MRMesh/MRMeshFwd.h:79
#define MRMESH_CLASS
Definition MRMesh/MRMeshFwd.h:83
InvertedNormals
Definition MRVisualObject.h:24
Visibility
Definition MRVisualObject.h:23
ClippedByPlane
Definition MRVisualObject.h:28
CropLabelsByViewportRect
Definition MRVisualObject.h:27
Labels
Definition MRVisualObject.h:26
Name
Definition MRVisualObject.h:25
DepthTest
Definition MRVisualObject.h:29
Definition MRVisualObject.h:57
AnyVisualizeMaskEnum(T value)
Definition MRVisualObject.h:63
std::optional< T > tryGet() const
Definition MRVisualObject.h:66
named object in the data model
Definition MRObject.h:60
Definition MRViewportId.h:16
stores mask of viewport unique identifiers
Definition MRViewportId.h:38
Definition MRViewportProperty.h:17
Visual Object.
Definition MRVisualObject.h:121
MRMESH_API bool useDefaultScenePropertiesOnDeserialization() const
Definition MRVisualObject.h:289
virtual MRMESH_API const ViewportProperty< Color > & getFrontColorsForAllViewports(bool selected=true) const
returns color of object when it is selected/not-selected (depending on argument) in all viewports
virtual bool getRedrawFlag(ViewportMask viewportMask) const override
returns true if the object must be redrawn (due to dirty flags) in one of specified viewports
Definition MRVisualObject.h:226
virtual MRMESH_API void setFrontColor(const Color &color, bool selected, ViewportId viewportId={})
sets color of object when it is selected/not-selected (depending on argument) in given viewport
MRMESH_API ViewportMask & getVisualizePropertyMask_(AnyVisualizeMaskEnum type)
ViewportMask showLabels_
Definition MRVisualObject.h:311
MRMESH_API void setUseDefaultScenePropertiesOnDeserialization(bool useDefaultScenePropertiesOnDeserialization)
Definition MRVisualObject.h:292
VisualObject(ProtectedStruct, const VisualObject &obj)
this ctor is public only for std::make_shared used inside clone()
Definition MRVisualObject.h:280
virtual MRMESH_API bool supportsVisualizeProperty(AnyVisualizeMaskEnum type) const
Returns true if this class supports the property type. Otherwise passing it to the functions below is...
virtual MRMESH_API void renderForPicker(const ModelBaseRenderParams &, unsigned) const
draws this object for picking
float getShininess() const
returns the current shininess visual value
Definition MRVisualObject.h:245
virtual MRMESH_API size_t heapBytes() const override
returns the amount of memory this object occupies on heap
MRMESH_API VisualObject()
virtual MRMESH_API std::shared_ptr< Object > clone() const override
MRMESH_API void setVisualizeProperty(bool value, AnyVisualizeMaskEnum type, ViewportMask viewportMask)
set visual property in all viewports specified by the mask
MRMESH_API const ViewportProperty< Color > & getLabelsColorsForAllViewports() const
MRMESH_API void resetDirty() const
resets all dirty flags (except for cache flags that will be reset automatically on cache update)
virtual MRMESH_API Box3f getWorldBox(ViewportId={}) const override
virtual ~VisualObject()=default
MRMESH_API bool getVisualizeProperty(AnyVisualizeMaskEnum type, ViewportMask viewportMask) const
returns true if the property is set at least in one viewport specified by the mask
virtual MRMESH_API void setDirtyFlags(uint32_t mask, bool invalidateCaches=true)
virtual MRMESH_API const ViewportProperty< uint8_t > & getGlobalAlphaForAllViewports() const
returns global transparency alpha of object in all viewports
MRMESH_API const Color & getLabelsColor(ViewportId viewportId={}) const
void getAllVisualizePropertiesForEnum(AllVisualizeProperties &properties) const
Definition MRVisualObject.h:357
virtual void setSpecularStrength(float specularStrength)
sets intensity of reflections
Definition MRVisualObject.h:252
virtual MRMESH_API void setBackColor(const Color &color, ViewportId viewportId={})
sets backward color of object in given viewport
static constexpr const char * TypeName() noexcept
Definition MRVisualObject.h:129
virtual Box3f computeBoundingBox_() const
Definition MRVisualObject.h:341
virtual MRMESH_API bool render(const ModelRenderParams &) const
bool showLabels() const
Definition MRVisualObject.h:161
ViewportProperty< Color > unselectedColor_
Definition MRVisualObject.h:327
virtual MRMESH_API void setLabelsColorsForAllViewports(ViewportProperty< Color > val)
virtual MRMESH_API void setAllVisualizeProperties_(const AllVisualizeProperties &properties, std::size_t &pos)
ViewportMask showName_
Definition MRVisualObject.h:312
MRMESH_API uint32_t getDirtyFlags() const
returns current dirty flags for the object
Definition MRVisualObject.h:214
std::string getClassNameInPlural() const override
return human readable name of subclass in plural form
Definition MRVisualObject.h:133
MRMESH_API void deserializeFields_(const Json::Value &root) override
virtual MRMESH_API void setBackColorsForAllViewports(ViewportProperty< Color > val)
sets backward color of object in all viewports
virtual MRMESH_API void setLabelsColor(const Color &color, ViewportId viewportId={})
virtual const char * typeName() const override
Definition MRVisualObject.h:130
bool showName() const
returns whether object name is shown in any viewport
Definition MRVisualObject.h:166
MRMESH_API const Color & getFrontColor(bool selected=true, ViewportId viewportId={}) const
returns color of object when it is selected/not-selected (depending on argument) in given viewport
virtual MRMESH_API const ViewportProperty< Color > & getBackColorsForAllViewports() const
returns backward color of object in all viewports
float getSpecularStrength() const
returns intensity of reflections
Definition MRVisualObject.h:250
virtual MRMESH_API std::vector< std::string > getInfoLines() const override
return several info lines that can better describe the object in the UI
virtual MRMESH_API void swapBase_(Object &other) override
swaps this object with other
virtual MRMESH_API void renderUi(const UiRenderParams &params) const
draws this object for 2d UI
VisualObject(const VisualObject &obj)=default
virtual MRMESH_API void resetDirtyExceptMask(uint32_t mask) const
reset dirty flags without some specific bits (useful for lazy normals update)
virtual MRMESH_API void setGlobalAlphaForAllViewports(ViewportProperty< uint8_t > val)
sets global transparency alpha of object in all viewports
void showLabels(bool on)
shows/hides labels
Definition MRVisualObject.h:159
virtual void setupRenderObject_() const
Definition MRVisualObject.h:303
virtual MRMESH_API void setColoringType(ColoringType coloringType)
sets coloring mode of the object with given argument
MRMESH_API Box3f getBoundingBox() const
returns cached bounding box of this object in local coordinates
virtual void setAmbientStrength(float ambientStrength)
sets intensity of non-directional light
Definition MRVisualObject.h:257
bool isPickable(ViewportMask viewportMask=ViewportMask::any()) const
whether the object can be picked (by mouse) in any of given viewports
Definition MRVisualObject.h:234
virtual MRMESH_API const ViewportMask & getVisualizePropertyMask(AnyVisualizeMaskEnum type) const
returns mask of viewports where given property is set
VisualObject(VisualObject &&)=default
virtual MRMESH_API void setGlobalAlpha(uint8_t alpha, ViewportId viewportId={})
sets global transparency alpha of object in given viewport
void setAllVisualizeProperties(const AllVisualizeProperties &properties)
set all visualize properties masks
Definition MRVisualObject.h:151
void showName(bool on)
shows/hides object name in all viewports
Definition MRVisualObject.h:164
void setAllVisualizePropertiesForEnum(const AllVisualizeProperties &properties, std::size_t &pos)
Definition MRVisualObject.h:350
virtual MRMESH_API void serializeFields_(Json::Value &root) const override
std::vector< PositionedText > labels_
Definition MRVisualObject.h:331
UniquePtr< IRenderObject > renderObj_
Definition MRVisualObject.h:305
virtual MRMESH_API AllVisualizeProperties getAllVisualizeProperties() const
get all visualize properties masks
ViewportMask clipByPlane_
Definition MRVisualObject.h:310
virtual void setLabels(std::vector< PositionedText > labels)
Definition MRVisualObject.h:262
std::string getClassName() const override
return human readable name of subclass
Definition MRVisualObject.h:132
ViewportProperty< Color > selectedColor_
Definition MRVisualObject.h:326
virtual MRMESH_API void setFrontColorsForAllViewports(ViewportProperty< Color > val, bool selected=true)
sets color of object when it is selected/not-selected (depending on argument) in all viewports
virtual MRMESH_API void setVisualizePropertyMask(AnyVisualizeMaskEnum type, ViewportMask viewportMask)
set visual property mask
ColoringType getColoringType() const
returns the current coloring mode of the object
Definition MRVisualObject.h:239
virtual MRMESH_API void setPickable(bool on, ViewportMask viewportMask=ViewportMask::all())
sets the object as can/cannot be picked (by mouse) in all of given viewports
virtual void setShininess(float shininess)
sets shininess visual value of the object with given argument
Definition MRVisualObject.h:247
virtual MRMESH_API std::shared_ptr< Object > shallowClone() const override
ViewportProperty< Color > backFacesColor_
Definition MRVisualObject.h:328
const std::vector< PositionedText > & getLabels() const
Definition MRVisualObject.h:260
MRMESH_API const Color & getBackColor(ViewportId viewportId={}) const
returns backward color of object in given viewport
MRMESH_API void toggleVisualizeProperty(AnyVisualizeMaskEnum type, ViewportMask viewportMask)
toggle visual property in all viewports specified by the mask
ViewportMask invertNormals_
invert mesh normals
Definition MRVisualObject.h:315
MRMESH_API void boundingBoxToInfoLines_(std::vector< std::string > &res) const
adds information about bounding box in res
float getAmbientStrength() const
returns intensity of non-directional light
Definition MRVisualObject.h:255
MRMESH_API const uint8_t & getGlobalAlpha(ViewportId viewportId={}) const
returns global transparency alpha of object in given viewport
Definition MRVisualObject.h:40
DirtyFlags
Definition MRVisualObject.h:78
std::vector< ViewportMask > AllVisualizeProperties
Definition MRVisualObject.h:75
@ DIRTY_PRIMITIVE_COLORMAP
Definition MRVisualObject.h:91
@ DIRTY_POSITION
Definition MRVisualObject.h:80
@ DIRTY_TEXTURE
Definition MRVisualObject.h:87
@ DIRTY_NONE
Definition MRVisualObject.h:79
@ DIRTY_SELECTION
Definition MRVisualObject.h:86
@ DIRTY_FACES_RENDER_NORMAL
gl normals
Definition MRVisualObject.h:83
@ DIRTY_MESH
Definition MRVisualObject.h:94
@ DIRTY_FACES_COLORMAP
Definition MRVisualObject.h:92
@ DIRTY_TEXTURE_PER_FACE
Definition MRVisualObject.h:93
@ DIRTY_FACE
Definition MRVisualObject.h:89
@ DIRTY_EDGES_SELECTION
Definition MRVisualObject.h:97
@ DIRTY_VERTS_COLORMAP
Definition MRVisualObject.h:90
@ DIRTY_RENDER_NORMALS
Definition MRVisualObject.h:85
@ DIRTY_BORDER_LINES
Definition MRVisualObject.h:96
@ DIRTY_ALL
Definition MRVisualObject.h:99
@ DIRTY_VERTS_RENDER_NORMAL
Definition MRVisualObject.h:82
@ DIRTY_CACHES
Definition MRVisualObject.h:98
@ DIRTY_UV
Definition MRVisualObject.h:81
@ DIRTY_PRIMITIVES
Definition MRVisualObject.h:88
@ DIRTY_BOUNDING_BOX
Definition MRVisualObject.h:95
@ DIRTY_CORNERS_RENDER_NORMAL
gl normals
Definition MRVisualObject.h:84
ColoringType
Definition MREnums.h:54
Definition MRMesh/MRColor.h:9
Definition MRVisualObject.h:106
Dirty() noexcept=default
uint32_t f
Definition MRVisualObject.h:107
Dirty & operator=(const Dirty &) noexcept
Definition MRVisualObject.h:114
Dirty(Dirty &&) noexcept=default
Definition MRVisualObject.h:35
Definition MRIRenderObject.h:43
Mesh rendering parameters for primary rendering (as opposed to the picker).
Definition MRIRenderObject.h:51
Definition MRObject.h:262
Definition MRIRenderObject.h:107
Definition MRUniquePtr.h:12