MeVis/Foundation/Sources/MLInventorBinding/SoViewerProxy.h

Go to the documentation of this file.

// **InsertLicense** code
//----------------------------------------------------------------------------------

//----------------------------------------------------------------------------------

#ifndef __SoViewerProxy_H
#define __SoViewerProxy_H

#ifndef __InventorWrapperDllInit_H
#include "InventorWrapperDllInit.h"
#endif

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

    enum {
        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,
        PREDEFINED_CURSOR_COUNT
    } cursorShapeEnum;

    static const char * const * cursorShapeNames();

    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 isUserInterationEventInQueue() const { return false; }

protected:
    SoViewerProxy() {}
};

/*
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);
    }

when 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