MeshLib C++ Docs
Loading...
Searching...
No Matches
MRViewport.h
Go to the documentation of this file.
1#pragma once
2
3#include "MRViewportGL.h"
4#include "MRFitData.h"
6#include <MRMesh/MRVector3.h>
7#include <MRMesh/MRPlane3.h>
10#include <MRMesh/MRQuaternion.h>
11#include <MRMesh/MRMatrix4.h>
12#include <MRMesh/MRColor.h>
13#include <MRMesh/MRBox.h>
14#include "MRImGui.h"
15#include <memory>
16#include <functional>
17#include <unordered_map>
18#include <optional>
19#include <span>
20
21using ObjAndPick = std::pair<std::shared_ptr<MR::VisualObject>, MR::PointOnObject>;
22using ConstObjAndPick = std::pair<std::shared_ptr<const MR::VisualObject>, MR::PointOnObject>;
23
24namespace MR
25{
26
27inline ImVec2 position( const ViewportRectangle& rect )
28{
29 return { rect.min.x, rect.min.y };
30}
31
32inline ImVec2 size( const ViewportRectangle& rect )
33{
34 return { width( rect ), height( rect ) };
35}
36
37// Conversion to Vector4 type, where:
38// x, y: min.x and min.y
39// z, w: width and height
40template<typename T>
41inline Vector4<T> toVec4( const ViewportRectangle& rect )
42{
43 return Vector4<T>{T( rect.min.x ), T( rect.min.y ), T( MR::width( rect ) ), T( MR::height( rect ) )};
44}
45
46// Viewport is a rectangular area, in which the objects of interest are going to be rendered.
47// An application can have a number of viewports each with its own ID.
49{
50public:
52
55 MRVIEWER_API static Viewport& get( ViewportId viewportId = {} );
56
57 MRVIEWER_API Viewport();
58 MRVIEWER_API ~Viewport();
59
60private: //hide copying from the user to avoid silly mistakes (copies are necessary only inside this project)
61 Viewport( const Viewport & ) = default;
62 Viewport & operator = ( const Viewport & ) = default;
63public:
64 [[nodiscard]] Viewport clone() const { return Viewport( *this ); }
65 Viewport( Viewport && ) noexcept = default;
66 Viewport & operator = ( Viewport && ) noexcept = default;
67
68 // Initialization
69 MRVIEWER_API void init();
70
71 // positive pixelXoffset -> offset from the left border
72 // negative pixelXoffset -> offset from the right border
73 // positive pixelYoffset -> offset from the top border
74 // negative pixelYoffset -> offset from the bottom border
75 // axisPixSize -> length of each axes arrows in pixels
76 // For example: default values -> right bottom corner with 100 offsets for the base point and 80 pixels each axis length
77 MRVIEWER_API void setAxesPos( const int pixelXoffset = -100, const int pixelYoffset = -100 );
78 MRVIEWER_API void setAxesSize( const int axisPixSize = 80 );
79
81 MRVIEWER_API const Vector2f& getAxesPosition() const;
82 MRVIEWER_API float getAxesSize() const;
83
85 const Matrix4f& getAxesProjectionMatrix() const { return axesProjMat_; }
86
87 // Shutdown
88 MRVIEWER_API void shut();
89
90 // ------------------- Drawing functions
91
92 // Clear the frame buffers
93 MRVIEWER_API void clearFramebuffers();
94
97 MRVIEWER_API bool draw( const VisualObject& obj,
98 DepthFunction depthFunc = DepthFunction::Default, RenderModelPassMask pass = RenderModelPassMask::All, bool allowAlphaSort = false ) const;
99
102 MRVIEWER_API bool draw( const VisualObject& obj, const AffineXf3f& xf,
103 DepthFunction depthFunc = DepthFunction::Default, RenderModelPassMask pass = RenderModelPassMask::All, bool allowAlphaSort = false ) const;
104
107 MRVIEWER_API bool draw( const VisualObject& obj, const AffineXf3f& xf, const Matrix4f & projM,
108 DepthFunction depthFunc = DepthFunction::Default, RenderModelPassMask pass = RenderModelPassMask::All, bool allowAlphaSort = false ) const;
109
112 {
113 float width{1.0f};
114 bool depthTest{ true };
115 };
116
118 MRVIEWER_API void drawLines( const std::vector<LineSegm3f>& lines, const std::vector<SegmEndColors>& colors, const LinePointImmediateRenderParams & params );
119 void drawLines( const std::vector<LineSegm3f>& lines, const std::vector<SegmEndColors>& colors, float width = 1, bool depthTest = true )
120 { drawLines( lines, colors, { getBaseRenderParams(), width, depthTest } ); }
121
123 MRVIEWER_API void drawPoints( const std::vector<Vector3f>& points, const std::vector<Vector4f>& colors, const LinePointImmediateRenderParams & params );
124 void drawPoints( const std::vector<Vector3f>& points, const std::vector<Vector4f>& colors, float width = 1, bool depthTest = true )
125 { drawPoints( points, colors, { getBaseRenderParams(), width, depthTest } ); }
126
128 {
129 Vector4f a, b, c;
130 };
131
133 MRVIEWER_API void drawTris( const std::vector<Triangle3f>& tris, const std::vector<TriCornerColors>& colors, const ModelRenderParams& params, bool depthTest = true );
134 MRVIEWER_API void drawTris( const std::vector<Triangle3f>& tris, const std::vector<TriCornerColors>& colors, const Matrix4f& modelM = {}, bool depthTest = true );
135
137 [[nodiscard]] BaseRenderParams getBaseRenderParams() const { return getBaseRenderParams( projM_ ); }
138
140 [[nodiscard]] BaseRenderParams getBaseRenderParams( const Matrix4f & projM ) const
141 { return { viewM_, projM, id, toVec4<int>( viewportRect_ ) }; }
142
145 const Matrix4f & modelM,
146 Matrix4f * normM,
149 bool allowAlphaSort = false
150 ) const
151 { return getModelRenderParams( modelM, projM_, normM, depthFunc, pass, allowAlphaSort ); }
152
154 [[nodiscard]] MRVIEWER_API ModelRenderParams getModelRenderParams( const Matrix4f & modelM, const Matrix4f & projM,
155 Matrix4f * normM,
158 bool allowAlphaSort = false
159 ) const;
160
161 // Predicate to additionally filter objects that should be treated as pickable.
162 using PickRenderObjectPredicate = std::function<bool ( const VisualObject*, ViewportMask )>;
163 // Point picking parameters.
165 {
166 // If specified, this is the target screen point. Otherwise use the mouse pos in viewport coordinates.
167 std::optional<Vector2f> point;
168
169 // Predicate to additionally filter objects that should be treated as pickable.
171
172 // Radius (in pixels) of a picking area.
173 // <0 defaults to `getViewerInstance().glPickRadius`.
174 int pickRadius = -1;
175 // Usually, from several objects that fall into the peak, the closest one along the ray is selected. However,
176 // if exactPickFirst = true, then the object in which the pick exactly fell (for example, a point in point cloud)
177 // will be returned as the result, even if there are others within the radius, including closer objects.
178 bool exactPickFirst = true;
179
180 // if not nullptr it can override render params for picker
182
183 // This will always return `{}`. We need the functions because `= {}`
184 // can't be used directly inside default arguments in the same class.
185 // You don't have to use this function.
187 {
188 return {};
189 }
190 };
191 // This function allows to pick point in scene by GL with given parameters.
192 // This overload uses all objects in the scene (possibly filtered by a predicate).
194 // This overload uses objects from the list (possibly filtered by a predicate).
195 MRVIEWER_API ObjAndPick pickRenderObject( std::span<VisualObject* const> objects, const PickRenderObjectParams& params = PickRenderObjectParams::defaults() ) const;
196 // This overload uses const objects from the list (possibly filtered by a predicate). Sadly need a different name to avoid over resolution issues.
197 MRVIEWER_API ConstObjAndPick pickRenderObjectConst( std::span<const VisualObject* const> objects, const PickRenderObjectParams& params = PickRenderObjectParams::defaults() ) const;
198
199 // This function allows to pick point in scene by GL
200 // use default pick radius
201 // comfortable usage:
202 // auto [obj,pick] = pick_render_object();
203 // pick all visible and pickable objects
204 // picks objects from current mouse pose by default
205 // [[deprecated("Use `pickRenderObject()`")]] // Should eventually deprecate this?
206 MRVIEWER_API ObjAndPick pick_render_object() const;
207 [[deprecated("Use `pickRenderObject()`")]]
208 MRVIEWER_API ObjAndPick pick_render_object( uint16_t pickRadius ) const;
209 // This function allows to pick point in scene by GL
210 // use default pick radius
211 // comfortable usage:
212 // auto [obj,pick] = pick_render_object( objects );
213 // pick objects from input
214 [[deprecated("Use `pickRenderObject( objects } )`")]] // NOTE! If your list is hardcoded, use `.objects = std::array{ a, b, c }`.
215 MRVIEWER_API ObjAndPick pick_render_object( const std::vector<VisualObject*>& objects ) const;
216 // This function allows to pick point in scene by GL with a given peak radius.
217 // usually, from several objects that fall into the peak, the closest one along the ray is selected.However
218 // if exactPickFirst = true, then the object in which the pick exactly fell( for example, a point in point cloud )
219 // will be returned as the result, even if there are others within the radius, including closer objects.
220 [[deprecated("Use `pickRenderObject( ... )`")]]
221 MRVIEWER_API ObjAndPick pick_render_object( const std::vector<VisualObject*>& objects, uint16_t pickRadius, bool exactPickFirst = true ) const;
222 // This function allows to pick point in scene by GL with default pick radius, but with specified exactPickFirst parameter (see description upper).
223 [[deprecated("Use `pickRenderObject( { .exactPickFirst = ... } )`")]]
224 MRVIEWER_API ObjAndPick pick_render_object( bool exactPickFirst ) const;
225 // This function allows to pick point in scene by GL
226 // comfortable usage:
227 // auto [obj,pick] = pick_render_object( objects );
228 // pick all visible and pickable objects
229 // picks objects from custom viewport point
230 [[deprecated("Use `pickRenderObject( { .point = ... } )`")]]
231 MRVIEWER_API ObjAndPick pick_render_object( const Vector2f& viewportPoint ) const;
232 // This function allows to pick point in scene by GL
233 // comfortable usage:
234 // auto [obj,pick] = pick_render_object( objects );
235 // picks objects from custom viewport point
236 [[deprecated("Use `multiPickObjects( objects, { .point = ... } )`")]]
237 MRVIEWER_API ObjAndPick pick_render_object( const std::vector<VisualObject*>& objects, const Vector2f& viewportPoint ) const;
238
239 // This function allows to pick several custom viewport space points by GL
240 // returns vector of pairs [obj,pick]
241 // To hardcode the list of `objects`, use `{{ a, b, c }}`.
242 MRVIEWER_API std::vector<ObjAndPick> multiPickObjects( std::span<VisualObject* const> objects, const std::vector<Vector2f>& viewportPoints, const BaseRenderParams* overrideRenderParams = nullptr ) const;
243
244 // This function finds all visible objects in given rect (max excluded) in viewport space,
245 // maxRenderResolutionSide - this parameter limits render resolution to improve performance
246 // if it is too small, little objects can be lost
247 // viewport space: X [0,viewport_width], Y [0,viewport_height] - (0,0) is upper left of viewport
248 MRVIEWER_API std::vector<std::shared_ptr<VisualObject>> findObjectsInRect( const Box2i& rect,
249 int maxRenderResolutionSide = 512 ) const;
250
251 // This functions finds all visible faces in given includePixBs in viewport space,
252 // maxRenderResolutionSide - this parameter limits render resolution to improve performance
253 // if it is too small, little faces can be lost
254 // viewport space: X [0,viewport_width], Y [0,viewport_height] - (0,0) is upper left of viewport
255 MRVIEWER_API std::unordered_map<std::shared_ptr<ObjectMesh>, FaceBitSet> findVisibleFaces( const BitSet& includePixBs,
256 int maxRenderResolutionSide = 512 ) const;
257
258 // This function allows to pick point in scene by GL
259 // comfortable usage:
260 // const auto [obj,pick] = pick_render_object();
261 // pick all visible and pickable objects
262 // picks objects from current mouse pose by default
263 [[deprecated("Use `pickRenderObject()`.")]]
265 // This function allows to pick point in scene by GL
266 // comfortable usage:
267 // const auto [obj,pick] = pick_render_object( objects );
268 // pick objects from input
269 [[deprecated("Use `pickRenderObject( objects )`.")]]
270 MRVIEWER_API ConstObjAndPick const_pick_render_object( const std::vector<const VisualObject*>& objects ) const;
271 // This function allows to pick several custom viewport space points by GL
272 // returns vector of pairs [obj,pick]
273 MRVIEWER_API std::vector<ConstObjAndPick> constMultiPickObjects( const std::vector<const VisualObject*>& objects, const std::vector<Vector2f>& viewportPoints ) const;
274
275 // multiplies view-matrix on given transformation from the _right_;
276 // so if you at the same time multiplies model transformation from the _left_ on xf.inverse()
277 // and call transformView( xf ), then the user will see exactly the same picture
278 MRVIEWER_API void transformView( const AffineXf3f & xf );
279
280 bool getRedrawFlag() const { return needRedraw_; }
281 void resetRedrawFlag() { needRedraw_ = false; }
282
283 // Unique identifier
285
287 {
288 Color backgroundColor = Color( Vector3f{0.3f, 0.3f, 0.5f} );
289 Vector3f lightPosition{0.0f, 0.3f, 0.0f};// x y z - position, w - factor
290
293 float cameraZoom{1.0f};
294 float cameraViewAngle{45.0f};
295 float cameraDnear{1.0f};
296 float cameraDfar{100.0f};
297
298 bool depthTest{true};
299 bool orthographic{true};
300
302 {
303 Auto, // uses current scene size
304 Fixed // uses global basis object internal size (one can change it with globalBasisAxes->setXf( AffineXf3f::linear( Matrix3f::scale( size ) ) ) )
305 } globalBasisScaleMode{ GlobalBasisScaleMode::Auto };
306
307 // Caches the two-norm between the min/max point of the bounding box
308 float objectScale{1.0f};
309
311
312 std::string label;
313
314 Plane3f clippingPlane{Vector3f::plusX(), 0.0f};
315
317 {
318 Static, // scene is always rotated around its center
319 DynamicStatic, // scene is rotated around picked point on object, or around center, if miss pick
320 Dynamic // scene is rotated around picked point on object, or around last rotation pivot, if miss pick
322
323 // if it is true, while rotation is enabled camera can be moved along forward axis
324 // in order to keep constant distance to scene center
325 bool compensateRotation{ true };
326
327 // this flag allows viewport to be selected by user
328 bool selectable{true};
329
330 bool operator==( const Viewport::Parameters& other ) const = default;
331 };
332
333 // Starts or stop rotation
334 MRVIEWER_API void setRotation( bool state );
335
336 // Note, Y is up for this box.
337 MRVIEWER_API const ViewportRectangle& getViewportRect() const;
338
339 // Finds length between near pixels on zNear plane. Only good in the orthographic projection.
340 MRVIEWER_API float getPixelSize() const;
341
342 // Finds the pixel scale at a specific world point. This works in both perspective and orthographic projection.
343 // The UI scale is NOT baked into this. You have to multiply by the scale manually if you need that.
344 MRVIEWER_API float getPixelSizeAtPoint( const Vector3f& worldPoint ) const;
345
346 // Sets position and size of viewport:
347 // rect is given as OpenGL coordinates: (0,0) is lower left corner
348 MRVIEWER_API void setViewportRect( const ViewportRectangle& rect );
349
350private:
351 // Save the OpenGL transformation matrices used for the previous rendering pass
352 Matrix4f viewM_;
353 Matrix4f projM_;
354
355public:
357 [[nodiscard]] MRVIEWER_API AffineXf3f getUnscaledViewXf() const;
358
360 [[nodiscard]] AffineXf3f getViewXf() const { return AffineXf3f( viewM_ ); }
361
363 [[nodiscard]] Vector3f getUpDirection() const { return Vector3f( viewM_.y.x, viewM_.y.y, viewM_.y.z ).normalized(); } // assume that viewM is orthogonal and inverse=transpose
364
366 [[nodiscard]] Vector3f getRightDirection() const { return Vector3f( viewM_.x.x, viewM_.x.y, viewM_.x.z ).normalized(); } // assume that viewM is orthogonal and inverse=transpose
367
369 [[nodiscard]] Vector3f getBackwardDirection() const { return Vector3f( viewM_.z.x, viewM_.z.y, viewM_.z.z ).normalized(); } // assume that viewM is orthogonal and inverse=transpose
370
371 // returns the line from Dnear to Dfar planes for the current pixel
372 // viewport space: X [0,viewport_width], Y [0,viewport_height] - (0,0) is upper left of viewport
373 // Z [0.f,1.f] - 0.f is Dnear, 1.f is Dfar
374 MRVIEWER_API Line3f unprojectPixelRay( const Vector2f& viewportPoint ) const;
375
376 // convert point(s) to camera space by applying view matrix
377 MRVIEWER_API Vector3f worldToCameraSpace( const Vector3f& p ) const;
378 MRVIEWER_API std::vector<Vector3f> worldToCameraSpace( const std::vector<Vector3f>& p ) const;
379
380 // projects point(s) to clip space. (rather, to normalized device coordinates, as it includes perspective division)
381 // clip space: XYZ [-1.f, 1.f], X axis from left(-1.f) to right(1.f), Y axis from bottom(-1.f) to top(1.f),
382 // Z axis from Dnear(-1.f) to Dfar(1.f)
383 MRVIEWER_API Vector3f projectToClipSpace( const Vector3f& worldPoint ) const;
384 MRVIEWER_API std::vector<Vector3f> projectToClipSpace( const std::vector<Vector3f>& worldPoints ) const;
385 MRVIEWER_API Vector3f unprojectFromClipSpace( const Vector3f& clipPoint ) const;
386 MRVIEWER_API std::vector<Vector3f> unprojectFromClipSpace( const std::vector<Vector3f>& clipPoints ) const;
387
388 // project point and convert coordinates to viewport space
389 // viewport space: X [0,viewport_width], Y [0,viewport_height] - (0,0) is upper left of viewport
390 // Z [0.f,1.f] - 0.f is Dnear, 1.f is Dfar
391 MRVIEWER_API Vector3f projectToViewportSpace( const Vector3f& worldPoint ) const;
392 MRVIEWER_API std::vector<Vector3f> projectToViewportSpace( const std::vector<Vector3f>& worldPoints ) const;
393 // unproject coordinates from viewport space
394 // viewport space: X [0,viewport_width], Y [0,viewport_height] - (0,0) is upper left of viewport
395 // Z [0.f,1.f] - 0.f is Dnear, 1.f is Dfar
396 MRVIEWER_API Vector3f unprojectFromViewportSpace( const Vector3f& viewportPoint ) const;
397 MRVIEWER_API std::vector<Vector3f> unprojectFromViewportSpace( const std::vector<Vector3f>& viewportPoints ) const;
398
399 // conversations between clip space and viewport space
400 // clip space: XYZ [-1.f, 1.f], X axis from left(-1.f) to right(1.f), Y axis from bottom(-1.f) to top(1.f),
401 // Z axis from Dnear(-1.f) to Dfar(1.f)
402 // viewport space: X [0,viewport_width], Y [0,viewport_height] - (0,0) is upper left of viewport
403 // Z [0.f,1.f] - 0.f is Dnear, 1.f is Dfar
404 MRVIEWER_API Vector3f clipSpaceToViewportSpace( const Vector3f& p ) const;
405 MRVIEWER_API std::vector<Vector3f> clipSpaceToViewportSpace( const std::vector<Vector3f>& p ) const;
406 MRVIEWER_API Vector3f viewportSpaceToClipSpace( const Vector3f& p ) const;
407 MRVIEWER_API std::vector<Vector3f> viewportSpaceToClipSpace( const std::vector<Vector3f>& p ) const;
408
409 // updates view and projection matrices due to camera parameters (called each frame)
410 void setupView();
411 // draws viewport primitives:
412 // lines: if depth test is on
413 // points: if depth test is on
414 // rotation center
415 // global basis
416 void preDraw();
417 // draws viewport primitives:
418 // lines: if depth test is off
419 // points: if depth test is off
420 // viewport border
421 // overlay basis
422 void postDraw() const;
423
424 // fit camera to the scene box (note: scene box does not include ancillary objects)
425 // fill = 1.0 parameter means that scene will be approximately 0.5 of screen
426 // snapView - to snap camera angle to closest canonical quaternion
427 MRVIEWER_API void fitData( float fill = 1.0f, bool snapView = true );
428
429 // set scene box by given one and fit camera to it
430 // fill = 1.0 parameter means that box diagonal will be approximately 0.5 of the viewport
431 // snapView - to snap camera angle to closest canonical quaternion
432 MRVIEWER_API void fitBox( const Box3f& newSceneBox, float fill = 1.0f, bool snapView = true );
433
438
439 // fit view and proj matrices to match the screen size with given box
440 MRVIEWER_API void preciseFitBoxToScreenBorder( const FitBoxParams& params );
441 // fit view and proj matrices to match the screen size with given objects
442 MRVIEWER_API void preciseFitDataToScreenBorder( const FitDataParams& params = {} );
443
444 // returns viewport width/height ratio
445 MRVIEWER_API float getRatio() const;
446
447 // returns true if all models are fully projected inside the viewport rectangle
448 MRVIEWER_API bool allModelsInsideViewportRectangle() const;
449
450 MRVIEWER_API const Box3f& getSceneBox() const;
451
452 const Parameters& getParameters() const { return params_; }
453
454 // returns camera world location for the current view
455 MRVIEWER_API Vector3f getCameraPoint() const;
456 // sets camera world location for the current view
457 MRVIEWER_API void setCameraPoint( const Vector3f& cameraWorldPos );
458
459 MRVIEWER_API void setCameraTrackballAngle( const Quaternionf& rot );
460
461 MRVIEWER_API void setCameraTranslation( const Vector3f& translation );
462
463 MRVIEWER_API void setCameraViewAngle( float newViewAngle );
464
465 MRVIEWER_API void setCameraZoom( float zoom );
466
467 MRVIEWER_API void setOrthographic( bool orthographic );
468
469 MRVIEWER_API void setBackgroundColor( const Color& color );
470
471 MRVIEWER_API void setClippingPlane( const Plane3f& plane );
472
473 MRVIEWER_API void setLabel( std::string s );
474
475 void setSelectable( bool on ) { params_.selectable = on; }
476
477 MRVIEWER_API void showAxes( bool on );
478 MRVIEWER_API void showClippingPlane( bool on );
479 MRVIEWER_API void showRotationCenter( bool on );
480 MRVIEWER_API void showGlobalBasis( bool on );
482
483 MRVIEWER_API void setParameters( const Viewport::Parameters& params );
484
485 // Set camera look direction and up direction (they should be perpendicular)
486 // this function changes camera position and do not change camera spot (0,0,0) by default
487 // to change camera position use setCameraTranslation after this function
488 MRVIEWER_API void cameraLookAlong( const Vector3f& dir, const Vector3f& up );
489
490 // Rotates camera around axis +direction applied to axis point
491 // note: this can make camera clip objects (as far as distance to scene center is not fixed)
492 MRVIEWER_API void cameraRotateAround( const Line3f& axis, float angle );
493
494 // Get current rotation pivot in world space
495 MRVIEWER_API Vector3f getRotationPivot() const;
496
497private:
498 // initializes view matrix based on camera position
499 void setupViewMatrix_();
500 // returns world space to camera space transformation
501 AffineXf3f getViewXf_() const;
502
503 // initializes proj matrix based on camera angle and viewport rectangle size
504 void setupProjMatrix_();
505 // initializes proj matrix for static view objects (like corner axes)
506 void setupAxesProjMatrix_();
507
508 // use this matrix to convert world 3d point to clip point
509 // clip space: XYZ [-1.f, 1.f], X axis from left(-1.f) to right(1.f), X axis from bottom(-1.f) to top(1.f),
510 // Z axis from Dnear(-1.f) to Dfar(1.f)
511 Matrix4f getFullViewportMatrix() const { return projM_ * viewM_; }
512 Matrix4f getFullViewportInversedMatrix() const;
513
514 ViewportRectangle viewportRect_;
515
516 ViewportGL viewportGL_;
517
518 bool previewLinesDepthTest_ = false;
519 bool previewPointsDepthTest_ = false;
520
521 void draw_border() const;
522 void draw_rotation_center() const;
523 void draw_clipping_plane() const;
524 void draw_global_basis() const;
525
526 // init basis axis in the corner
527 void initBaseAxes();
528 // Drawing basis axes and view controller cube in the corner
529 void drawAxesAndViewController() const;
530
531 // This matrix should be used for a static objects
532 // For example, basis axes in the corner
533 Matrix4f axesProjMat_;
534 Vector2f basisAxesPos_;
535 float basisAxesSize_;
536
537 // basis axis params
538 int pixelXoffset_{ -100 };
539 int pixelYoffset_{ -100 };
540 int axisPixSize_{ 70 };
541
542 // Receives point in scene coordinates, that should appear static on a screen, while rotation
543 void setRotationPivot_( const Vector3f& point );
544 void updateSceneBox_();
545 void rotateView_();
546
547 enum class Space
548 {
549 World, // (x, y, z) in world space
550 CameraOrthographic, // (x, y, z) in camera space
551 CameraPerspective // (x/z, y/z, z), where (x, y, z) in camera space
552 };
553
558 Box3f calcBox_( const std::vector<std::shared_ptr<VisualObject>>& objs, Space space, bool selectedPrimitives = false ) const;
559
567 std::pair<float, bool> getZoomFOVtoScreen_( std::function<Box3f()> getBoxFn, Vector3f* cameraShift = nullptr ) const;
568 // fit view and proj matrices to match the screen size with boxes returned by getBoxFn
569 // getBoxFn( true ) - always camera space (respecting projection)
570 // getBoxFn( false ) - if orthographic - camera space, otherwise - world space
571 // getBoxFn/globalBasis - if true then getBoxFn should return box of global basis object (separately, not to interfere with actual scene size)
572 void preciseFitToScreenBorder_( std::function<Box3f( bool zoomFOV, bool globalBasis )> getBoxFn, const BaseFitParams& params );
573
574 bool rotation_{ false };
575 Vector3f rotationPivot_;
576 Vector3f static_point_;
577 Vector2f static_viewport_point;
578 float distToSceneCenter_;
579
580 bool needRedraw_{false};
581
582 // world bounding box of scene objects visible in this viewport
583 Box3f sceneBox_;
584
585 Parameters params_;
586};
587
588} //namespace MR
std::pair< std::shared_ptr< const MR::VisualObject >, MR::PointOnObject > ConstObjAndPick
Definition MRViewport.h:22
std::pair< std::shared_ptr< MR::VisualObject >, MR::PointOnObject > ObjAndPick
Definition MRViewport.h:21
container of bits
Definition MRMesh/MRBitSet.h:27
Definition MRViewportGL.h:53
Definition MRViewportId.h:16
stores mask of viewport unique identifiers
Definition MRViewportId.h:38
Definition MRViewport.h:49
MRVIEWER_API Vector3f projectToClipSpace(const Vector3f &worldPoint) const
MRVIEWER_API void showRotationCenter(bool on)
MRVIEWER_API ConstObjAndPick const_pick_render_object() const
MRVIEWER_API Vector3f projectToViewportSpace(const Vector3f &worldPoint) const
MRVIEWER_API void setCameraViewAngle(float newViewAngle)
MRVIEWER_API void setCameraZoom(float zoom)
MRVIEWER_API ObjAndPick pick_render_object(const std::vector< VisualObject * > &objects, uint16_t pickRadius, bool exactPickFirst=true) const
MRVIEWER_API void shut()
MR::BaseFitParams BaseFitParams
Definition MRViewport.h:435
MRVIEWER_API float getAxesSize() const
MRVIEWER_API ObjAndPick pick_render_object(const std::vector< VisualObject * > &objects, const Vector2f &viewportPoint) const
Vector3f getRightDirection() const
returns unit vector in world space corresponding to right-direction in camera space
Definition MRViewport.h:366
ModelRenderParams getModelRenderParams(const Matrix4f &modelM, Matrix4f *normM, DepthFunction depthFunc=DepthFunction::Default, RenderModelPassMask pass=RenderModelPassMask::All, bool allowAlphaSort=false) const
Prepares rendering parameters to draw a model with given transformation in this viewport.
Definition MRViewport.h:144
MRVIEWER_API ~Viewport()
MRVIEWER_API std::vector< Vector3f > unprojectFromViewportSpace(const std::vector< Vector3f > &viewportPoints) const
MRVIEWER_API void cameraLookAlong(const Vector3f &dir, const Vector3f &up)
MRVIEWER_API Vector3f unprojectFromClipSpace(const Vector3f &clipPoint) const
MRVIEWER_API ObjAndPick pick_render_object(uint16_t pickRadius) const
MRVIEWER_API ConstObjAndPick pickRenderObjectConst(std::span< const VisualObject *const > objects, const PickRenderObjectParams &params=PickRenderObjectParams::defaults()) const
MRVIEWER_API void showGlobalBasis(bool on)
std::function< bool(const VisualObject *, ViewportMask)> PickRenderObjectPredicate
Definition MRViewport.h:162
MRVIEWER_API void cameraRotateAround(const Line3f &axis, float angle)
MRVIEWER_API ModelRenderParams getModelRenderParams(const Matrix4f &modelM, const Matrix4f &projM, Matrix4f *normM, DepthFunction depthFunc=DepthFunction::Default, RenderModelPassMask pass=RenderModelPassMask::All, bool allowAlphaSort=false) const
Prepares rendering parameters to draw a model with given transformation in this viewport with custom ...
MRVIEWER_API void setCameraTranslation(const Vector3f &translation)
MRVIEWER_API ObjAndPick pickRenderObject(const PickRenderObjectParams &params=PickRenderObjectParams::defaults()) const
bool getRedrawFlag() const
Definition MRViewport.h:280
BaseRenderParams getBaseRenderParams(const Matrix4f &projM) const
Prepares base rendering parameters for this viewport with custom projection matrix.
Definition MRViewport.h:140
MRVIEWER_API float getRatio() const
void setSelectable(bool on)
Definition MRViewport.h:475
MRVIEWER_API float getPixelSize() const
MRVIEWER_API ConstObjAndPick const_pick_render_object(const std::vector< const VisualObject * > &objects) const
MRVIEWER_API Vector3f unprojectFromViewportSpace(const Vector3f &viewportPoint) const
MRVIEWER_API const Vector2f & getAxesPosition() const
returns position of basis axes in viewport space
void drawLines(const std::vector< LineSegm3f > &lines, const std::vector< SegmEndColors > &colors, float width=1, bool depthTest=true)
Definition MRViewport.h:119
MRVIEWER_API void init()
MRVIEWER_API float getPixelSizeAtPoint(const Vector3f &worldPoint) const
void resetRedrawFlag()
Definition MRViewport.h:281
MRVIEWER_API void preciseFitDataToScreenBorder(const FitDataParams &params={})
MRVIEWER_API Vector3f viewportSpaceToClipSpace(const Vector3f &p) const
MR::ViewportRectangle ViewportRectangle
Definition MRViewport.h:51
MRVIEWER_API void setRotation(bool state)
MRVIEWER_API void setParameters(const Viewport::Parameters &params)
MRVIEWER_API std::vector< Vector3f > clipSpaceToViewportSpace(const std::vector< Vector3f > &p) const
MRVIEWER_API bool draw(const VisualObject &obj, const AffineXf3f &xf, DepthFunction depthFunc=DepthFunction::Default, RenderModelPassMask pass=RenderModelPassMask::All, bool allowAlphaSort=false) const
MRVIEWER_API void setOrthographic(bool orthographic)
AffineXf3f getViewXf() const
converts directly from the view matrix
Definition MRViewport.h:360
void preDraw()
MRVIEWER_API void showClippingPlane(bool on)
MRVIEWER_API const ViewportRectangle & getViewportRect() const
MRVIEWER_API void fitBox(const Box3f &newSceneBox, float fill=1.0f, bool snapView=true)
MRVIEWER_API void showAxes(bool on)
MRVIEWER_API std::vector< Vector3f > worldToCameraSpace(const std::vector< Vector3f > &p) const
MRVIEWER_API Vector3f getCameraPoint() const
MRVIEWER_API void drawTris(const std::vector< Triangle3f > &tris, const std::vector< TriCornerColors > &colors, const Matrix4f &modelM={}, bool depthTest=true)
MRVIEWER_API void drawTris(const std::vector< Triangle3f > &tris, const std::vector< TriCornerColors > &colors, const ModelRenderParams &params, bool depthTest=true)
Draw triangles immediately (flat shaded)
MRVIEWER_API void setCameraTrackballAngle(const Quaternionf &rot)
MRVIEWER_API ObjAndPick pick_render_object(const std::vector< VisualObject * > &objects) const
Vector3f getBackwardDirection() const
returns unit vector in world space corresponding to direction toward camera in camera space
Definition MRViewport.h:369
MRVIEWER_API Line3f unprojectPixelRay(const Vector2f &viewportPoint) const
MRVIEWER_API std::vector< Vector3f > unprojectFromClipSpace(const std::vector< Vector3f > &clipPoints) const
Viewport clone() const
Definition MRViewport.h:64
MRVIEWER_API void setLabel(std::string s)
MRVIEWER_API bool draw(const VisualObject &obj, const AffineXf3f &xf, const Matrix4f &projM, DepthFunction depthFunc=DepthFunction::Default, RenderModelPassMask pass=RenderModelPassMask::All, bool allowAlphaSort=false) const
MRVIEWER_API std::unordered_map< std::shared_ptr< ObjectMesh >, FaceBitSet > findVisibleFaces(const BitSet &includePixBs, int maxRenderResolutionSide=512) const
const Parameters & getParameters() const
Definition MRViewport.h:452
MRVIEWER_API std::vector< Vector3f > viewportSpaceToClipSpace(const std::vector< Vector3f > &p) const
MRVIEWER_API std::vector< Vector3f > projectToViewportSpace(const std::vector< Vector3f > &worldPoints) const
MRVIEWER_API void fitData(float fill=1.0f, bool snapView=true)
MRVIEWER_API void setAxesSize(const int axisPixSize=80)
MRVIEWER_API void drawPoints(const std::vector< Vector3f > &points, const std::vector< Vector4f > &colors, const LinePointImmediateRenderParams &params)
Draw points immediately.
MRVIEWER_API const Box3f & getSceneBox() const
static MRVIEWER_API Viewport & get(ViewportId viewportId={})
void setupView()
MRVIEWER_API ObjAndPick pickRenderObject(std::span< VisualObject *const > objects, const PickRenderObjectParams &params=PickRenderObjectParams::defaults()) const
MRVIEWER_API void setViewportRect(const ViewportRectangle &rect)
Viewport(Viewport &&) noexcept=default
MRVIEWER_API std::vector< ObjAndPick > multiPickObjects(std::span< VisualObject *const > objects, const std::vector< Vector2f > &viewportPoints, const BaseRenderParams *overrideRenderParams=nullptr) const
MRVIEWER_API void transformView(const AffineXf3f &xf)
MRVIEWER_API Vector3f worldToCameraSpace(const Vector3f &p) const
MRVIEWER_API ObjAndPick pick_render_object(bool exactPickFirst) const
MRVIEWER_API std::vector< ConstObjAndPick > constMultiPickObjects(const std::vector< const VisualObject * > &objects, const std::vector< Vector2f > &viewportPoints) const
MRVIEWER_API bool draw(const VisualObject &obj, DepthFunction depthFunc=DepthFunction::Default, RenderModelPassMask pass=RenderModelPassMask::All, bool allowAlphaSort=false) const
MRVIEWER_API AffineXf3f getUnscaledViewXf() const
returns orthonormal matrix with translation
const Matrix4f & getAxesProjectionMatrix() const
returns projection matrix that is used for basis axes and view controller rendering
Definition MRViewport.h:85
MRVIEWER_API void setClippingPlane(const Plane3f &plane)
MRVIEWER_API void preciseFitBoxToScreenBorder(const FitBoxParams &params)
MRVIEWER_API bool allModelsInsideViewportRectangle() const
void postDraw() const
BaseRenderParams getBaseRenderParams() const
Prepares base rendering parameters for this viewport.
Definition MRViewport.h:137
MRVIEWER_API void drawLines(const std::vector< LineSegm3f > &lines, const std::vector< SegmEndColors > &colors, const LinePointImmediateRenderParams &params)
Draw lines immediately.
void drawPoints(const std::vector< Vector3f > &points, const std::vector< Vector4f > &colors, float width=1, bool depthTest=true)
Definition MRViewport.h:124
MRVIEWER_API Viewport()
MRVIEWER_API void setBackgroundColor(const Color &color)
MRVIEWER_API Vector3f getRotationPivot() const
MRVIEWER_API std::vector< std::shared_ptr< VisualObject > > findObjectsInRect(const Box2i &rect, int maxRenderResolutionSide=512) const
MRVIEWER_API void setAxesPos(const int pixelXoffset=-100, const int pixelYoffset=-100)
MRVIEWER_API void clearFramebuffers()
MRVIEWER_API ObjAndPick pick_render_object(const Vector2f &viewportPoint) const
MRVIEWER_API void setCameraPoint(const Vector3f &cameraWorldPos)
MRVIEWER_API Vector3f clipSpaceToViewportSpace(const Vector3f &p) const
ViewportId id
Definition MRViewport.h:284
MRVIEWER_API std::vector< Vector3f > projectToClipSpace(const std::vector< Vector3f > &worldPoints) const
MRVIEWER_API void rotationCenterMode(Parameters::RotationCenterMode mode)
Vector3f getUpDirection() const
returns unit vector in world space corresponding to up-direction in camera space
Definition MRViewport.h:363
MRVIEWER_API ObjAndPick pick_render_object() const
Visual Object.
Definition MRVisualObject.h:121
auto width(const Box< V > &box)
returns size along x axis
Definition MRMesh/MRBox.h:247
auto height(const Box< V > &box)
returns size along y axis
Definition MRMesh/MRBox.h:254
FitMode
Definition MRFitData.h:11
ImVec2 size(const ViewportRectangle &rect)
Definition MRViewport.h:32
RenderModelPassMask
Various passes of the 3D rendering.
Definition MRRenderModelParameters.h:10
Vector4< T > toVec4(const ViewportRectangle &rect)
Definition MRViewport.h:41
DepthFunction
Definition MRIRenderObject.h:18
Box2f ViewportRectangle
Viewport size.
Definition MRViewerFwd.h:12
Definition MRFitData.h:19
Common rendering parameters for meshes and UI.
Definition MRIRenderObject.h:33
Definition MRMesh/MRColor.h:9
Definition MRFitData.h:41
Definition MRFitData.h:28
Mesh rendering parameters for primary rendering (as opposed to the picker).
Definition MRIRenderObject.h:51
Definition MRPointOnObject.h:16
Definition MRVector4.h:13
Rendering parameters for immediate drawing of lines and points.
Definition MRViewport.h:112
bool depthTest
Definition MRViewport.h:114
float width
Definition MRViewport.h:113
Definition MRViewport.h:287
RotationCenterMode
Definition MRViewport.h:317
float cameraViewAngle
Definition MRViewport.h:294
Vector3f cameraTranslation
Definition MRViewport.h:292
Color backgroundColor
Definition MRViewport.h:288
bool orthographic
Definition MRViewport.h:299
float cameraDfar
Definition MRViewport.h:296
Color borderColor
Definition MRViewport.h:310
bool depthTest
Definition MRViewport.h:298
Plane3f clippingPlane
Definition MRViewport.h:314
std::string label
Definition MRViewport.h:312
float cameraZoom
Definition MRViewport.h:293
Quaternionf cameraTrackballAngle
Definition MRViewport.h:291
Vector3f lightPosition
Definition MRViewport.h:289
enum MR::Viewport::Parameters::GlobalBasisScaleMode Auto
bool selectable
Definition MRViewport.h:328
GlobalBasisScaleMode
Definition MRViewport.h:302
enum MR::Viewport::Parameters::RotationCenterMode Dynamic
bool operator==(const Viewport::Parameters &other) const =default
float cameraDnear
Definition MRViewport.h:295
bool compensateRotation
Definition MRViewport.h:325
float objectScale
Definition MRViewport.h:308
Definition MRViewport.h:165
int pickRadius
Definition MRViewport.h:174
PickRenderObjectPredicate predicate
Definition MRViewport.h:170
bool exactPickFirst
Definition MRViewport.h:178
static PickRenderObjectParams defaults()
Definition MRViewport.h:186
const BaseRenderParams * baseRenderParams
Definition MRViewport.h:181
std::optional< Vector2f > point
Definition MRViewport.h:167
Definition MRViewport.h:128
Vector4f c
Definition MRViewport.h:129
Vector4f b
Definition MRViewport.h:129
Vector4f a
Definition MRViewport.h:129