scrollableview.h

Go to the documentation of this file.

//--- < SCROLLABLEVIEW.H > ------| ViewGraph - A Flexible Graph view Framework |
//
// Abstraction of a viewport, handles 
// scrolling. Redirects drawing calls to
// SurfaceDriver, shifting the parameters.
//
// Use this class when you do not need
// zooming.
//
// $Author: botik32 $
// $Revision: 1.6 $
// $Date: 2004/05/19 16:40:36 $
//-----------------------------------------------------------------------------/

#ifndef SCROLLABLEVIEW_H
#define SCROLLABLEVIEW_H

#include <cZUI/drivers/surfacedriver.h>

class Event;
class Image;

class ScrollableView{
protected:      
        SurfaceDriver *sdriver;
        /// View's absolute position on the virtual canvas.
        double posx, posy;
        /// View's position on the surface
        int screenx, screeny;
        /// View's size on the surface
        int width, height;
        /// View's background color
        unsigned char bkgr,bkgg,bkgb;
        bool brepaint_due;
public:
        virtual void pen( unsigned char r, unsigned char g, 
                unsigned char b, int thickness );
        virtual void get_pen( unsigned char& r, unsigned char& g, 
                unsigned char& b, int& thickness );
        void penstyle( const char *style );
        virtual void line(      double x1, double y1, double x2, double y2 );
        virtual void rectangle( double x1, double y1, double x2, double y2 );
        virtual void dot( double x1, double y1 );
        virtual void circle( double x1, double y1, double radius );
        virtual void arc( double x1, double y1, double radius,
                double an1, double an2 );
        virtual void bezier( double x1, double y1, double x2, double y2, 
                                 double x3, double y3 );
        virtual void fill_h_triangle( double x1, double y1, 
                                 double x2, double y2, double x3 );
        virtual void fill_v_triangle( double x1, double y1, 
                                 double x2, double y2, double y3 );
        virtual void fillrect( double x1, double y1, double x2, double y2,
                unsigned char fr, unsigned char fg, unsigned char fb );
        
        virtual void repaint( void );
        virtual void clear( void );
        virtual void repaint_surface( void );
        virtual void clear_surface( void );
        virtual void clear_rect( double, double, double, double );
        virtual void repaint_rect( double, double, double, double );

        // Direct repaints, no scroll/zoom transforms
        void clear_rect_x( double, double, double, double );
        void repaint_rect_x( double, double, double, double );

        virtual void textout( double x1, double y1, const char *text );
        virtual void textrect( double x1, double y1,
                    double x2, double y2, const char *text );
        virtual void setfontsize( double );
        void setjustification( textjustify );
        void setfont( const char * );

        void scroll_to( double x, double y );
        virtual void scroll( double xinc, double yinc );
        virtual void center( double xpos, double ypos );

        double get_x( void );
        double get_y( void );
        virtual void get_rect( double&, double&, double&, double& );

        // this returns the view rect
        void get_screenrect( double&, double&, double&,
                                                                 double& );
        // this returns the surface rect (0,0,srf->w,srf->h)
        void get_surfacerect( double&, double&, double&,
                                                                 double& );
        int get_width( void );
        int get_height( void );

        virtual bool rectfits( double, double, double, double );

        int get_screenx( void );
        int get_screeny( void );

        // Cursor functions
        void setcursor( SurfaceCursor * );
        SurfaceCursor* getcursor( void );
        void showcursor( bool );

        // The two functions below cannot be used
        // in embedded scene objects because they
        // are not aware of embedding.
        void get_mousepos( int&, int& );
        void get_scenemousepos( double&, double& );
        msbutton get_mousestate( void );

        void enqueue_event( Event * );

        Image* load_image( const char * );
        virtual void put_image( Image *, int destx, int desty,
                double imgz=1.);

        void repaint_due( void )
        {
                brepaint_due = true;
        };

        ScrollableView( SurfaceDriver *, int, int, int, int,
                unsigned char, unsigned char, unsigned char );
};

#endif

