sttool2.h

Go to the documentation of this file.

/*! \file wx/canvas/sttool2.h
    \brief stack based tools for drawing and editing in a faster manner, but with less document feedback.

    Tools here are drawn directly via the drawing context, and not by first adding them to the document.
    This makes certain feadback drawing from the document impossible, but is much faster.

    \author Klaas Holwerda

    Copyright: 2001-2004 (c) Klaas Holwerda

    Licence: wxWidgets Licence

    RCS-ID: $Id: sttool2.h,v 1.15 2009/05/31 23:37:29 titato Exp $
*/

#ifndef __A2DSTTOOL2_H__
#define __A2DSTTOOL2_H__

#ifndef WX_PRECOMP
#include "wx/wx.h"
#endif

#include <wx/listimpl.cpp>
#include "wx/canvas/sttool.h"

//! base for tools that draw and are stack based.
class A2DCANVASDLLEXP a2dStDrawToolFast: public a2dStDrawTool
{
public:
    //!\param controller Pointer to a a2dStToolContr controller.
    a2dStDrawToolFast( a2dStToolContr* controller );

    //!destructor
    virtual ~a2dStDrawToolFast();

    //! template adepts to style change from outside or not
    void SetAllowModifyTemplate( bool allowModifyTemplate ) { m_AllowModifyTemplate = allowModifyTemplate; }

    //! template adepts to style change from outside or not
    bool GetAllowModifyTemplate() { return m_AllowModifyTemplate; }


protected:

    //!Create the editcopy and other tool objects (e.g. decorations)
    /*! m_original must be set before this function is called */
    virtual bool CreateToolObjects();
    virtual void CleanupToolObjects();
    void Render();

public:

    DECLARE_CLASS( a2dStDrawToolFast )
    DECLARE_EVENT_TABLE()
};


//!Interactive Zooming.
/*! Use mouse to drag a rectangle to zoom into area.

\remark  Left Click and/or drag.
\remark  Right Click for zoom popup.
\remark  Double Left Click for zoom out.

\sa  a2dStToolContr

  \ingroup  tools
*/
class A2DCANVASDLLEXP a2dZoomFast: public a2dStTool
{
public:

    //! push this tool on the tools stack
    /*! \ingroup commandid
    */
    static const a2dCommandId COMID_PushTool_ZoomFast;

    //! constructor
    a2dZoomFast( a2dStToolContr* controller );

    //! constructor
    a2dZoomFast( const a2dZoomFast& other, CloneOptions options, a2dRefMap* refs );

    //! destructor
    ~a2dZoomFast();

    bool ZoomSave() {return true;};

protected:

    virtual a2dObject* DoClone( CloneOptions options, a2dRefMap* refs ) const;

    virtual void GenerateAnotation();
    void Render();

    //! character handling
    void OnChar( wxKeyEvent& event );

    void OnMouseEvent( wxMouseEvent& event );

    virtual wxString GetCommandGroupName() { return _( "Zoom objects" ); }

public:

    DECLARE_CLASS( a2dZoomFast )
    DECLARE_EVENT_TABLE()

};


//!Interactive Selection of an Object.
/*!Either with just one click or draging a rectangle to select many.

\remark  Left Click and/or drag.
\remark  Shift Down to Un select.

\sa  a2dStToolContr

*/
class A2DCANVASDLLEXP a2dFastSelect: public a2dStTool
{
public:

    //! push this tool on the tools stack
    /*! \ingroup commandid
    */
    static const a2dCommandId COMID_PushTool_FastSelect;

    a2dFastSelect( a2dStToolContr* controller );
    ~a2dFastSelect();
    bool ZoomSave() {return true;};
    void SetShiftIsAdd() { m_shift_is_add = true; }

protected:
    void DeselectAll();

    virtual void GenerateAnotation();

    //! character handling
    void OnChar( wxKeyEvent& event );

    void OnMouseEvent( wxMouseEvent& event );

    void Render();

    virtual wxString GetCommandGroupName() { return _( "Fast Select objects" ); }

public:

    DECLARE_CLASS( a2dFastSelect )
    DECLARE_EVENT_TABLE()

