RE_Window.h

Go to the documentation of this file.

#ifndef __RE_Window_h__
#define __RE_Window_h__

#include "RE_API.h"
#include "RE_IDType.h"
#include "RE_Types.h"

#include <UT/UT_Lock.h>
#include <UT/UT_NonCopyable.h>
#include <UT/UT_Rect.h>
#include <UT/UT_UniquePtr.h>
#include <UT/UT_ValArray.h>

#include <utility>

class RE_Render;
class RE_Server;
class RE_Visual;
class RE_QPainterDrawable;
class RE_WindowDrawable;

class QWidget;


struct RE_WindowFlags
{
    bool isOriginReadjusted:1,
         alwaysOnTop:1,
         maximized:1,
         fullscreen:1;
};

/// ==========================================================================
/// For new 2D UI drawing.
///
/// Abstract base class representing an owner of an RE_Window.
///
class RE_API RE_WindowOwner
{
public:
    RE_WindowOwner() {}
    virtual ~RE_WindowOwner() {}
    UT_NON_COPYABLE(RE_WindowOwner)

    virtual void render() = 0;
    virtual bool shouldApplyDevicePixelRatio() const = 0;
    virtual bool useHoloStyle() const = 0;
    virtual bool hasPendingLayoutsForPaint() const = 0;
    virtual void deferPaintForPendingLayouts() = 0;
    virtual void processPendingLayoutsForPaint() = 0;
    virtual void handleScreenChanged() = 0;
};
/// ==========================================================================

class RE_API RE_Window
{
public:
    RE_Window(RE_Server *server,
              RE_WindowType type = RE_WINDOW_NORMAL,
              RE_VisualType visType = RE_NORMAL_VIS,
              RE_WindowOwner *owner = nullptr);

    virtual ~RE_Window();

    void setName(const char *name);
    void setIconName(const char *name);
    
    void setParentWindow(RE_Window *parent);
    const RE_Window     *getParentWindow() const { return parentWindow; }

    void setDialogParentHint(RE_IDType parent_hint);

    // TODO:  No need for getServer().  Move getVisual() to RE_GLDrawable.
    RE_Server           *getServer() { return myServer; }
    RE_Visual           *getVisual()
                         { return myVisualResource; }

    RE_Render           *getRender();
    void                 setRender(UT_UniquePtr<RE_Render> r)
                         { myRender = std::move(r); }
    
    RE_IDType    openWindow();
    RE_IDType    openWindow(bool show);
    void         showWindow();
    void         closeWindow();

    void         initMaxSize(int w, int h );
    void         initMinSize(int w, int h );
    void         initVisual(   RE_Visual *visual );
    void                 setLimitPositions(bool limitpos)
                         { myLimitPositions = limitpos; }
    bool                 getLimitPositions() const
                         { return myLimitPositions; }

    void moveWindow(int x, int y);
    void sizeWindow(int w, int h);

    // Set the window's opacity (0.0 - 1.0).
    // Values less than 1.0 will make the window translucent.
    void setWindowOpacity(fpreal opacity);


    // Maximize the window and/or mark it as maximized so that when openWindow
    // is called, it can open the window maximized.
    void maximizeWindow();
    void restoreWindow();

    bool isMaximized() const;

    // Set the window as fullscreen. Depending on the windowing system, this
    // either informs the window manager to set us as fullscreen or simply
    // sets borders up so that higher-level classes can do the fullscreening
    // themselves.
    void fullscreenWindow(bool full);
    bool isFullscreenWindow() const;
    void lowerWindow();
    void raiseWindow();

    // Show/Hide the Window Frame/ Titlebar
    void setHasWindowFrame(bool b);
    bool hasWindowFrame() const;
    
    int          getBorderWidth() const
                 { return myLeftBorder+myRightBorder; }
    int          getBorderHeight() const
                 { return myTopBorder+myBottomBorder; }
    int          getBorderTopSize() const
                 { return myTopBorder; }
    int          getBorderLeftSize() const
                 { return myLeftBorder; }
    int          getBorderBottomSize() const
                 { return myBottomBorder; }
    int          getBorderRightSize() const
                 { return myRightBorder; }

