MRPlaneWidget.h

Go to the documentation of this file.

#pragma once
 
#include "MRViewerEventsListener.h"
#include "MRMesh/MRBox.h"
#include "MRMesh/MRPlane3.h"
#include "MRMesh/MRVector2.h"
 
namespace MR
{
// Visual widget to draw a plane
// present in scene (ancillary), subscribes to viewer events
class MRVIEWER_CLASS PlaneWidget : public MultiListener<MouseDownListener, MouseMoveListener, MouseUpListener>
{
    std::shared_ptr<ObjectMesh> planeObj_;
    Plane3f plane_;
    Box3f box_;
    Vector3f cameraUp3Old_;
    
    // if in this mode - newly setup plane always has 0.0 shift
    bool localMode_{ false };
    float localShift_{ 0.0f };
 
    using OnPlaneUpdateCallback = std::function<void()>;
    OnPlaneUpdateCallback onPlaneUpdate_;
 
    bool pressed_ = false;
    bool showPlaneByDefault_ = true;
    Vector2f startMousePos_;
    Vector2f endMousePos_;
 
    std::shared_ptr<ObjectLines> line_;
 
    bool importPlaneMode_ = false;
public:
    
    // updates plane, triggers callback if it is specidied
    // if updateCameraRotation is true, plane transform will be updated with respect of camera up direction
    MRVIEWER_API void updatePlane( const Plane3f& plane, bool updateCameraRotation = true );
    // updates box which is used to calculate size and position of the visualized plane part
    // if updateCameraRotation is true, plane transform will be updated with respect of camera up direction
    MRVIEWER_API void updateBox( const Box3f& box, bool updateCameraRotation = true );
    // defines plane, adds plane object to scene
    MRVIEWER_API void definePlane();
    // undefines plane, removes PlaneObject from scene
    MRVIEWER_API void undefinePlane();
 
    // if local mode is active UI shows local shift
    // which is 0.0 for each newly setup plane
    MRVIEWER_API void setLocalMode( bool on );
    bool isInLocalMode() const { return localMode_; }
    void setLocalShift( float shift ) { localShift_ = shift; }
    float getLocalShift() const { return localShift_; }
 
    // returns plane
    MRVIEWER_API const Plane3f& getPlane() const;
    // returns plane object
    MRVIEWER_API const std::shared_ptr<ObjectMesh>& getPlaneObject() const;
    // specifies callback onPlaneUpdate_
    // it is triggered when the method updatePlane is called
    MRVIEWER_API void setOnPlaneUpdateCallback( OnPlaneUpdateCallback  callback );
 
    // returns box which is used to calculate size and position of the visualized plane part
    MRVIEWER_API const Box3f& box() const;
    // returns the flag importPlaneMode_, if it is true you can use a plain object from the scene
    MRVIEWER_API bool importPlaneMode() const;
    // sets the flag importPlaneMode_, if it is true you can use a plain object from the scene
    MRVIEWER_API void setImportPlaneMode( bool val );
 
    // returns the flag that is true if the plane is shown by default
    bool getShowPlaneByDefault() const { return showPlaneByDefault_; }
    // sets the flag that is true if the plane is shown by default
    void setShowPlaneByDefault( bool val ) { showPlaneByDefault_ = val; }
 
private:
    MRVIEWER_API void updateWidget_( bool updateCameraRotation = true );
 
    MRVIEWER_API virtual bool onMouseDown_( MouseButton button, int modifier ) override;
    MRVIEWER_API virtual bool onMouseUp_( MouseButton button, int modifier ) override;
    MRVIEWER_API virtual bool onMouseMove_( int mouse_x, int mouse_y ) override;
};
}