SoViewerProxy.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_VIEWER_PROXY_H
#define SO_VIEWER_PROXY_H

 
#include "InventorWrapperDllInit.h"
#include <ThirdPartyWarningsDisable.h>
#include <Inventor/SbBasic.h>
#include <ThirdPartyWarningsRestore.h>
 
#include <mlFields.h>
 
class SoMetaInformationMap;

class INVENTORWRAPPER_API SoViewerProxy
{
public:
    virtual ~SoViewerProxy() {}

    enum cursorShapeEnum {
        UNDEFINED_CURSOR = -1,
        DEFAULT_CURSOR = 0,
        FORBIDDEN_CURSOR,
        POINTING_HAND_CURSOR,
        OPEN_HAND_CURSOR,
        CLOSED_HAND_CURSOR,
        MOVE_ALL_CURSOR,
        MOVE_HORI_CURSOR,
        MOVE_VERT_CURSOR,
        MOVE_FDIAG_CURSOR,
        MOVE_BDIAG_CURSOR,
        MOVE_INOUT_CURSOR,
        ROTATE_X_CURSOR,
        ROTATE_Y_CURSOR,
        ROTATE_Z_CURSOR,
        ROTATE_XY_CURSOR,
        ZOOM_CURSOR,
        ZOOM_IN_CURSOR,
        ZOOM_OUT_CURSOR,
        CROSS_CURSOR,
        CROSS_PLUS_CURSOR,
        CROSS_MINUS_CURSOR,
        CROSS_MOVE_CURSOR,
        CROSS_ROTATE_CURSOR,
        CROSS_RECT_CURSOR,
        CROSS_OVAL_CURSOR,
        CROSS_VECTOR_CURSOR,
        CROSS_FREEFORM_CURSOR,
        CROSS_POINT_CURSOR,
        CROSS_LINE_CURSOR,
        CROSS_CURVE_CURSOR,
        CROSS_POLYLINE_CURSOR,
        CROSS_POLYGON_CURSOR,
        CROSS_FILL_CURSOR,
        CROSS_LINK_CURSOR,
        CROSS_0_CURSOR,
        CROSS_1_CURSOR,
        CROSS_2_CURSOR,
        CROSS_3_CURSOR,
        CROSS_4_CURSOR,
        CROSS_5_CURSOR,
        CROSS_6_CURSOR,
        CROSS_7_CURSOR,
        CROSS_8_CURSOR,
        CROSS_9_CURSOR,
        LUT_CURSOR,
        LUT_1_CURSOR,
        LUT_2_CURSOR,
        LUT_3_CURSOR,
        SLICING_CURSOR,
        BLANK_CURSOR,
        OTHER_CURSOR_0,
        OTHER_CURSOR_1,
        OTHER_CURSOR_2,
        OTHER_CURSOR_3,
        OTHER_CURSOR_4,
        OTHER_CURSOR_5,
        OTHER_CURSOR_6,
        OTHER_CURSOR_7,
        OTHER_CURSOR_8,
        OTHER_CURSOR_9,
        OTHER_CURSOR_10,
        OTHER_CURSOR_11,
        OTHER_CURSOR_12,
        OTHER_CURSOR_13,
        OTHER_CURSOR_14,
        OTHER_CURSOR_15,
        OTHER_CURSOR_16,
        OTHER_CURSOR_17,
        OTHER_CURSOR_18,
        OTHER_CURSOR_19,
        OTHER_CURSOR_20,
        OTHER_CURSOR_21,
        OTHER_CURSOR_22,
        OTHER_CURSOR_23,
        OTHER_CURSOR_24,
        OTHER_CURSOR_25,
        OTHER_CURSOR_26,
        OTHER_CURSOR_27,
        OTHER_CURSOR_28,
        OTHER_CURSOR_29,
        OTHER_CURSOR_30,
        OTHER_CURSOR_31,
        OTHER_CURSOR_32,
        OTHER_CURSOR_33,
        OTHER_CURSOR_34,
        OTHER_CURSOR_35,
        OTHER_CURSOR_36,
        OTHER_CURSOR_37,
        OTHER_CURSOR_38,
        OTHER_CURSOR_39,
        OTHER_CURSOR_40,
        OTHER_CURSOR_41,
        OTHER_CURSOR_42,
        OTHER_CURSOR_43,
        OTHER_CURSOR_44,
        OTHER_CURSOR_45,
        OTHER_CURSOR_46,
        OTHER_CURSOR_47,
        OTHER_CURSOR_48,
        OTHER_CURSOR_49,
        OTHER_CURSOR_50,
        OTHER_CURSOR_51,
        OTHER_CURSOR_52,
        OTHER_CURSOR_53,
        OTHER_CURSOR_54,
        OTHER_CURSOR_55,
        OTHER_CURSOR_56,
        OTHER_CURSOR_57,
        OTHER_CURSOR_58,
        OTHER_CURSOR_59,
        OTHER_CURSOR_60,
        OTHER_CURSOR_61,
        OTHER_CURSOR_62,
        OTHER_CURSOR_63,
        OTHER_CURSOR_64,
        OTHER_CURSOR_65,
        OTHER_CURSOR_66,
        OTHER_CURSOR_67,
        OTHER_CURSOR_68,
        OTHER_CURSOR_69,
        PREDEFINED_CURSOR_COUNT
    };

