Tool.h

Go to the documentation of this file.

// -*- c-basic-offset: 4 -*-

#ifndef _PREVIEWTOOL_H
#define _PREVIEWTOOL_H

#include "base_wx/wxutils.h"
#include <wx/event.h>

#include "ToolHelper.h"

/* PreviewTool is an abstract base class for the interactive tools that work
 * with the OpenGL accelerated preview. They can respond to the users actions
 * over the preview, or changes in the panorama, and can draw extras above,
 * below, or instead of the panorama images.
 *
 * The *Event functions are only called when the Tool requested a notification.
 * Tools may do this through an instance of the PreviewToolHelper class which
 * is passed by pointer on construction. When a tool is decativated, all the
 * notifications it monitors are removed.
 */
class Tool
{
public:
    explicit Tool(ToolHelper *helper);
    
    virtual ~Tool();
    // Lots of stub functions here. Your tools should override a few of them.
    
    virtual void Activate() = 0;
    virtual void Deactivate() {}
    
    virtual void MouseMoveEvent(double x, double y, wxMouseEvent & e) {}
    virtual void MouseButtonEvent(wxMouseEvent &e) {}
    virtual void MouseWheelEvent(wxMouseEvent & e) {}
    virtual void ImagesUnderMouseChangedEvent() {}
    virtual void KeypressEvent(int keycode, int modifiers, bool pressed) {}
    virtual void BeforeDrawImagesEvent() {}
    virtual void AfterDrawImagesEvent() {}
    virtual void ReallyAfterDrawImagesEvent() {}
    virtual bool BeforeDrawImageEvent(unsigned int image) {return true;}
    virtual void AfterDrawImageEvent(unsigned int image) {}
    virtual void MarkDirty() {};
protected:
    ToolHelper *helper;
};


class PreviewTool : public Tool
{
public:
    explicit PreviewTool(PreviewToolHelper* helper);
    virtual ~PreviewTool();

};

class OverviewTool : public Tool
{
public:

    explicit OverviewTool(OverviewToolHelper* helper);
    virtual ~OverviewTool();

};

class PanosphereOverviewTool : public OverviewTool
{
public:

    explicit PanosphereOverviewTool(PanosphereOverviewToolHelper* helper);
    virtual ~PanosphereOverviewTool();

    virtual void BeforeDrawImagesBackEvent() {}
    virtual void AfterDrawImagesBackEvent() {}

    virtual void BeforeDrawImagesFrontEvent() {}
    virtual void AfterDrawImagesFrontEvent() {}
    
};

class PlaneOverviewTool : public OverviewTool
{
public:

    explicit PlaneOverviewTool(PlaneOverviewToolHelper* helper);
    virtual ~PlaneOverviewTool();

};


#endif