event.h

Go to the documentation of this file.

//--- < EVENT.H > --------------| ViewGraph - A Flexible Graph view Framework |
//
// Defines the base Event class and a few
// preset events required by ViewGraph
//
// $Author: botik32 $
// $Revision: 1.2 $
// $Date: 2004/05/03 21:02:01 $
//-----------------------------------------------------------------------------/

#ifndef EVENT_H
#define EVENT_H

class Camera;
class BaseSceneNode;

/// Event is the base class for all the events
/// within cZUI.
class Event{
protected:
        /// For input events, context is the camera to handle the event.
        Camera *context;
        /// msg is the kind of event, never to be used directly. See is_type(). 
        const char *msg;
        /// X and Y screen position of the mouse at event time.
        int x, y;
        /// Translated scene coordinates.
        double scenex, sceney;
        /// handled_by is set by the node that accepted the event.
        BaseSceneNode *handled_by;
public:
        Event( Event * );
        Event( const char * );
        Event( Camera *, const char * );
        void assign_context( Camera * );
        void assign_mousepos( int, int );
        void assign_scenepos( double, double );
        void set_handler( BaseSceneNode *hb )
        {
                handled_by = hb;
        };

        Camera* get_context( void );
        const char* get_msg( void );
        BaseSceneNode* get_handler( void )
        {
                return handled_by; 
        };
        int get_x( void );
        int get_y( void );
        double get_scenex( void );
        double get_sceney( void );

        /// Use this as follows: is_type( MouseMoveEvent::type )
        virtual bool is_type( const char * );

        virtual ~Event(){};
};

#include "mouseevent.h"
#include "cameraevent.h"

#endif

/// $Log: event.h,v $
/// Revision 1.2  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.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.10  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.9  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.8  2003/11/04 14:33:44  botik
/// Added button status for mouse events
///
/// Revision 1.7  2003/10/30 13:47:31  botik
/// Broke up event files into 3 categories
///
/// Revision 1.6  2003/10/30 12:29:21  botik
/// moved stdio.h include from event.h into event.cpp
///
/// Revision 1.5  2003/10/29 19:55:05  botik
/// Finished writing and testing the event hierarchy
///
/// Revision 1.4  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.3  2003/10/28 15:43:55  botik
/// More work on event framework and camera composition and
/// z-ordering
///
/// Revision 1.2  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.
///
/// Revision 1.1  2003/10/21 17:39:00  botik
/// Added preliminary scene support
///

---