LargeDisplayEvent Class Reference

#include <LargeDisplayEvent.h>

Collaboration diagram for LargeDisplayEvent:

Collaboration graph
[legend]
List of all members.

Public Member Functions

 LargeDisplayEvent (unsigned int typeId=0, unsigned int userId=0, float x=0, float y=0, float z=0, VisComponent *senderComponent=NULL, unsigned int evtState=1)
virtual ~LargeDisplayEvent (void)
unsigned int getType ()
void setType (unsigned int t)
unsigned int getUserID ()
void setUserID (unsigned int user)
VisComponentgetSender ()
void setSender (VisComponent *c)
Point3f getCoords ()
void setCoords (Point3f p)
float getX ()
void setX (float value)
float getY ()
void setY (float value)
float getZ ()
void setZ (float value)
unsigned int getState ()
void setState (unsigned int value)
void print ()

Protected Attributes

unsigned int type
unsigned int userID
VisComponentsender
Point3f coords
unsigned int state

Detailed Description

This class provides a base for events in the Large Display Framework. In this base case, the only data available is the event type, the identifier of the user who produced the event, and the coordinates of the event. If more data is needed this class should be extended by the application.

Author:
Fabricio Anastacio - fabriciocfa@yahoo.com
Since:
October 1, 2007


Constructor & Destructor Documentation

LargeDisplayEvent::LargeDisplayEvent ( unsigned int  typeId = 0,
unsigned int  userId = 0,
float  x = 0,
float  y = 0,
float  z = 0,
VisComponent senderComponent = NULL,
unsigned int  evtState = 1 
)

Constructs an event object for the large display framework.

Parameters:
typeId the identifier of the type of this event.
userId the identifier of the user who produced this event.
x the x-coordinate of this event.
y the y-coordinate of this event.
z the z-coordinate of this event.

LargeDisplayEvent::~LargeDisplayEvent ( void   )  [virtual]

Destroys this event.


Member Function Documentation

unsigned int LargeDisplayEvent::getType (  )  [inline]

Returns the type identifier of this event.

Returns:
the type identifier of this event.

void LargeDisplayEvent::setType ( unsigned int  t  )  [inline]

Sets the type identifier of this event.

Parameters:
t the type identifier of this event.

unsigned int LargeDisplayEvent::getUserID (  )  [inline]

Returns the identifier of the user that generated this event.

Returns:
the identifier of the user that generated this event.

void LargeDisplayEvent::setUserID ( unsigned int  user  )  [inline]

Sets the identifier of the user that generated this event.

Parameters:
user the identifier of the user that generated this event.

VisComponent* LargeDisplayEvent::getSender (  )  [inline]

Returns a reference to the component that generated this event (if not a user).

Returns:
a reference to the component that generated this event.

void LargeDisplayEvent::setSender ( VisComponent c  )  [inline]

Sets the component that is generating this event (if not a user).

Parameters:
c the component that is generating this event.

Point3f LargeDisplayEvent::getCoords (  )  [inline]

Returns the 3D coordinates of this event.

Returns:
the 3D coordinates of this event.

void LargeDisplayEvent::setCoords ( Point3f  p  )  [inline]

Sets the 3D coordinates of this event.

Parameters:
p the 3D coordinates of this event.

float LargeDisplayEvent::getX (  )  [inline]

Returns the x-coordinate of this event.

Returns:
the x-coordinate of this event.

void LargeDisplayEvent::setX ( float  value  )  [inline]

Sets the the x-coordinate of this event.

Parameters:
value the x-coordinate of this event.

float LargeDisplayEvent::getY (  )  [inline]

Returns the y-coordinate of this event.

Returns:
the y-coordinate of this event.

void LargeDisplayEvent::setY ( float  value  )  [inline]

Sets the the y-coordinate of this event.

Parameters:
value the y-coordinate of this event.

float LargeDisplayEvent::getZ (  )  [inline]

Returns the z-coordinate of this event.

Returns:
the z-coordinate of this event.

void LargeDisplayEvent::setZ ( float  value  )  [inline]

Sets the the z-coordinate of this event.

Parameters:
value the z-coordinate of this event.

unsigned int LargeDisplayEvent::getState (  )  [inline]

Returns the state of this event.

Returns:
the state of this event.

void LargeDisplayEvent::setState ( unsigned int  value  )  [inline]

Sets the the state of this event.

Parameters:
value the state of this event.

void LargeDisplayEvent::print (  ) 

Prints the contents of this event object for debugging purposes.


Member Data Documentation

unsigned int LargeDisplayEvent::type [protected]

The type identifier of this event.

unsigned int LargeDisplayEvent::userID [protected]

The identifier of the user that generated this event.

VisComponent* LargeDisplayEvent::sender [protected]

The reference to the component that generated this event (if not a user).

Point3f LargeDisplayEvent::coords [protected]

The 3D coordinate of this event.

unsigned int LargeDisplayEvent::state [protected]

Determines the state of the event.


The documentation for this class was generated from the following files:
Generated on Fri Dec 21 17:43:50 2007 for LargeDisplayFramework by  doxygen 1.5.2