MeshLib C++ Docs
Loading...
Searching...
No Matches
MRIRenderObject.h
Go to the documentation of this file.
1#pragma once
3#include "MRPch/MRBindingMacros.h"
5#include "MRMeshFwd.h"
6#include "MRViewportId.h"
7#include "MRVector2.h"
8#include "MRVector4.h"
9#include "MRAffineXf3.h"
10#include <functional>
11#include <typeindex>
12#include <memory>
13
14namespace MR
15{
16
17enum class DepthFunction
18{
19 Never = 0,
20 Less = 1,
21 Equal = 2,
22 Greater = 4,
27 Default = 8 // usually "Less" but may differ for different object types
28};
30
31
33{
34 const Matrix4f& viewMatrix;
35 const Matrix4f& projMatrix;
36 ViewportId viewportId; // id of the viewport
37 Vector4i viewport; // viewport x0, y0, width, height
38};
39
43{
44 const Matrix4f& modelMatrix;
45 const Plane3f& clipPlane; // viewport clip plane (it is not applied while object does not have clipping flag set)
47};
48
51{
52 const Matrix4f* normMatrixPtr{ nullptr }; // normal matrix, only necessary for triangles rendering
53 Vector3f lightPos; // position of light source
54 bool allowAlphaSort{ false }; // if true, the object can use the alpha sorting shader if it wants to
55
56 RenderModelPassMask passMask = RenderModelPassMask::All; // Only perform rendering if `bool( passMask & desiredPass )` is true.
57};
58
61{
62 virtual ~BasicUiRenderTask() = default;
63
64 BasicUiRenderTask() = default;
69
71 float renderTaskDepth = 0;
72
73 enum class InteractionMask
74 {
75 mouseHover = 1 << 0,
76 mouseScroll = 1 << 1,
77 };
79
81 {
82 // Which interactions should be blocked by this object.
83 // This is passed along between all `renderUi()` calls in a single frame, and then the end result is used.
84 mutable InteractionMask consumedInteractions{};
85
86 // If nothing else is hovered, this returns true and writes `mouseHover` to `consumedInteractions`.
87 [[nodiscard]] bool tryConsumeMouseHover() const
88 {
89 if ( !bool( consumedInteractions & InteractionMask::mouseHover ) )
90 {
91 consumedInteractions |= InteractionMask::mouseHover;
92 return true;
93 }
94 return false;
95 }
96 };
97
100 virtual void earlyBackwardPass( const BackwardPassParams& params ) { (void)params; }
101
103 virtual void renderPass() = 0;
104};
105
107{
108 using UiTaskList = std::vector<std::shared_ptr<BasicUiRenderTask>>;
109
110 // Those are Z-sorted and then executed.
111 UiTaskList* tasks = nullptr;
112};
113
115{
116 virtual ~UiRenderManager() = default;
117
118 // This is called before doing `IRenderObject::renderUi()` on even object in a viewport. Each viewport is rendered separately.
119 virtual void preRenderViewport( ViewportId viewport ) { (void)viewport; }
120 // This is called after doing `IRenderObject::renderUi()` on even object in a viewport. Each viewport is rendered separately.
121 virtual void postRenderViewport( ViewportId viewport ) { (void)viewport; }
122
123 // Returns the parameters for the `IRenderObject::earlyBackwardPass()`.
124 // This will be called exactly once per viewport, each time the UI in it is rendered.
125 virtual BasicUiRenderTask::BackwardPassParams beginBackwardPass( ViewportId viewport, UiRenderParams::UiTaskList& tasks ) { (void)viewport; (void)tasks; return {}; }
126 // After the backward pass is performed, the parameters should be passed back into this function.
127 virtual void finishBackwardPass( ViewportId viewport, const BasicUiRenderTask::BackwardPassParams& params ) { (void)viewport, (void)params; }
128};
129
131{
132public:
133 virtual ~IRenderObject() = default;
134
135 // These functions do:
136 // 1) bind data
137 // 2) pass shaders arguments
138 // 3) draw data
139
140 // Returns true if something was rendered, or false if nothing to render.
141 virtual bool render( const ModelRenderParams& params ) = 0;
142 virtual void renderPicker( const ModelBaseRenderParams& params, unsigned geomId ) = 0;
144 virtual size_t heapBytes() const = 0;
146 virtual size_t glBytes() const = 0;
148 virtual void forceBindAll() {}
149
154 virtual void renderUi( const UiRenderParams& params ) { (void)params; }
155};
156// Those dummy definitions remove undefined references in `RenderObjectCombinator` when it calls non-overridden pure virtual methods.
157// We could check in `RenderObjectCombinator` if they're overridden or not, but it's easier to just define them.
158inline bool IRenderObject::render( const ModelRenderParams& ) { return false; }
159inline void IRenderObject::renderPicker( const ModelBaseRenderParams&, unsigned ) {}
160inline size_t IRenderObject::heapBytes() const { return 0; }
161inline size_t IRenderObject::glBytes() const { return 0; }
162
163// Combines several different `IRenderObject`s into one in a meaningful way.
164template <typename ...Bases>
165requires ( ( std::derived_from<Bases, IRenderObject> && !std::same_as<Bases, IRenderObject> ) && ... )
166class RenderObjectCombinator : public Bases...
167{
168public:
170 : Bases( object )...
171 {}
172
173 bool render( const ModelRenderParams& params ) override
174 {
175 bool ret = false;
176 // Clang 11 chokes on this if I fold from the right instead of from the left. But why?
177 (void)( ..., ( ret = Bases::render( params ) || ret ) );
178 return ret;
179 }
180 void renderPicker( const ModelBaseRenderParams& params, unsigned geomId ) override { ( Bases::renderPicker( params, geomId ), ... ); }
181 size_t heapBytes() const override { return ( std::size_t{} + ... + Bases::heapBytes() ); }
182 size_t glBytes() const override { return ( std::size_t{} + ... + Bases::glBytes() ); }
183 void forceBindAll() override { ( Bases::forceBindAll(), ... ); }
184 void renderUi( const UiRenderParams& params ) override { ( Bases::renderUi( params ), ... ); }
185};
186
187MR_BIND_IGNORE MRMESH_API std::unique_ptr<IRenderObject> createRenderObject( const VisualObject& visObj, const std::type_index& type );
188
189template<typename ObjectType>
190MR_BIND_IGNORE std::unique_ptr<IRenderObject> createRenderObject( const VisualObject& visObj )
191{
192 static_assert( std::is_base_of_v<VisualObject, std::remove_reference_t<ObjectType>>, "MR::VisualObject is not base of ObjectType" );
193 return createRenderObject( visObj, typeid( ObjectType ) );
194}
195
196using IRenderObjectConstructorLambda = std::function<std::unique_ptr<IRenderObject>( const VisualObject& )>;
197
198template<typename RenderObjType>
200{
201 return [] ( const VisualObject& visObj ) { return std::make_unique<RenderObjType>( visObj ); };
202}
203
205{
206public:
209
210private:
211 std::type_index type_;
212};
213
214#define MR_REGISTER_RENDER_OBJECT_IMPL(objectType, .../*rendObjectType*/)\
215 static MR::RegisterRenderObjectConstructor __objectRegistrator##objectType{typeid(objectType),makeRenderObjectConstructor<__VA_ARGS__>()};
216
217}
#define MR_MAKE_FLAG_OPERATORS_IN_CLASS(T)
Definition MRFlagOperators.h:9
#define MR_MAKE_FLAG_OPERATORS(T)
Definition MRFlagOperators.h:6
#define MRMESH_API
Definition MRMesh/MRMeshFwd.h:80
Definition MRIRenderObject.h:131
virtual bool render(const ModelRenderParams &params)=0
Definition MRIRenderObject.h:158
virtual void forceBindAll()
binds all data for this render object, not to bind ever again (until object becomes dirty)
Definition MRIRenderObject.h:148
virtual size_t heapBytes() const =0
returns the amount of memory this object occupies on heap
Definition MRIRenderObject.h:160
virtual void renderUi(const UiRenderParams &params)
Definition MRIRenderObject.h:154
virtual void renderPicker(const ModelBaseRenderParams &params, unsigned geomId)=0
Definition MRIRenderObject.h:159
virtual ~IRenderObject()=default
virtual size_t glBytes() const =0
returns the amount of memory this object allocated in OpenGL
Definition MRIRenderObject.h:161
Definition MRIRenderObject.h:205
MRMESH_API RegisterRenderObjectConstructor(const std::type_index &type, IRenderObjectConstructorLambda lambda)
Definition MRIRenderObject.h:167
size_t glBytes() const override
Definition MRIRenderObject.h:182
void renderUi(const UiRenderParams &params) override
Definition MRIRenderObject.h:184
size_t heapBytes() const override
Definition MRIRenderObject.h:181
bool render(const ModelRenderParams &params) override
Definition MRIRenderObject.h:173
void renderPicker(const ModelBaseRenderParams &params, unsigned geomId) override
Definition MRIRenderObject.h:180
RenderObjectCombinator(const VisualObject &object)
Definition MRIRenderObject.h:169
void forceBindAll() override
Definition MRIRenderObject.h:183
Definition MRViewportId.h:16
Visual Object.
Definition MRVisualObject.h:119
Definition MRCameraOrientationPlugin.h:8
RenderModelPassMask
Various passes of the 3D rendering.
Definition MRRenderModelParameters.h:10
std::function< std::unique_ptr< IRenderObject >(const VisualObject &)> IRenderObjectConstructorLambda
Definition MRIRenderObject.h:196
MR_BIND_IGNORE IRenderObjectConstructorLambda makeRenderObjectConstructor()
Definition MRIRenderObject.h:199
MR_BIND_IGNORE MRMESH_API std::unique_ptr< IRenderObject > createRenderObject(const VisualObject &visObj, const std::type_index &type)
DepthFunction
Definition MRIRenderObject.h:18
std::array< Vector3f, 3 > MR_BIND_IGNORE
Definition MRMeshBuilderTypes.h:10
Common rendering parameters for meshes and UI.
Definition MRIRenderObject.h:33
const Matrix4f & viewMatrix
Definition MRIRenderObject.h:34
Vector4i viewport
Definition MRIRenderObject.h:37
const Matrix4f & projMatrix
Definition MRIRenderObject.h:35
ViewportId viewportId
Definition MRIRenderObject.h:36
Definition MRIRenderObject.h:81
bool tryConsumeMouseHover() const
Definition MRIRenderObject.h:87
IRenderObject::renderUi() can emit zero or more or more of those tasks. They are sorted by depth ever...
Definition MRIRenderObject.h:61
BasicUiRenderTask()=default
virtual void renderPass()=0
This is the main rendering pass.
BasicUiRenderTask & operator=(const BasicUiRenderTask &)=default
BasicUiRenderTask(const BasicUiRenderTask &)=default
virtual void earlyBackwardPass(const BackwardPassParams &params)
Definition MRIRenderObject.h:100
float renderTaskDepth
The tasks are sorted by this depth, descending (larger depth = further away).
Definition MRIRenderObject.h:71
BasicUiRenderTask(BasicUiRenderTask &&)=default
virtual ~BasicUiRenderTask()=default
InteractionMask
Definition MRIRenderObject.h:74
BasicUiRenderTask & operator=(BasicUiRenderTask &&)=default
Definition MRIRenderObject.h:43
const Matrix4f & modelMatrix
Definition MRIRenderObject.h:44
DepthFunction depthFunction
Definition MRIRenderObject.h:46
const Plane3f & clipPlane
Definition MRIRenderObject.h:45
Mesh rendering parameters for primary rendering (as opposed to the picker).
Definition MRIRenderObject.h:51
Vector3f lightPos
Definition MRIRenderObject.h:53
RenderModelPassMask passMask
Definition MRIRenderObject.h:56
const Matrix4f * normMatrixPtr
Definition MRIRenderObject.h:52
bool allowAlphaSort
Definition MRIRenderObject.h:54
Definition MRIRenderObject.h:115
virtual ~UiRenderManager()=default
virtual BasicUiRenderTask::BackwardPassParams beginBackwardPass(ViewportId viewport, UiRenderParams::UiTaskList &tasks)
Definition MRIRenderObject.h:125
virtual void finishBackwardPass(ViewportId viewport, const BasicUiRenderTask::BackwardPassParams &params)
Definition MRIRenderObject.h:127
virtual void preRenderViewport(ViewportId viewport)
Definition MRIRenderObject.h:119
virtual void postRenderViewport(ViewportId viewport)
Definition MRIRenderObject.h:121
Definition MRIRenderObject.h:107
UiTaskList * tasks
Definition MRIRenderObject.h:111
std::vector< std::shared_ptr< BasicUiRenderTask > > UiTaskList
Definition MRIRenderObject.h:108