    static const char * const * cursorShapeNames();

    static int getPredefinedCursorCount();

    static const ml::EnumValues<cursorShapeEnum>& getCursorShapeEnumValues();

    virtual void setCursor (int /*shapeID*/) {}

    virtual bool hasShape (int shapeID);

    static int getNextFreeShapeID();

    virtual int defineCursor (const char* /*cursorImgFileName*/,
                              int /*hotSpotX*/ = -1, int /*hotSpotY*/ = -1, int /*id*/ = -1) { return -1; }

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

    virtual bool isInitialRendering() const { return false; }

    virtual bool isHighQualityOffscreenRendering() const { return false; }

    virtual bool isUserInterationEventInQueue() const { return false; }

    virtual SoMetaInformationMap* getMetaInformationMap() { return nullptr; }

    virtual double getDevicePixelRatio() { return 1.0; }

    virtual void setForceCursor(int shapeID) { setCursor(shapeID); }
 
protected:
    SoViewerProxy() {}
};
 
class INVENTORWRAPPER_API SoResolutionIndependentViewerProxy : public SoViewerProxy
{
public:
  SoResolutionIndependentViewerProxy();
  ~SoResolutionIndependentViewerProxy() override {}

  double getDevicePixelRatio() override;
 
SoINTERNAL public:
  void setDevicePixelRatio(double scaleFactor);
 
protected:
  double _devicePixelRatio;
};
 
/*
Code fragments to define your own cursor:
 
Simple (but slightly wrong way):
 
    // in constructor
    myCursor = -1;
 
    // when setting cursor:
    SoViewerProxy* viewerProxy = SoViewerElement::get (action->getState());
    if (viewerProxy) {
        if (myCursor == -1) {
            myCursor = viewerProxy->defineCursor ("images/myCursor.png", 5, 7);
        }
        viewerProxy->setCursor (myCursor);
    }
 
 
Better:
 
    // in constructor
    myCursor = SoViewerProxy::getNextFreeShapeID();
 
    // when setting cursor:
    SoViewerProxy* viewerProxy = SoViewerElement::get (action->getState());
    if (viewerProxy) {
        viewerProxy->defineCursor ("images/myCursor.png", 5, 7, myCursor);  // does nothing after the first time!
        viewerProxy->setCursor (myCursor);
    }
 
If only using pre-defined cursor shapes:
 
    // when setting cursor:
    SoViewerElement::setCursor (action->getState(),
                                SoViewerProxy::MOVE_ALL_CURSOR); // no pointer check necessary
 
 
If you want to make the cursor shape accessible through a SoField declare it like this:
 
    SO_NODE_ADD_FIELD(cursorShape, (SoViewerProxy::UNDEFINED_CURSOR));
    SO_NODE_DEFINE_CURSOR_SHAPE_ENUM(SoViewerProxy::cursorShapeEnum);
    SO_NODE_SET_SF_ENUM_TYPE(cursorShape, SoViewerProxy::cursorShapeEnum);
 
and set it like this:
 
    SoViewerElement::setCursor (action->getState(), cursorShape.getValue());
 
 
*/
 
#endif // __SOVIEWERPROXY_H