    //! false: shift key will unselect, true: shift will add to selection
    bool m_shift_is_add;

};

//!Interactive (De)selection Selection of an Object(s).
/*!Either with just one click or dragging a rectangle to (de)select many.

\remark  Left Click and/or drag.

\sa  a2dStToolContr

*/
class A2DCANVASDLLEXP a2dFastSelect2: public a2dStTool
{
public:

    //! push this tool on the tools stack
    /*! \ingroup commandid
    */
    static const a2dCommandId COMID_PushTool_FastSelect2;

    a2dFastSelect2( a2dStToolContr* controller );
    ~a2dFastSelect2();
    bool ZoomSave() {return true;};

    //! if set true selection is done, when false it is deselect.
    void SetSelectMode( bool select ) { m_selectMode = select; }

protected:

    void SelectAll( bool select );

    virtual void GenerateAnotation();

    //! character handling
    void OnChar( wxKeyEvent& event );

    void OnMouseEvent( wxMouseEvent& event );

    virtual wxString GetCommandGroupName() { return _( "Fast Select objects" ); }

public:

    DECLARE_CLASS( a2dFastSelect2 )
    DECLARE_EVENT_TABLE()

    bool m_selectMode;

};

//!Drag Selected canvasObjects
/*! \sa  a2dStToolContr
    \ingroup  tools
*/
class A2DCANVASDLLEXP a2dFastDragMultiTool: public a2dStTool
{
public:

    //! push this tool on the tools stack
    /*! \ingroup commandid
    */
    static const a2dCommandId COMID_PushTool_FastDragMulti;

    a2dFastDragMultiTool( a2dStToolContr* controller );
    ~a2dFastDragMultiTool();
    bool ZoomSave() { return !GetBusy(); };

    void SetMode( int mode );

    bool StartDragging( int x, int y, a2dCanvasObject* original );

protected:

    void GenerateAnotation();

    void OnChar( wxKeyEvent& event );

    void OnMouseEvent( wxMouseEvent& event );

    void OnIdle( wxIdleEvent& event );

    virtual bool EnterBusyMode();
    virtual void FinishBusyMode();
    virtual void AbortBusyMode();

    //!redirect all mouse events for the canvas to this object
    void CaptureMouse();
    //!release the mouse capture for this object
    void ReleaseMouse();

    //!called for incremental keyboard shifts
    virtual void DragRelative( double x, double y );
    //!render in drag style
    virtual void Render();
    //!This is overriden by copy tools to have a minimum distance between original and copy
    virtual void AdjustShift( double* x, double* y );

    virtual wxString GetCommandGroupName() { return  _( "Move multiple objects" ) ; }
    virtual bool CreateToolObjects();
    virtual void CleanupToolObjects();

    //!the list of selected objects
    a2dCanvasObjectList m_objects;
    a2dCanvasObjectList m_copies;

    double m_startObjectx;
    double m_startObjecty;
    double m_startMousexw;
    double m_startMouseyw;

public:
    DECLARE_CLASS( a2dFastDragMultiTool )
    DECLARE_EVENT_TABLE()

};

//!Drag and Copy Selected canvasObjects
/*!\sa  a2dStToolContr
    \ingroup  tools
*/
class A2DCANVASDLLEXP a2dFastCopyMultiTool: public a2dFastDragMultiTool
{
public:

    //! push this tool on the tools stack
    /*! \ingroup commandid
    */
    static const a2dCommandId COMID_PushTool_FastCopyMulti;

    a2dFastCopyMultiTool( a2dStToolContr* controller );

    bool StartDragging( int x, int y, a2dCanvasObject* original );

protected:

    void OnChar( wxKeyEvent& event );

    void OnMouseEvent( wxMouseEvent& event );

    void FinishBusyMode();

    void AdjustShift( double* x, double* y );

    virtual wxString GetCommandGroupName() { return  _( "Copy multiple objects" ) ; }

    // minimum distance of the copy from the original
    double m_mindist;
public:
    DECLARE_CLASS( a2dFastCopyMultiTool )
    DECLARE_EVENT_TABLE()

};

