basescenenode.h

Go to the documentation of this file.

//--- < BASESCENENODE.H > -------| ViewGraph - A Flexible Graph view Framework |
//
// This is the base class in a scene tree.
// Base scene nodes can paint and get the
// bounding rectangle.
// 
// $Author: botik32 $
// $Revision: 1.5 $
// $Date: 2004/06/02 08:03:55 $
//-----------------------------------------------------------------------------/

#ifndef BASESCENENODE_H
#define BASESCENENODE_H

#include <map>
#include <cZUI/eventhub.h>
#include <cZUI/eventlistener.h>

class Camera;
class SceneNode;
class Message;
class Event;
class RepaintEvent;
class MouseEvent;

class BaseSceneNode : public EventHub, public EventListener
{
protected:
        bool check_event_fitsrect( Event * e );
        bool check_node_visible( Event * e );
        // the resize map below is used to store node size
        // if it has been changed.
        static std::map<BaseSceneNode*,double> resize_map;
        void resize( double newsize );
        double get_size( void );
public:
        /// This function should be overloaded in every node 
        /// to provide for event handling and repaint.
        virtual void get_boundrect( double&, double&, double&, double& )=0;
        /// This function is used to compute scene bounds.
        /// Certain types of nodes, e.g. HUDGroups will return
        /// an invalid rect here. <br>
        /// get_boundrect() is aliased to get_boundrect in BaseSceneNode
        /// and there is normally no need to override it.
        virtual void get_scenerect( double&, double&, double&, double& );
        
        /// call the base event handler in all nodes because it
        /// provides checks for node visibility and mouse event
        /// fitting into bounding rectangle.
        virtual bool handle_event( Event * );

        /// messages are intended to a certain node but can be
        /// processed by nodes directly higher up (i.e. decorator
        /// nodes). Beware that this can be slow for large graphs
        /// but using smart group nodes can help.
        virtual bool handle_message( Message * );

        /// This function should be overloaded in every node 
        /// to provide for event handling.
        virtual bool check_event_fitspixels( Event * )=0;

        /// this one always returns NULL for BaseSceneNode.
        /// SceneNode and GroupNode override this function.
        virtual BaseSceneNode* get_child( void );

        virtual void translate( double dx, double dy ){};
        virtual void rotate( double ax, double ay, double rad ){};
        virtual void move( double newx, double newy ){};

        virtual ~BaseSceneNode();
};

#endif

/// $Log: basescenenode.h,v $
/// Revision 1.5  2004/06/02 08:03:55  botik32
/// Removed fitsall bool from GroupNode
/// Added get_scenerect() to BaseSceneNode
/// Added get_scenerect() to HUDGroupNode
/// Added recompute_scenerect() to GroupNode
/// Changed GroupNode's recompute_boundrect behaviour to
/// accept FitAllRect bounds again
///
/// Revision 1.4  2004/05/05 07:10:14  botik32
/// Added ContainerNode class for simple element selection/unselection
/// 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/18 12:58:31  botik32
/// Changes to groupnode's handling of events.
/// This speeds up the framework tremendously but
/// breaks a few things.
///
/// 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.11  2003/12/30 17:10:31  botik
/// more fixes to remove memory leaks
///
/// Revision 1.10  2003/11/29 16:11:23  botik
/// Added event listener support to basescenenode and camera
/// classes
///
/// Revision 1.9  2003/11/28 22:12:12  botik
/// Added size storing for basescenenode so that
/// hud nodes draw appropriately
///
/// Revision 1.8  2003/11/18 11:23:12  botik
/// Fixed a bug in scenenode that mucked message passing
/// Removed some old handlers from basescenenode that caused
/// problems with repainting under a group
/// Groups work now okay.
///
/// Revision 1.7  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.6  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.5  2003/11/12 18:14:25  botik
/// Got the framework to check scene nodes for viewport fit
/// before painting.
///
/// Revision 1.4  2003/11/11 15:30:58  botik
/// Added and compiled second framework test,
/// fixed along a few bugs.
///
/// Revision 1.3  2003/11/09 15:23:01  botik
/// Got GraphDisplay to compile and run.
///
/// Revision 1.2  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.1  2003/11/06 13:35:57  botik
/// Moved leafnode to basescenenode and removed cached
/// boundrect stuff from leafnode. Boundrect will be
/// moved to an optimizedgroupnode.
///

---