camera.h

Go to the documentation of this file.

//--- < CAMERA.H > --------------| ViewGraph - A Flexible Graph view Framework |
//
// This class implements a camera overlooking 
// a portion of the scene.
//
//
// $Author: botik32 $
// $Revision: 1.6 $
// $Date: 2004/06/02 08:36:01 $
//-----------------------------------------------------------------------------/

#ifndef CAMERA_H
#define CAMERA_H

#include <list>
#include <map>
#include <cZUI/zoomableview.h>
#include <cZUI/cameraevent.h>
#include <cZUI/message.h>
#include <cZUI/scene.h>
#include <cZUI/context.h>
#include <cZUI/eventhub.h>
#include <cZUI/eventlistener.h>

class LayerNode;
class SelectionGroupNode;
class BaseGraphWindow;

class Camera : public Context, public EventHub, public EventListener
{
protected:
        char *name;
        bool need_repaint;
        BaseGraphWindow *parent;
        Scene *scene;
        ZoomableView *view;
        ZoomableView *hudview;
        bool HUDmode_on;
        std::list<LayerNode*> layers;
        SelectionGroupNode *selection_handler;
        CameraEvent *status;
        BaseSceneNode *mouse_owner;
        // area taken by visible nodes
        double rx1, ry1, rx2, ry2;
        // initially false, true after first recount
        bool valid_bounds;
        void recompute_visible_area( void );
public:
        Camera( const char *, ZoomableView *, ZoomableView* );
        void assign_parent( BaseGraphWindow * );
        BaseGraphWindow* get_parent( void );

        const char* get_name( void );
        virtual ZoomableView* get_view( void );
        
        void add_selection_handler( SelectionGroupNode * );
        SelectionGroupNode* remove_selection_handler( void );

        // the functions below can be overriden if special
        // behaviour is needed
        
        /// Adds new layer to the front
        virtual void add_layer( LayerNode * );
        virtual void add_layer_first( LayerNode * );
        virtual void add_layer_last( LayerNode * );
        virtual void insert_layer( LayerNode *, LayerNode * );

        // disable/enable layer automatically sends a redraw event
        // to itself
        virtual void disable_layer( LayerNode * );
        virtual void enable_layer( LayerNode * );

        virtual bool handle_event( Event * );
        // A camera redraws its contents on focus/blur events
        virtual bool handle_event( CameraFocusEvent * );
        virtual bool handle_event( CameraBlurEvent * );
        virtual bool handle_message( Message * );
        virtual void listen_event( Event * );

        virtual bool accepts_mouse_events( void );
        
        // dumb scroll
        void scroll_camera( int xmov, int ymov );

        // handle invalidate rect notification from scene nodes
        void invalidate_rect( double, double, double, double );

        // handle repaint rect notification from scene nodes
        void repaint_rect( double, double, double, double );
        void repaint_screenrect( double, double, double, double );

        // mouse_in and mouse_out support
        void register_mouse_owner( BaseSceneNode * );

        bool mousefits( int, int );

        void get_screenrect( double&, double&, 
                double&, double& );
        void screen2scenerect( double&, double&, 
                double&, double& );
        void screen2scenepos( double&, double& );
 
        // Context retrieval functions
        Context* get_window_context( void );
        Context* get_scene_context( void );

        // hud switch function:
        void switch_to_HUD( void );
        void switch_to_view( void );
        bool HUD_status( void ){ return HUDmode_on; };
        void HUD2scenepos( double&, double& );
        void screen2HUDpos( double&, double& );

        // This function is used to specify scroll/zoom
        // borders and supply external scrollers with
        // the size
        void get_visible_area( double& x1, double& y1, 
                double& x2, double& y2 );

        bool needs_repaint( void )
        {
                bool ret = need_repaint;
                return ret;
        };

        ~Camera();
};
#endif

///$Log: camera.h,v $
///Revision 1.6  2004/06/02 08:36:01  botik32
///Fixed a bug in Camera in get_visible_area()
///Added recompute_scenerect() to all node adds/removes
///of GroupNode
///
///Revision 1.5  2004/05/14 18:35:08  botik32
///Fixed a bug related to HUDGroups and a few that I do not
///remember now.
///
///Revision 1.4  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.3  2004/04/30 12:39:21  botik32
///Numerous changes related to making the SceneChangedEvents
///to work.
///- Moved listen_event() from BaseSceneNode to EventListener class
///- Made GroupNode listen to the added children's SceneChangedEvents
///- Changed Camera to listen to layers' SceneChangedEvents
///- Moved eventlistener list cleanup from Camera to EventHub class
///  where it belonged in the first place
///
///Revision 1.2  2004/04/20 08:55:51  botik32
///Major interface change.
///Added HUDView in Camera; switch_to_HUDmode for Camera
///BaseSceneNode: internal implementation changes;
///Major changes in HUDGroup behaviour
///
///Revision 1.1.1.1  2004/03/26 10:50:21  botik32
///Initial release
///
///Revision 1.1.1.1  2004/03/26 08:53:33  botik
///initial import
///
///
///Revision 1.21  2003/12/03 18:48:51  botik
///Split event listener functionality off camera into
///eventhub.
///
///Revision 1.20  2003/12/02 20:09:22  botik
///Changed repaint policy to repaint only when Camera and
///CameraMovement events happened.
///Added CameraUpdatedEvent specifically for this purpose
///so scene nodes can trigger a repaint.
///
///Revision 1.19  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.18  2003/11/29 16:11:23  botik
///Added event listener support to basescenenode and camera
///classes
///
///Revision 1.17  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.16  2003/11/24 16:12:10  botik
///Halfway through major redesign of a view's geometric
///parameters. This will influence zooming and repainting.
///
///Revision 1.15  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.14  2003/11/18 13:54:06  botik
///Got the borderlayer to scroll well.
///
///Revision 1.13  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.12  2003/11/14 16:00:42  botik
///Got camerafocus to ignore cameras in 'Off' state
///Fixed camera to keep latest camera status change
///event as status.
///
///Revision 1.11  2003/11/14 12:09:32  botik
///Added camera->repaint_rect routine.
///
///Revision 1.10  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.9  2003/11/12 00:47:31  botik
///Further work on getting repaints to work, tested with
///scrolling
///
///Revision 1.8  2003/11/11 23:18:31  botik
///Got sdlxp driver to work, fixed a few architecture
///errors and some bugs
///
///Revision 1.7  2003/11/09 18:05:37  botik
///Contrib/borderlayer works! Fixed a lot of small bugs.
///
///Revision 1.6  2003/11/08 18:54:59  botik
///Changed handle_event to return bool
///
///Revision 1.5  2003/10/30 19:42:18  botik
///Filled code for camera member functions
///
///Revision 1.4  2003/10/30 13:47:31  botik
///Broke up event files into 3 categories
///
///Revision 1.3  2003/10/29 10:47:39  botik
///Moved the x,y event position into the base class
///Added has_focus() method and blur/focus event
///handlers to Camera class.
///Added Makefile
///
///Revision 1.2  2003/10/28 15:43:55  botik
///More work on event framework and camera composition and
///z-ordering
///
///Revision 1.1  2003/10/24 16:29:10  botik
///Added more scene support: special scene nodes as well as a
///camera class that acts as glue between the graph master and the
///surface.
///

---