Base class describing event information for WorldCanvases. More...

#include <WorldCanvasEvent.h>

Inheritance diagram for casa::WorldCanvasEvent:

Public Member Functions
	WorldCanvasEvent (WorldCanvas *wc)
	Constructor, taking a pointer to a WorldCanvas.
virtual	~WorldCanvasEvent ()
	Destructor.
virtual WorldCanvas *	worldCanvas () const
	Return a pointer to the WorldCanvas on which the event occurred.
Protected Member Functions
	WorldCanvasEvent ()
	(Required) default constructor.
	WorldCanvasEvent (const WorldCanvasEvent &other)
	(Required) copy constructor.
WorldCanvasEvent &	operator= (const WorldCanvasEvent &other)
	(Required) copy assignment.
Private Attributes
WorldCanvas *	itsWorldCanvas
	Store the WorldCanvas of the event here at construction.

Detailed Description

Base class describing event information for WorldCanvases.

Intended use:

Internal

Review Status

Date Reviewed:: yyyy/mm/dd

Etymology

"WorldCanvasEvents" describes "Events" (ie. things which happen at a measurable time) which occur on WorldCanvases.

Prerequisite

DisplayEvent

Synopsis

This class adds to the information stored in the DisplayEvent class. It adds information specific to events occuring on WorldCanvases, viz. a pointer to the WorldCanvas itself.

Example

Motivation

It is desirable to locate in a single place the information which is common to all events occuring on WorldCanvases.

Thrown Exceptions

.

Definition at line 79 of file WorldCanvasEvent.h.

Constructor & Destructor Documentation

casa::WorldCanvasEvent::WorldCanvasEvent ( WorldCanvas * wc )

Constructor, taking a pointer to a WorldCanvas.

virtual casa::WorldCanvasEvent::~WorldCanvasEvent ( ) [virtual]

Destructor.

casa::WorldCanvasEvent::WorldCanvasEvent ( ) [protected]

(Required) default constructor.

casa::WorldCanvasEvent::WorldCanvasEvent ( const WorldCanvasEvent & other ) [protected]

(Required) copy constructor.

Member Function Documentation

WorldCanvasEvent& casa::WorldCanvasEvent::operator= ( const WorldCanvasEvent & other ) [protected]

(Required) copy assignment.

virtual WorldCanvas* casa::WorldCanvasEvent::worldCanvas ( ) const [inline, virtual]

Return a pointer to the WorldCanvas on which the event occurred.

Definition at line 90 of file WorldCanvasEvent.h.

References itsWorldCanvas.

Member Data Documentation

WorldCanvas* casa::WorldCanvasEvent::itsWorldCanvas [private]

Store the WorldCanvas of the event here at construction.

Definition at line 107 of file WorldCanvasEvent.h.

Referenced by worldCanvas().

The documentation for this class was generated from the following file:

code/display/DisplayEvents/WorldCanvasEvent.h

Public Member Functions

Protected Member Functions

Private Attributes