SoQtViewerProxy.h

Go to the documentation of this file.

/*************************************************************************************
**
** Copyright 2007, MeVis Medical Solutions AG
**
** The user may use this file in accordance with the license agreement provided with
** the Software or, alternatively, in accordance with the terms contained in a
** written agreement between the user and MeVis Medical Solutions AG.
**
** For further information use the contact form at https://www.mevislab.de/contact
**
**************************************************************************************/
 
#ifndef SO_QT_VIEWER_PROXY_H
#define SO_QT_VIEWER_PROXY_H
 
#include "InventorGUIWrapperDllInit.h"
 
#include <QCursor>
 
#include <SoViewerProxy.h>
 
#include <Inventor/nodes/SoSubNode.h>
#include <Inventor/nodes/SoGroup.h>
 
class SoQtRenderArea;
class SoAction;
 
class INVENTORGUIWRAPPER_API SoQtViewerProxy : public SoViewerProxy
{
 
    /* This class also implements an easy mechanism to override predefined cursors:
       Put a property called "OverrideCursorDirectory" into your MeVisLab
       preferences file and point it to the directory with the alternative cursors in
       PNG graphics format.
 
       Preferred cursor size is 32x32, the hot spot is always in the middle of the image.
       If you need another hotspot, you can add the hotspot location in the filename
       after an exclamation point (but before the file ending), like
 
       otherCursor11!8,12.png
 
       For support of high resolution displays, add an additional file of size 64x64,
       omitting the hotspot location, like this:
 
       otherCursor11@2x.png
 
       The base file name is usually the name of the enumeration value in lower case
       with the underscores removed and the letters after the underscores in upper case.
       Then append an eventual hotspot location and ".png".
       Exceptions from this rule - with additional upper case letters - are:
         moveFDiagCursor.png
         moveBDiagCursor.png
         moveInOutCursor.png
         rotateXYCursor.png
         crossFreeFormCursor.png
         crossPolyLineCursor.png
    */
 
public:
    SoQtViewerProxy (SoQtRenderArea* renderArea = nullptr);
    ~SoQtViewerProxy() override {}

    void setCursor (int shapeID) override;

    void setForceCursor(int shapeID) override;

    int getCursor() { return _requestedShape; }

    bool hasShape (int shapeID) override;

    int defineCursor (const char* cursorImgFileName, int hotSpotX = -1, int hotSpotY = -1,
                              int id = -1) override;

    static bool forceDefineCursor (int id, const char* cursorImgFileName, int hotSpotX = -1, int hotSpotY = -1);


    virtual void resetCursor();

    virtual void evaluateCursor();

    static void resetCursorCB    (void* userData, SoAction* action);

    static void evaluateCursorCB (void* userData, SoAction* action);

    virtual bool actionMayChangeCursor(SoAction* action);

    bool getCurrentCursorPosition(int& x, int& y) override;

    static void initializeDefaultCursors();

    bool isInitialRendering() const override;

    bool isUserInterationEventInQueue() const override;

    static QCursor getCursor(int shapeID);

    static QPixmap getPixmap(int shapeID);

    static QPixmap getPixmap2x(int shapeID);

    static int getShapeID(const QCursor& cursor);

    static bool isSameCursor(const QCursor& a, const QCursor& b);

    double getDevicePixelRatio() override;
 
protected:
    SoQtRenderArea* _renderArea;

    int _requestedShape;

    bool _cursorEnforced;
};
 
//===========================================================================

class INVENTORGUIWRAPPER_API SoQtViewerProxyNode : public SoGroup
{
  SO_NODE_HEADER(SoQtViewerProxyNode);
 
public:
  SoQtViewerProxyNode(SoQtViewerProxy* proxy = nullptr);
  ~SoQtViewerProxyNode() override {}

  static void initClass();

  void GLRender(SoGLRenderAction *action) override;
  void handleEvent(SoHandleEventAction *action) override;
 
protected:
  SoQtViewerProxy* _proxy;
};
 
 
#endif  // __SoQtViewerProxy_H