    UT_DimRect  findLocation() const;
    UT_DimRect  getNormalGeometry() const;

    // Sets the window to sit on top of all other windows, or turns off that
    // state, depending on whether newstate is true or false.
    void         setWindowAlwaysOnTop(bool newstate);
    int         getWindowAlwaysOnTop() const { return winFlags.alwaysOnTop; }

    void         setWindowFloatOnTop(bool on_top);

    RE_DisplayMode       getMode() const;

    RE_VisualType        getVisualType() const
                         { return myVisualType; }
    void                 setVisualType(RE_VisualType t) { myVisualType = t; }

    // changes to the type will not occur until the window is opened again.
    void                 setWindowType(RE_WindowType t)
                         { myWindowType = t; }

    RE_WindowType        getWindowType( bool extra=false) const;

    
    void                 setWindowID(RE_IDType id) { myWindowID = id; }
    RE_IDType            getWindowID()  const
                         { return myWindowID; }
    int                  matchID( RE_IDType wid ) const
                         { return wid == myWindowID; }
    
    virtual RE_IDType    getBufferID() const { return 0; }

    /// =====================================================================
    /// For new 2D UI drawing.
    bool                 needsOpenGL() const;

    // Methods to access and set the assigned OpenGL drawable.
    RE_WindowDrawable   *getDrawable() const { return myWindowDrawable; }
    void                 setDrawable(RE_WindowDrawable *d);

    // Methods to access and set the assigned plain (QPainter only) drawable.
    RE_QPainterDrawable *getQPainterDrawable() const { return myQPainterDrawable; }
    void                 setQPainterDrawable(RE_QPainterDrawable *d);
    /// =====================================================================

    /// =====================================================================
    /// For OpenGL 2D UI drawing.
    OGLDrawable  getGraphicsDrawable() const { return myDrawable; }
    void         setGraphicsDrawable(OGLDrawable d) { myDrawable = d; }
    /// =====================================================================

    
    void         setIMESupport(bool enable);

    /// Return the Qt main window.
    static QWidget *    mainQtWindow();

    /// Initialize the given widget window with the desired
    /// Houdini window properties, look and feel.
    static void initQtWindow(
                    QWidget &window, RE_WindowType win_type, 
                    bool always_on_top);

    /// Create a Qt window widget for the given window type.
    /// The caller takes ownership of the returned object.
    static QWidget *    createQtWindow(RE_WindowType win_type);

    /// Returns true if Houdini or any of its sub windows are focused
    static bool         appActive();

    /// Returns true if this window is the active window.
    bool                isActiveWindow() const;

    void         setWindowBorders(int left, int right, int top, int bottom)
                 {
                     myLeftBorder = left;
                     myRightBorder = right;
                     myTopBorder = top;
                     myBottomBorder = bottom;
                 }

    // This is called by the native window to inform that it has changed its
    // maximized state.
    void        updateMaximizedFlag(bool is_maximized)
                {
                    winFlags.maximized = is_maximized;
                }

    static bool         isTabFocusEnabled();
    static void         enableTabFocus(bool enable);

    /// Return the string tag used to identify whether a Qt widget is the
    /// window for an RE_Window object.
    static const char * windowTag() { return "RE_Window"; }

    bool        isQuadBufferStereo() const;

    /// Return the screen number containing this window.
    /// If the underlying platform window has not been created
    /// yet then return the primary screen number.
    int                          screen() const;

    /// Get screen-to-window scale.
    fpreal                       screenToDeviceScale() const;

    /// =====================================================================
    /// For new 2D UI drawing.

    /// Request that the window render it's contents.
    void requestRender(bool immediate = false);

    /// Return the window currently being immediately rendered, if any.
    /// While set, no other window should paint.
    static RE_Window *immediateRenderWindow();
    static void setImmediateRenderWindow(RE_Window *window);

    /// Pass key class to help restrict method access to drawable classes.
    class DrawablePassKey
    {
    private:
        friend RE_QPainterDrawable;
        friend RE_WindowDrawable;
        DrawablePassKey() = default;
        ~DrawablePassKey() = default;
    };