/// $Log: scrollableview.h,v $
/// Revision 1.6  2004/05/19 16:40:36  botik32
/// Bugfixes and enhancements:
/// Added repaint_due() and brepaint_due to ScrollableView
/// Fixed repaint decisions in GraphWindow to work for multiple-window
/// scenes
/// Fixed ScrollableView to call surfacedriver->clear() in constructor
/// Changed mapchooser to use a smaller resolution world map
///
/// Revision 1.5  2004/05/03 21:02:01  botik32
/// Significant changes and many bugfixes.
/// ScrollableView now has a background color used to
/// tell SurfaceDriver to clear with.
/// SurfaceDriver's clear() requires a color now
/// Added SceneEvents for all node additions/removals
/// in GroupNode and Camera.
/// Added paint_selected and paint_selected_invalid
/// to ActiveLeaf
/// Modified ActiveLeaf's mouse_down and mouse_up
/// handler signatures to accept an Event* instead of
/// Camera*
/// - Many more bugfixes
///
/// Revision 1.4  2004/04/29 09:50:48  botik32
/// Fixed the zoomablesurfaceview's put_image to work
/// correctly with zooms.
/// Moved convert_image_to16() from SurfaceDriver to Image. It
/// is now called convert_to_565()
/// Fixed bug in rgb24.cpp including rgb24.h in the wrong location
/// Finished code zoom in ZoomableSurfaceView, not tested
///
/// Revision 1.3  2004/04/15 10:31:29  botik32
/// Interface change: added arc() function to surfacedriver.
///
/// Revision 1.2  2004/04/09 17:15:08  botik32
/// Changes in interface: added get_pen to scrollableview and
/// surfacedriver
///
/// Revision 1.1.1.1  2004/03/26 10:50:24  botik32
/// Initial release
///
/// Revision 1.1.1.1  2004/03/26 08:53:33  botik
/// initial import
///
///
/// Revision 1.33  2004/03/17 09:56:38  botik
/// Demo now shows camera in the small window
/// ScrollableView: added clear_surface() and update_surface()
///   functions
/// GraphWindow: calls clear_surface() and update_surface() on update.
///
/// Revision 1.32  2004/01/03 19:59:41  botik
/// added text support via aedGUI
///
/// Revision 1.31  2003/12/12 11:32:33  botik
/// Added drivers/mouse.h
/// Moved msbutton definition to drivers/mouse.h
/// Added get_mousestate to SurfaceDriver
/// Added get_mousestate to ScrollableView
/// Changed the zoom decorator to only receive events if
/// the left mouse is pressed
/// Moved scroll layer beneath the zoom decorator layer
/// This hopefully fixes a segfault when zoomdecorator gets
/// invalid position after scroll
///
/// Revision 1.30  2003/12/04 01:02:14  botik
/// Added Image class to framework
/// Added SDLImage class to drivers/sdxpsdl
/// Added load_image to surfacedriver class
/// Added put_image to surfacedriver class
/// Added load_image and put_image to scrollableview class
///
/// Revision 1.29  2003/12/02 14:39:37  botik
/// Changed the repaint strategy to always repaint the scene
/// Added Context class to handle context-related data for
/// scene nodes
/// Added get_surfacerect() to ScrollableView
/// Camera, Scene and GraphWindow now inherit from Context
/// Changed activeleaf to use Scene context to store hover
/// status
///
/// Revision 1.28  2003/11/29 09:41:03  botik
/// Added scroll_to to scrollableview. (not used yet)
/// Changed testeasynode to zoom in and out
/// Fixed a bug in camera that repainted the wrong rect
/// (changed repaint_rect to repaint_screenrect in
/// cameramvevent handling)
/// Fixed a bug in the test module hudcontrols.cpp that
/// painted hud controls with thickness 1 regardless of
/// zoom level.
///
/// Revision 1.27  2003/11/25 13:01:03  botik
/// Changed the flawed way scene node's requests were
/// handled in ZoomableSurfaceView. This fixes a bad bug
/// with HUD nodes moving all over the place.
/// Added CameraZoomedMessage and CameraScrolledMessage
/// Replaced the TranslateNodeMEssage with
/// CameraScrolledMessage in HUDGroupNode. This fixed
/// a HUD flicker bug.
/// Simplified repaint and clear handling in GraphWindow.
/// This fixed a few bugs in repainting.
/// Added rect bounds checking in ScrollableView's
/// clear_rect and repaint_rect. This fixed cameras to only
/// clear their rectangle even if the view holds a larger
/// area.
/// Changed ActiveLeaf to use default paint function if
/// the payload of CameraRepaintLeafMessage is empty. This
/// will allow repaints of moved nodes.
/// Changed LayerNode to allow CameraMovement events even
/// if the layer is inactive. This will update existing HUD
/// controls' position on inactive layers so they do not move
/// astray during scrolls.
/// This is an intermediate change; mouseover checks do not work.
///
/// Revision 1.26  2003/11/24 20:45:29  botik
/// Merged four features from surfacecamera into camera.
/// Modified ScrollableView to hold a width/height of
/// the viewport and to report it to whoever asks.
/// Added scenex, sceney fields to Event.
/// Added coordinate transform for all messages, done
/// at camera level. This should speed up drawability
/// and mouseover checks.
///
/// Repaint and mouse detection work now over arbitrary
/// magnification.
/// Borderlayer is broken and scrolling segfaults in
/// a weird way.
///
/// Revision 1.25  2003/11/20 18:40:48  botik
/// Got borderlayer to work satisfactory.
/// Changed xpsdl driver to check bounds
/// on rect update and clear
///
/// Revision 1.24  2003/11/20 00:32:41  botik
/// Changed the way repaint works by using a screen
/// rectangle as intermediate event.
/// Added get_screenrect to Camera
/// Added screen2scenerect to Camera
///
/// Revision 1.23  2003/11/18 17:47:20  botik
/// Added triangle fill function to surface driver
/// and views
///
/// Revision 1.22  2003/11/18 13:54:06  botik
/// Got the borderlayer to scroll well.
///
/// Revision 1.21  2003/11/17 23:38:45  botik
/// Fixed the framework to work with multiple cameras on
/// one window. There is a clear bug that does not clear
/// the upper camera.
/// Changed scrolling to remove flicker when multiple
/// cameras are present on a window.
/// Scrolling is still slow.
///
/// Revision 1.20  2003/11/17 18:39:37  botik
/// Added rectangle to surface driver.
/// Sdxpsdl line and rectangle bugfixes
///
/// Revision 1.19  2003/11/17 13:46:34  botik
/// Removed default cursor from scrollableview
/// Changed message handling behaviour for GroupNode
///     to recognize broadcast messages
/// Changed message handling behaviour for BaseSceneNode
///     to recognize broadcast messages
/// Added NodeTranslateMessage to message module
/// Added handling of NodeTranslateMessage for LeafNode
///
/// Revision 1.18  2003/11/15 16:45:18  botik
/// Added ActiveLeaf node allowing for much easier scene
/// node creation.
/// Added default_cursor to scrollableview.
/// Numerous bugfixes.
/// MouseIn/Out now changes cursor.
///
/// Revision 1.17  2003/11/14 16:14:55  botik
/// Fixed circle magnification bug
///
/// Revision 1.16  2003/11/13 18:50:18  botik
/// Fixed (almost) clear and update rect behaviour.
/// Added update_rect to framework and sdl wrapper.
/// Added mouse_in/mouse_out handling
/// Fixed message handling
/// Many small bugfixes
///
/// Revision 1.15  2003/11/13 12:50:51  botik
/// Refined the event handling architecture
/// Got the event handling to recognize and treat mouse
/// events accordingly
/// Important fixes to ./Makefile
///
/// Revision 1.14  2003/11/12 18:14:25  botik
/// Got the framework to check scene nodes for viewport fit
/// before painting.
///
/// Revision 1.13  2003/11/12 12:04:27  botik
/// Further refinements of contrib/borderlayer,
/// added inner event generation to view and surface
/// classes,
/// a few minor bugfixes
///
/// Revision 1.12  2003/11/12 00:47:31  botik
/// Further work on getting repaints to work, tested with
/// scrolling
///
/// Revision 1.11  2003/11/11 23:18:31  botik
/// Got sdlxp driver to work, fixed a few architecture
/// errors and some bugs
///
/// Revision 1.10  2003/11/11 15:30:58  botik
/// Added and compiled second framework test,
/// fixed along a few bugs.
///
/// Revision 1.9  2003/11/09 18:05:37  botik
/// Contrib/borderlayer works! Fixed a lot of small bugs.
///
/// Revision 1.8  2003/11/09 15:23:01  botik
/// Got GraphDisplay to compile and run.
///
/// Revision 1.7  2003/11/08 23:45:54  botik
/// Got the framework to compile, in order to do that
/// filled in some functions and added some empty
/// ones as well.
///
/// Revision 1.6  2003/11/04 14:59:40  botik
/// Further refined the event handling. This is
/// related to the SDL event driver addition
///
/// Revision 1.5  2003/10/28 15:43:55  botik
/// More work on event framework and camera composition and
/// z-ordering
///
/// Revision 1.4  2003/10/21 17:39:00  botik
/// Added preliminary scene support
///
/// Revision 1.3  2003/10/15 11:58:05  botik
/// With the addition of object display, graphdisplay has been
/// modified. ObjectDisplay's interface has been coded. Some
/// changes to scrollable view have been introduced that relate
/// to the changes above.
///
/// Revision 1.2  2003/10/13 16:46:39  botik
/// Added Log keyword to end.
/// Modified scrollableview.cpp to translate the parameters
/// correctly for most functions.
///

---