//!Interactive drawing of a Rectangle.
/*!
\remark  Left Click and drag.
\remark  Cursor keys to shift object.
\remark  Or Spacebar to end rectangle.

\sa  a2dStToolContr

  \ingroup  tools
*/
class A2DCANVASDLLEXP a2dDrawRectangleToolFast: public a2dStDrawToolFast
{
public:

    //! push this tool on the tools stack
    /*! \ingroup commandid
    */
    static const a2dCommandId COMID_PushTool_DrawRectangleFast;

    a2dDrawRectangleToolFast( a2dStToolContr* controller );
    ~a2dDrawRectangleToolFast();

    void SetRadius( double radius )         { m_radius = radius; }

    bool ZoomSave() { return true; }

protected:

    void OnComEvent( a2dComEvent& event );

    void OnMouseEvent( wxMouseEvent& event );

    virtual wxString GetCommandGroupName() { return _( "Draw Rectangle Fast" ); }

    bool CreateToolObjects();

    double m_radius;
    double m_xwlast;
    double m_ywlast;
    bool m_didDraw;

public:
    DECLARE_CLASS( a2dDrawRectangleToolFast )
    DECLARE_EVENT_TABLE()

};

//!Interactive drawing of a Circle.
/*!
\remark  Left Click and drag.
\remark  Cursor keys to shift object.
\remark  Or Spacebar to end line.

\sa  a2dStToolContr
*/
class A2DCANVASDLLEXP a2dDrawCircleToolFast: public a2dStDrawToolFast
{
public:

    //! push this tool on the tools stack
    /*! \ingroup commandid
    */
    static const a2dCommandId COMID_PushTool_DrawCircleFast;

    a2dDrawCircleToolFast( a2dStToolContr* controller );
    bool ZoomSave() { return true;};

    void SetMode( int mode );

protected:

    //! tool specific statusbar
    void OnComEvent( a2dComEvent& event );

    void OnChar( wxKeyEvent& event );

    void OnMouseEvent( wxMouseEvent& event );

    bool CreateToolObjects();

    double       m_start_x;
    double       m_start_y;
    double       m_radius;

public:
    DECLARE_CLASS( a2dDrawCircleToolFast )
    DECLARE_EVENT_TABLE()

};

//!Interactive drawing of a polygon.
/*!
\remark  Left Click to add points.
\remark  Space bar or Double click to end drawing.
\remark  Cursor keys to shift object.
\remark  Cursor keys + control to shift point.
\remark  Right Click to zoom.

\sa  a2dStToolContr

    \ingroup  tools
*/
class A2DCANVASDLLEXP a2dDrawPolygonLToolFast: public a2dStDrawToolFast
{
public:

    //! push this tool on the tools stack
    /*! \ingroup commandid
    */
    static const a2dCommandId COMID_PushTool_DrawPolygonLFast;
    //! push this tool on the tools stack
    /*! \ingroup commandid
    */
    static const a2dCommandId COMID_PushTool_DrawPolygonLFast_Splined;

    //! constructor
    /*!
        \param controller tool controller one which this tool is pushed.
        \param templateObject when not NULL, this object is cloned and used for the new drawn object.
    */
    a2dDrawPolygonLToolFast( a2dStToolContr* controller, a2dPolygonL* templateObject = NULL );

    ~a2dDrawPolygonLToolFast();

    //! save to zoom while drawing
    bool ZoomSave() { return true;};

    //! mode of drawing, can be swicthed with Tab key.
    void SetMode( int mode );

    //!certain drawing tools like polygon drawing use this setting
    /*! You might want to reset m_newObjectsGetCommandProcStyle also.
        Otherwise the command processor will overwrite what you set here
    */
    void SetSpline( bool spline );

    //!certain drawing tools like polygon drawing use this setting
    bool GetSpline() {return m_spline;}

protected:

    void OnIdle( wxIdleEvent& event );

    void OnChar( wxKeyEvent& event );

    void OnMouseEvent( wxMouseEvent& event );

    void OnUndoEvent( a2dCommandProcessorEvent& event );
    void OnRedoEvent( a2dCommandProcessorEvent& event );