    /// Render the window's contents.
    /// This method is meant to be called only from RE drawable classes.
    void render(const DrawablePassKey &k);
    
    /// Return true if the window's screen's device pixel ratio should be
    /// applied when painting the windows contents.  Return false otherwise.
    virtual bool shouldApplyDevicePixelRatio() const;

    /// Return true if the drawable should use the holo style.
    bool useHoloStyle() const;

    bool hasPendingLayoutsForPaint() const;
    void deferPaintForPendingLayouts();
    /// Process any pending UI layouts in the window.
    void processPendingLayoutsForPaint();

    /// Handle when the window has moved to another screen.
    void handleScreenChanged();
    /// =====================================================================

    /// Get Default Window Border Sizes
    static const int* getDefaultWindowBorderSizes();
    static int getDefaultWindowTitleBarHeight();

private:
    /// Initialize window borders.
    void                         initBorderSizes_();

    /// Move the underlying Qt window to the position specified by myFrame.
    void                         moveQtWindow_();

#if defined(WIN32)
    /// Add the Always On Top menu item to the window's system menu.
    void                         addAlwaysOnTopSystemMenuItem_();
#endif
    
private:
    /// =====================================================================
    /// For new 2D UI drawing.
    RE_WindowOwner      *myOwner;
    /// =====================================================================

    RE_Server           *myServer;
    UT_UniquePtr<RE_Render> myRender;
    RE_Visual           *myVisualResource;
    RE_VisualType        myVisualType;
    RE_IDType            myWindowID;

#if defined(WIN32) || defined(USE_QT6)
    // This widget is for stashing away the Qt window when it closes and
    // detaches from its parent window.  There's a limitation where a Qt
    // window cannot gracefully detach itself from the parent.  Doing so
    // typically changes the child widget's window flags and creates
    // unwanted system windows.
    //
    // The workaround is to instead reparent the Qt window instead of
    // completely detaching it.
    QWidget             *myStashWidget;
#endif
    
    UT_String            myName;
    UT_String            myIconName;

    // Window geometry in native screen coordinates and scaling.
    UT_DimRect           myFrame;

    using IntPair = std::pair<int, int>;

    // Window sizes in native screen scaling.
    IntPair              myMinSize;
    IntPair              myMaxSize;

    /// =====================================================================
    /// For new 2D UI drawing.

    // Window drawable with support for OpenGL.
    RE_WindowDrawable   *myWindowDrawable;

    // Window drawable without OpenGL support.  Only supports QPainter drawing.
    RE_QPainterDrawable *myQPainterDrawable;

    /// =====================================================================

    /// =====================================================================
    /// For OpenGL 2D UI drawing.
    OGLDrawable          myDrawable;
    /// =====================================================================
    
    unsigned long        myIconPixmap;
    RE_WindowFlags       winFlags;
    RE_Window           *parentWindow;
    RE_IDType            myDialogParentHint;

    RE_WindowType        myWindowType;

    int                  myLeftBorder;
    int                  myTopBorder;
    int                  myRightBorder;
    int                  myBottomBorder;

    unsigned int         myLimitPositions:1;

    fpreal               myWindowOpacity;

#if defined(WIN32)
    bool                 myAddedAlwaysOnTopMenuItem;
#endif

    bool                 myIsResizing;
};

class RE_API RE_WindowList
{
public:
                         RE_WindowList()
                         { }
                        ~RE_WindowList()
                         { }

    void                 lock()
                         { myLock.lock(); }
    void                 unlock()
                         { myLock.unlock(); }
    void                 addWindow(RE_Window *w)
                         { lock(); myWindows.append(w); unlock(); }
    void                 removeWindow(RE_Window *w)
                         { lock(); myWindows.findAndRemove(w); unlock(); }
    int                  getNumWindows() const
                         { return myWindows.entries(); }
    RE_Window           *getWindow(int index) const
                         { return myWindows(index); }
    void                 removeWindow(RE_IDType wid);
    RE_Window           *isWindowHere(RE_IDType wid);

private:
    UT_ValArray<RE_Window *>     myWindows;
    UT_Lock                      myLock;
};

#endif