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 "MRIRenderObject.h"
8#include "MRUniquePtr.h"
9#include "MREnums.h"
10
11namespace MR
12{
13
17
18// Note! Must use `MRMESH_CLASS` on this enum and all enums that extend this one,
19// otherwise you'll get silent wrong behavior on Mac.
20enum class MRMESH_CLASS VisualizeMaskType
21{
27 _count [[maybe_unused]],
28};
29
30// If a type derived from `VisualObject` wants to extend `VisualizeMaskType`, it must create a separate enum and specialize this to `true` for it.
31// NOTE! All those enums can start from 0, don't worry about collisions.
32template <typename T> struct IsVisualizeMaskEnum : std::false_type {};
33template <> struct IsVisualizeMaskEnum<VisualizeMaskType> : std::true_type {};
34
35// Wraps `IsVisualizeMaskEnum` and adds some sanity checks.
36template <typename T>
38 IsVisualizeMaskEnum<T>::value &&
39 std::is_same_v<std::underlying_type_t<T>, int> &&
40 std::is_same_v<T, std::remove_cvref_t<T>>;
41
42// Stores a `VisualizeMaskType` or any other enum that extends it (i.e. which specializes `IsVisualizeMaskEnum`).
43// To extract the value, do this:
44// if ( auto value = x.tryGet<MyEnum>() )
45// {
46// switch ( *value )
47// {
48// case MyEnum::foo: ...
49// case MyEnum::bar: ...
50// }
51// }
52// else // forward to the parent class
54{
55 std::type_index type_;
56 int value_ = 0;
57
58public:
59 template <AnyVisualizeMaskEnumType T>
60 AnyVisualizeMaskEnum( T value ) : type_( typeid(T) ), value_( decltype(value_)( value ) ) {}
61
62 template <AnyVisualizeMaskEnumType T>
63 [[nodiscard]] std::optional<T> tryGet() const
64 {
65 if ( type_ == typeid(T) )
66 return T( value_ );
67 else
68 return {};
69 }
70};
71
72using AllVisualizeProperties = std::vector<ViewportMask>;
73
99
103struct Dirty
104{
105 uint32_t f{DIRTY_ALL};
106 operator uint32_t&() { return f; }
107 operator uint32_t() const { return f; }
108
109 Dirty() noexcept = default;
110 Dirty( const Dirty& ) noexcept {}
111 Dirty( Dirty&& ) noexcept = default;
112 Dirty& operator =( const Dirty& ) noexcept { return *this; }
113 Dirty& operator =( Dirty&& ) noexcept = default;
114 Dirty& operator =( uint32_t b ) noexcept { f = b; return *this; }
115};
116
119{
120public:
122
124 VisualObject& operator = ( VisualObject&& ) = default;
125 virtual ~VisualObject() = default;
126
127 constexpr static const char* TypeName() noexcept { return "VisualObject"; }
128 virtual const char* typeName() const override { return TypeName(); }
129
130 constexpr static const char* ClassName() noexcept { return "Visual Object"; }
131 virtual std::string className() const override { return ClassName(); }
132
133 constexpr static const char* ClassNameInPlural() noexcept { return "Visual Objects"; }
134 virtual std::string classNameInPlural() const override { return ClassNameInPlural(); }
135
137 [[nodiscard]] MRMESH_API virtual bool supportsVisualizeProperty( AnyVisualizeMaskEnum type ) const;
139 MRMESH_API void setVisualizeProperty( bool value, AnyVisualizeMaskEnum type, ViewportMask viewportMask );
148
153 {
154 std::size_t counter = 0;
155 setAllVisualizeProperties_( properties, counter );
156 }
157
160
162 [[nodiscard]] bool globalClippedByPlane( ViewportMask viewportMask = ViewportMask::any() ) const { return !( globalClippedByPlaneMask() & viewportMask ).empty(); }
163
165 MRMESH_API void setGlobalClippedByPlane( bool on, ViewportMask viewportMask = ViewportMask::all() );
166
168 void showName( bool on ) { return setVisualizeProperty( on, VisualizeMaskType::Name, ViewportMask::all() ); }
170 bool showName() const { return getVisualizeProperty( VisualizeMaskType::Name, ViewportMask::any() ); }
171
173 MRMESH_API const Color& getFrontColor( bool selected = true, ViewportId viewportId = {} ) const;
175 MRMESH_API virtual void setFrontColor( const Color& color, bool selected, ViewportId viewportId = {} );
176
178 MRMESH_API virtual const ViewportProperty<Color>& getFrontColorsForAllViewports( bool selected = true ) const;
180 MRMESH_API virtual void setFrontColorsForAllViewports( ViewportProperty<Color> val, bool selected = true );
181
186
188 MRMESH_API const Color& getBackColor( ViewportId viewportId = {} ) const;
190 MRMESH_API virtual void setBackColor( const Color& color, ViewportId viewportId = {} );
191
193 MRMESH_API const uint8_t& getGlobalAlpha( ViewportId viewportId = {} ) const;
195 MRMESH_API virtual void setGlobalAlpha( uint8_t alpha, ViewportId viewportId = {} );
196
201
205 MRMESH_API virtual void setDirtyFlags( uint32_t mask, bool invalidateCaches = true );
207 MRMESH_API uint32_t getDirtyFlags() const { return dirty_; }
209 MRMESH_API void resetDirty() const;
211 MRMESH_API virtual void resetDirtyExceptMask( uint32_t mask ) const;
212
217 MRMESH_API virtual Box3f getWorldBox( ViewportId = {} ) const override;
219 virtual bool getRedrawFlag( ViewportMask viewportMask ) const override
220 {
221 return Object::getRedrawFlag( viewportMask ) ||
222 ( isVisible( viewportMask ) &&
223 ( dirty_ & ( ~( DIRTY_CACHES ) ) ) );
224 }
225
227 bool isPickable( ViewportMask viewportMask = ViewportMask::any() ) const{return !(pickable_ & viewportMask).empty();}
229 MRMESH_API virtual void setPickable( bool on, ViewportMask viewportMask = ViewportMask::all() );
230
232 ColoringType getColoringType() const { return coloringType_; }
233
235 MRMESH_API virtual void setColoringType( ColoringType coloringType );
236
238 float getShininess() const { return shininess_; }
240 virtual void setShininess( float shininess ) { shininess_ = shininess; needRedraw_ = true; }
241
243 float getSpecularStrength() const { return specularStrength_; }
245 virtual void setSpecularStrength( float specularStrength ) { specularStrength_ = specularStrength; needRedraw_ = true; }
246
248 float getAmbientStrength() const { return ambientStrength_; }
250 virtual void setAmbientStrength( float ambientStrength ) { ambientStrength_ = ambientStrength; needRedraw_ = true; }
251
254 MRMESH_API virtual std::shared_ptr<Object> clone() const override;
257 MRMESH_API virtual std::shared_ptr<Object> shallowClone() const override;
258
261 MRMESH_API virtual bool render( const ModelRenderParams& ) const;
263 MRMESH_API virtual void renderForPicker( const ModelBaseRenderParams&, unsigned ) const;
265 MRMESH_API virtual void renderUi( const UiRenderParams& params ) const;
266
269
271 [[nodiscard]] MRMESH_API virtual size_t heapBytes() const override;
273 MRMESH_API virtual std::vector<std::string> getInfoLines() const override;
274
277 [[nodiscard]] MRMESH_API bool useDefaultScenePropertiesOnDeserialization() const { return useDefaultScenePropertiesOnDeserialization_; }
280 MRMESH_API void setUseDefaultScenePropertiesOnDeserialization( bool useDefaultScenePropertiesOnDeserialization )
281 { useDefaultScenePropertiesOnDeserialization_ = useDefaultScenePropertiesOnDeserialization; }
282
286 MRMESH_API virtual void resetColors();
287
288protected:
289 VisualObject( const VisualObject& obj ) = default;
290
292 MRMESH_API virtual void swapBase_( Object& other ) override;
293
296 virtual void setupRenderObject_() const {}
297
299
305 ViewportMask pickable_ = ViewportMask::all();
307 ViewportMask depthTest_ = ViewportMask::all();
308
309 float shininess_{35.0f};
310 float specularStrength_{ 0.5f }; // reflection intensity
311 float ambientStrength_{ 0.1f }; //non - directional light intensity
312
314 ColoringType coloringType_{ColoringType::SolidColor};
318 ViewportProperty<uint8_t> globalAlpha_{ 255 };
319
320 bool useDefaultScenePropertiesOnDeserialization_{ false };
321
323
324 MRMESH_API virtual void serializeFields_( Json::Value& root ) const override;
325
326 MRMESH_API void deserializeFields_( const Json::Value& root ) override;
327
328 virtual Box3f computeBoundingBox_() const { return Box3f(); }
329
331 MRMESH_API void boundingBoxToInfoLines_( std::vector<std::string> & res ) const;
332
333 MRMESH_API virtual void setAllVisualizeProperties_( const AllVisualizeProperties& properties, std::size_t& pos );
334
335 // Derived classes should use this to implement `setAllVisualizeProperties()`.
336 template <AnyVisualizeMaskEnumType T>
337 void setAllVisualizePropertiesForEnum( const AllVisualizeProperties& properties, std::size_t& pos )
338 {
339 for ( int i = 0; i < int( T::_count ); i++ )
340 setVisualizePropertyMask( T( i ), properties[pos++] );
341 }
342 // Derived classes should use this to implement `getAllVisualizeProperties()`.
343 template <AnyVisualizeMaskEnumType T>
345 {
346 properties.reserve( properties.size() + std::size_t( T::_count ) );
347 for ( int i = 0; i < int( ( T::_count ) ); i++ )
348 properties.push_back( getVisualizePropertyMask( T( i ) ) );
349 }
350
351private:
352 mutable Dirty dirty_; // private dirty, to force all using setDirtyFlags, instead of direct change
353
354 mutable Box3f boundingBoxCache_;
355
357 void setDefaultColors_();
358
360 void setDefaultSceneProperties_();
361};
362
364
365} // namespace MR
#define MRMESH_API
Definition MRMesh/MRMeshFwd.h:80
#define MRMESH_CLASS
Definition MRMesh/MRMeshFwd.h:84
InvertedNormals
Definition MRVisualObject.h:23
Visibility
Definition MRVisualObject.h:22
ClippedByPlane
Definition MRVisualObject.h:25
Name
Definition MRVisualObject.h:24
DepthTest
Definition MRVisualObject.h:26
Definition MRVisualObject.h:54
AnyVisualizeMaskEnum(T value)
Definition MRVisualObject.h:60
std::optional< T > tryGet() const
Definition MRVisualObject.h:63
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
MRMESH_API bool useDefaultScenePropertiesOnDeserialization() const
Definition MRVisualObject.h:277
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:219
virtual MRMESH_API void resetColors()
reset all object colors to their default values from the current theme
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
static constexpr const char * ClassNameInPlural() noexcept
Definition MRVisualObject.h:133
MRMESH_API ViewportMask & getVisualizePropertyMask_(AnyVisualizeMaskEnum type)
MRMESH_API void setUseDefaultScenePropertiesOnDeserialization(bool useDefaultScenePropertiesOnDeserialization)
Definition MRVisualObject.h:280
VisualObject(ProtectedStruct, const VisualObject &obj)
this ctor is public only for std::make_shared used inside clone()
Definition MRVisualObject.h:268
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
static constexpr const char * ClassName() noexcept
Definition MRVisualObject.h:130
float getShininess() const
returns the current shininess visual value
Definition MRVisualObject.h:238
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 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
void getAllVisualizePropertiesForEnum(AllVisualizeProperties &properties) const
Definition MRVisualObject.h:344
virtual void setSpecularStrength(float specularStrength)
sets intensity of reflections
Definition MRVisualObject.h:245
virtual MRMESH_API void setBackColor(const Color &color, ViewportId viewportId={})
sets backward color of object in given viewport
virtual std::string classNameInPlural() const override
Definition MRVisualObject.h:134
static constexpr const char * TypeName() noexcept
Definition MRVisualObject.h:127
virtual std::string className() const override
Definition MRVisualObject.h:131
virtual Box3f computeBoundingBox_() const
Definition MRVisualObject.h:328
virtual MRMESH_API bool render(const ModelRenderParams &) const
ViewportProperty< Color > unselectedColor_
Definition MRVisualObject.h:316
bool globalClippedByPlane(ViewportMask viewportMask=ViewportMask::any()) const
returns true if this object or any of its parents is clipped by plane in any of given viewports
Definition MRVisualObject.h:162
virtual MRMESH_API void setAllVisualizeProperties_(const AllVisualizeProperties &properties, std::size_t &pos)
ViewportMask showName_
Definition MRVisualObject.h:304
MRMESH_API void setGlobalClippedByPlane(bool on, ViewportMask viewportMask=ViewportMask::all())
if false deactivates clipped-by-plane for this object and all of its parents, otherwise sets clipped-...
MRMESH_API uint32_t getDirtyFlags() const
returns current dirty flags for the object
Definition MRVisualObject.h:207
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 const char * typeName() const override
Definition MRVisualObject.h:128
bool showName() const
returns whether object name is shown in any viewport
Definition MRVisualObject.h:170
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:243
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
virtual void setupRenderObject_() const
Definition MRVisualObject.h:296
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:250
bool isPickable(ViewportMask viewportMask=ViewportMask::any()) const
whether the object can be picked (by mouse) in any of given viewports
Definition MRVisualObject.h:227
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:152
void showName(bool on)
shows/hides object name in all viewports
Definition MRVisualObject.h:168
void setAllVisualizePropertiesForEnum(const AllVisualizeProperties &properties, std::size_t &pos)
Definition MRVisualObject.h:337
virtual MRMESH_API void serializeFields_(Json::Value &root) const override
UniquePtr< IRenderObject > renderObj_
Definition MRVisualObject.h:298
virtual MRMESH_API AllVisualizeProperties getAllVisualizeProperties() const
get all visualize properties masks
ViewportMask clipByPlane_
Definition MRVisualObject.h:303
ViewportProperty< Color > selectedColor_
Definition MRVisualObject.h:315
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:232
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:240
virtual MRMESH_API std::shared_ptr< Object > shallowClone() const override
ViewportProperty< Color > backFacesColor_
Definition MRVisualObject.h:317
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:306
MRMESH_API void boundingBoxToInfoLines_(std::vector< std::string > &res) const
adds information about bounding box in res
MRMESH_API ViewportMask globalClippedByPlaneMask() const
returns all viewports where this object or any of its parents is clipped by plane
virtual MRMESH_API void resetFrontColor()
reset basic object colors to their default values from the current theme
float getAmbientStrength() const
returns intensity of non-directional light
Definition MRVisualObject.h:248
MRMESH_API const uint8_t & getGlobalAlpha(ViewportId viewportId={}) const
returns global transparency alpha of object in given viewport
Definition MRVisualObject.h:37
DirtyFlags
Definition MRVisualObject.h:75
std::vector< ViewportMask > AllVisualizeProperties
Definition MRVisualObject.h:72
@ DIRTY_PRIMITIVE_COLORMAP
Definition MRVisualObject.h:88
@ DIRTY_POSITION
Definition MRVisualObject.h:77
@ DIRTY_TEXTURE
Definition MRVisualObject.h:84
@ DIRTY_NONE
Definition MRVisualObject.h:76
@ DIRTY_SELECTION
Definition MRVisualObject.h:83
@ DIRTY_FACES_RENDER_NORMAL
gl normals
Definition MRVisualObject.h:80
@ DIRTY_MESH
Definition MRVisualObject.h:91
@ DIRTY_FACES_COLORMAP
Definition MRVisualObject.h:89
@ DIRTY_TEXTURE_PER_FACE
Definition MRVisualObject.h:90
@ DIRTY_FACE
Definition MRVisualObject.h:86
@ DIRTY_EDGES_SELECTION
Definition MRVisualObject.h:94
@ DIRTY_VERTS_COLORMAP
Definition MRVisualObject.h:87
@ DIRTY_RENDER_NORMALS
Definition MRVisualObject.h:82
@ DIRTY_BORDER_LINES
Definition MRVisualObject.h:93
@ DIRTY_ALL
Definition MRVisualObject.h:97
@ DIRTY_VOLUME
Definition MRVisualObject.h:96
@ DIRTY_VERTS_RENDER_NORMAL
Definition MRVisualObject.h:79
@ DIRTY_CACHES
Definition MRVisualObject.h:95
@ DIRTY_UV
Definition MRVisualObject.h:78
@ DIRTY_PRIMITIVES
Definition MRVisualObject.h:85
@ DIRTY_BOUNDING_BOX
Definition MRVisualObject.h:92
@ DIRTY_CORNERS_RENDER_NORMAL
gl normals
Definition MRVisualObject.h:81
Definition MRCameraOrientationPlugin.h:8
ColoringType
Definition MREnums.h:56
Definition MRMesh/MRColor.h:9
Definition MRVisualObject.h:104
Dirty() noexcept=default
uint32_t f
Definition MRVisualObject.h:105
Dirty & operator=(const Dirty &) noexcept
Definition MRVisualObject.h:112
Dirty(Dirty &&) noexcept=default
Definition MRVisualObject.h:32
Definition MRIRenderObject.h:43
Mesh rendering parameters for primary rendering (as opposed to the picker).
Definition MRIRenderObject.h:51
Definition MRObject.h:279
Definition MRIRenderObject.h:107
Definition MRUniquePtr.h:12