    bool CreateToolObjects();

    void AddPoint( a2dLineSegment* point );

    virtual wxString GetCommandGroupName() { return  _( "Draw polygon" ) ; }

    //! object to clone to use as start
    a2dSmrtPtr<a2dPolygonL> m_templateObject;

    //! previous x
    double m_prev_x;
    //! previous y
    double m_prev_y;

    //! points sofar
    a2dVertexList* m_points;

    //! last point
    a2dLineSegment* m_point;

    //! spline polygons
    bool m_spline;

    //! end to begin wire.
    bool m_reverse;

public:
    DECLARE_CLASS( a2dDrawPolygonLToolFast )
    DECLARE_EVENT_TABLE()

};

//!Interactive drawing of a polyline.
/*!
\remark  Left Click to add points.
\remark  Space bar or Double click to end drawing.
\remark  Cursor keys to shift object.
\remark  Cursor keys + control to shift point.
\remark  Right Click to zoom.

\sa  a2dStToolContr

    \ingroup  tools
*/
class A2DCANVASDLLEXP a2dDrawPolylineLToolFast: public a2dDrawPolygonLToolFast
{
public:

    //! push this tool on the tools stack
    /*! \ingroup commandid
    */
    static const a2dCommandId COMID_PushTool_DrawPolylineLFast;
    //! push this tool on the tools stack
    /*! \ingroup commandid
    */
    static const a2dCommandId COMID_PushTool_DrawPolylineLFast_Splined;

    //! constructor
    /*!
        \param controller tool controller one which this tool is pushed.
        \param templateObject when not NULL, this object is cloned and used for the new drawn object.
    */
    a2dDrawPolylineLToolFast( a2dStToolContr* controller, a2dPolylineL* templateObject = NULL );

    ~a2dDrawPolylineLToolFast();

    //!defines line begin object for line and polyline drawing tools
    /*! You might want to reset m_newObjectsGetCommandProcStyle also.
        Otherwise the command processor will overwrite what you set here
    */
    void SetLineBegin( a2dCanvasObject* begin );

    //!defines line end object for line and polyline drawing tools
    /*! You might want to reset m_newObjectsGetCommandProcStyle also.
        Otherwise the command processor will overwrite what you set here
    */
    void SetLineEnd( a2dCanvasObject* end );

    //!get current line begin object for line and polyline drawing tools.
    /*!\return Null if not set. */
    a2dCanvasObject* GetLineBegin() {return m_begin;}

    //!get current line end object for line and polyline drawing tools
    /*!return: Null if not set. */
    a2dCanvasObject* GetLineEnd() {return m_end;}

    //!scaling in X for begin and end objects of linres and polylines
    void SetEndScaleX( double xs ) { m_xscale = xs; }

    //!scaling in Y for begin and end objects of linres and polylines
    void SetEndScaleY( double ys ) { m_yscale = ys; }

    //!get scaling in X for begin and end objects of lines and polylines
    double GetEndScaleX() {return m_xscale;}

    //!get scaling in Y for begin and end objects of lines and polylines
    double GetEndScaleY() {return m_yscale;}

    //! Set when m_contourwidth != 0 what is the end of the line should be.
    void SetPathType( a2dPATH_END_TYPE pathtype );

    //! get when m_contourwidth != 0 what is the end of the line looks like.
    a2dPATH_END_TYPE GetPathType() { return m_pathtype; }

protected:

    bool CreateToolObjects();

    void OnMouseEvent( wxMouseEvent& event );

    void OnDoEvent( a2dCommandProcessorEvent& event );

    //! begin point object for lines and polylines
    a2dCanvasObjectPtr m_begin;

    //! end point object for lines and polylines
    a2dCanvasObjectPtr m_end;

    //!begin point scaling
    double  m_xscale;

    //!end point scaling
    double  m_yscale;

    //! when m_contourwidth != 0 what is the end of the line looking like.
    a2dPATH_END_TYPE m_pathtype;

public:
    DECLARE_CLASS( a2dDrawPolylineLToolFast )
    DECLARE_EVENT_TABLE()

};

#endif /* __A2DSTTOOL2_H__ */