message.h

Go to the documentation of this file.

//--- < MESSAGE.H > -------------| ViewGraph - A Flexible Graph view Framework |
//
// Messages are like events except that the 
// recipient is known.
// Messages can also have a limited scope of
// action.
//
// Defines the base message class and a few
// preset messages required by ViewGraph
//
// $Author: botik32 $
// $Revision: 1.2 $
// $Date: 2004/05/03 21:02:01 $
//-----------------------------------------------------------------------------/

#ifndef MESSAGE_H
#define MESSAGE_H

class Camera;
class BaseSceneNode;

typedef const char* MessageScope;
typedef const char* const ConstMessageScope;

/// Messages are like events except that the 
/// recipient is known. Messages cand be sent
/// to all recipients via BROADCAST.
class Message{
protected:
        Camera *context;
        MessageScope scope;
        const char *msg;
        BaseSceneNode *recipient;
public:
        /// Broadcast address to set recipient 
        /// to
        static BaseSceneNode* const BROADCAST;
        /// Set scope to ALL_CAMERAS to affect 
        /// nodes visible in all cameras.
        static ConstMessageScope ALL_CAMERAS;
        /// Set scope to THIS_WINDOW to affect 
        /// nodes visible in this GraphWindow only
        static ConstMessageScope THIS_WINDOW;
        /// Set scope to THIS_CAMERA to affect 
        /// nodes visible in the context camera only
        static ConstMessageScope THIS_CAMERA;

        Message( Message * );
        Message( const char *, BaseSceneNode * );
        Message( Camera *, const char *, BaseSceneNode * );
        void assign_context( Camera * );
        void assign_scope( MessageScope );

        Camera* get_context( void );
        MessageScope get_scope( void );
        const char* get_msg( void );
        BaseSceneNode* get_recipient( void );

        virtual bool is_type( const char * );

};

/// MouseInMessage is used internally by ActiveLeaf
/// to repaint on hover.
class MouseInMessage : public Message
{
public:
        static const char *type;
        MouseInMessage( Camera *, BaseSceneNode * );
};

/// MouseOutMessage is used internally by ActiveLeaf
/// to repaint on hover.
class MouseOutMessage : public Message
{
public:
        static const char *type;
        MouseOutMessage( Camera *, BaseSceneNode * );
};

/// NodeTranslateMessage is no longer used anywhere.
/// Used to be sent to all the children of a HUDGroupNode.
class NodeTranslateMessage : public Message
{
protected:
        double dx, dy;
public:
        static const char *type;
        NodeTranslateMessage( Camera *, BaseSceneNode *, 
                double, double );
        double get_dx( void );
        double get_dy( void );
};

/// CameraScrollerMessage is no longer used anywhere.
/// Used to be sent to all the children of a HUDGroupNode.
class CameraScrolledMessage : public Message
{
protected:
        double dx, dy;
public:
        static const char *type;
        CameraScrolledMessage( Camera *, BaseSceneNode *, 
                double, double );
        double get_dx( void );
        double get_dy( void );
};

/// CameraZoomedMessage is no longer used anywhere.
/// Used to be sent to all the children of a HUDGroupNode.
class CameraZoomedMessage : public Message
{
protected:
        double new_zoom;
public:
        static const char *type;
        CameraZoomedMessage( Camera *, BaseSceneNode *, 
                double );
        double get_zoom( void );
};

/// CameraRepaintLeafMessage is no longer used.
/// It used to be sent on hover repaints before
/// the logic was changed.
class CameraRepaintLeafMessage : public Message
{
protected:
        // data are passed through and
        // should be freed by the caller upon
        // return
        void *data;
public:
        static const char *type;
        CameraRepaintLeafMessage( Camera *, 
                BaseSceneNode *, void* );
        void* get_data( void );
};

/// SelectMessage is used in ContainerNode to
/// let the selected node know it has been selected.
/// ActiveLeaf is aware of SelectMessages and will
/// change the display if the paint_selected function is 
/// specified.
class SelectMessage : public Message
{
protected:
public:
        static const char *type;
        SelectMessage( Camera *,
                BaseSceneNode* );
};

/// This is the pair event to SelectMessage, is used in 
/// ContainerNode to let the selected node know it has 
/// been selected.
/// ActiveLeaf is aware of Select/UnselectMessages and will
/// change the display if the paint_selected function is 
/// specified.
class UnselectMessage : public Message
{
protected:
public:
        static const char *type;
        UnselectMessage( Camera *,
                BaseSceneNode* );
};

#endif

/// $Log: message.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:23  botik32
/// Initial release
///
/// Revision 1.1.1.1  2004/03/26 08:53:33  botik
/// initial import
///
///
/// Revision 1.6  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.5  2003/11/19 16:14:52  botik
/// Got repaint_rect to work right and changed ActiveLeaf
/// accordingly.
///
/// Revision 1.4  2003/11/19 13:38:47  botik
/// Added emptymessage class
///
/// Revision 1.3  2003/11/17 16:22:41  botik
/// bugfixes in layernode
///
/// Revision 1.2  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.1  2003/11/13 18:50:36  botik
/// Initial check-in
///

---