MRPythonViewer.h

Go to the documentation of this file.

#pragma once

 
#include "MRMesh/MRFlagOperators.h"
#include "MRMesh/MRLine.h"
#include "MRMesh/MRVector2.h"
#include "MRMesh/MRVector3.h"
#include "MRMesh/MRViewportId.h"
 
#include <functional>
#include <string>
 
namespace MR::PythonViewer
{

struct ViewerSetup
{
};
 
enum class ViewerLaunchParamsMode
{
    Show, 
    HideInit, 
    Hide, 
    TryHidden, 
    NoWindow, 
};

struct ViewerLaunchParams
{
    int animationMaxFps = 30; 
    bool fullscreen = false; 
    int width = 0;
    int height = 0;
    bool isAnimating = false; 
    std::string name = "MRViewer"; 
    ViewerLaunchParamsMode windowMode = ViewerLaunchParamsMode::HideInit;
};
 
enum class MouseButton
{
    Left,
    Right,
    Middle,
};
 
enum class KeyMod
{
    Empty = 0,
    Ctrl = 0x0002,
    Super = 0x0008,
    Shift = 0x0001,
    Alt = 0x0004,
};
MR_MAKE_FLAG_OPERATORS( KeyMod )
 

[[nodiscard]] KeyMod getPrimaryCtrlKeyMod();

enum class ViewportFitMode
{
    Visible, 
    SelectedPrimitives, 
    SelectedObjects, 
};
 
struct ViewportFitDataParams
{
    float factor = 1.f; 
    bool snapView = false; 
    ViewportFitMode mode = ViewportFitMode::Visible; 
};

class Viewport
{
public:
    explicit Viewport( ViewportId id ) : id( id ) {}
 
    const ViewportId id;

    void cameraLookAlong( const Vector3f& dir, const Vector3f& up ) const;

    void cameraRotateAround( const Line3f& axis, float angle ) const;

    [[nodiscard]] Vector3f projectToViewportSpace( const Vector3f& input ) const;
};

class Viewer
{
public:
    [[nodiscard]] Viewport viewport( ViewportId viewportId = {} ) const;

    void incrementForceRedrawFrames( int num = 1, bool swapOnLastOnly = false ) const;
 
    void skipFrames( int frames ) const;

    void preciseFitDataViewport( ViewportMask vpList = ViewportMask::all(), const ViewportFitDataParams& params = {} ) const;

    void captureScreenShot( const std::string& path ) const;

    void captureUIScreenShot( const std::string& path ) const;

    void shutdown( int exitCode = 0, bool interruptible = true ) const;

    void mouseDown( MouseButton button, KeyMod modifier = KeyMod::Empty ) const;

    void mouseUp( MouseButton button, KeyMod modifier = KeyMod::Empty ) const;

    void mouseMove( int x, int y ) const;

    [[nodiscard]] Vector2f getMousePos() const;

    [[nodiscard]] Vector3f viewportToScreen( const Vector3f& viewportPoint, ViewportId id ) const;

    void showSceneTree( bool show ) const;
};

void launch( const ViewerLaunchParams& params = {}, const ViewerSetup& setup = {} );

void showViewer();

void runFromGUIThread( const std::function<void()>& lambda );

void shutViewerAtExit();
 
}