Whiteboard
An interface and tools for visualizing large and complex datasets
Public Member Functions | List of all members
ns_whiteboard::display_type Class Referenceabstract

#include <Whiteboard.h>

Inheritance diagram for ns_whiteboard::display_type:
ns_whiteboard::ps_display

Public Member Functions

virtual void DrawPoint (const xy_coords &coord)=0
 
virtual void DrawPoint (double x, double y)=0
 
virtual void DrawLine (const xy_coords &startCoord, const xy_coords &stopCoord)=0
 
virtual void DrawRect (const xy_coords &topLeftCoord, const xy_coords &bottomRightCoord)=0
 
virtual void DrawText (const xy_coords &coords, const string &chars, double rot_angle, double point_size, const vert_align vAlign, const horiz_align hAlign)=0
 
virtual void DrawArc (const xy_coords &coords, const double radius, const double startAngle, const double stopAngle)=0
 
virtual const colorGetColor () const =0
 
virtual void SetColor (const color &C)=0
 
virtual double GetLineWidth () const =0
 
virtual void SetLineWidth (const double width)=0
 
virtual const string & GetFontName () const =0
 
virtual double GetFontSize () const =0
 
virtual void SetFont (const string &font, const double size)=0
 
virtual void Finish ()=0
 
virtual ~display_type ()
 

Detailed Description

An abstract base class that defines the boundaries of the display within the whiteboard. Derived classes know how to draw objects in a particular graphics file format.

Constructor & Destructor Documentation

virtual ns_whiteboard::display_type::~display_type ( )
inlinevirtual

Member Function Documentation

virtual void ns_whiteboard::display_type::DrawArc ( const xy_coords coords,
const double  radius,
const double  startAngle,
const double  stopAngle 
)
pure virtual

Abstract method to draw an arc witin a whiteboard.

Parameters
coordsx-y start coordinate for the arc
radiusradius of curvature for the arc
startAnglestarting angle
stopAnglefinishing angle

Implemented in ns_whiteboard::ps_display.

virtual void ns_whiteboard::display_type::DrawLine ( const xy_coords startCoord,
const xy_coords stopCoord 
)
pure virtual

Abstract method to draw a line within a whiteboard.

Parameters
startCoordstarting x-y coordinate of line
stopCoordstopping x-y coordinate of line

Implemented in ns_whiteboard::ps_display.

virtual void ns_whiteboard::display_type::DrawPoint ( const xy_coords coord)
pure virtual

Abstract method to draw a point.

Parameters
coordx-y coordinates of point

Implemented in ns_whiteboard::ps_display.

virtual void ns_whiteboard::display_type::DrawPoint ( double  x,
double  y 
)
pure virtual

Abstract method to draw a point.

Parameters
xx-coordinate of point
yy-coordinate of point

Implemented in ns_whiteboard::ps_display.

virtual void ns_whiteboard::display_type::DrawRect ( const xy_coords topLeftCoord,
const xy_coords bottomRightCoord 
)
pure virtual

Abstract method to draw a rectangle within a whiteboard.

Parameters
topLeftCoordtop-left coordinate of rectangle within whiteboard
bottomRightCoordbottom-right coordinate of rectangle within whiteboard

Implemented in ns_whiteboard::ps_display.

virtual void ns_whiteboard::display_type::DrawText ( const xy_coords coords,
const string &  chars,
double  rot_angle,
double  point_size,
const vert_align  vAlign,
const horiz_align  hAlign 
)
pure virtual

Abstract method to draw text within a whiteboard.

Parameters
coordsleft-most starting position for text
charsthe string to display
rot_anglerotation angle for the text, with 0 being horizontal
point_sizesize of the text in points
vAlignvertical alignment of text. valid arguments are: align_top,align_middle, align_bottom
hAlignhorizontal alignment of text. valid arguments are: align_left, align_center, align_right

Implemented in ns_whiteboard::ps_display.

virtual void ns_whiteboard::display_type::Finish ( )
pure virtual

Abstract method to flush output stream when finished.

Implemented in ns_whiteboard::ps_display.

virtual const color& ns_whiteboard::display_type::GetColor ( ) const
pure virtual

Abstract method to get the color of a display object.

Implemented in ns_whiteboard::ps_display.

virtual const string& ns_whiteboard::display_type::GetFontName ( ) const
pure virtual

Abstract method to get the name of the font.

Implemented in ns_whiteboard::ps_display.

virtual double ns_whiteboard::display_type::GetFontSize ( ) const
pure virtual

Abstract method to get the font size.

Implemented in ns_whiteboard::ps_display.

virtual double ns_whiteboard::display_type::GetLineWidth ( ) const
pure virtual

Abstract method to get the line width associated with an object.

Implemented in ns_whiteboard::ps_display.

virtual void ns_whiteboard::display_type::SetColor ( const color C)
pure virtual

Abstract method to set the color of a display object.

Parameters
Ccolor to assign to object

Implemented in ns_whiteboard::ps_display.

virtual void ns_whiteboard::display_type::SetFont ( const string &  font,
const double  size 
)
pure virtual

Abstract method to set the font name and size.

Implemented in ns_whiteboard::ps_display.

virtual void ns_whiteboard::display_type::SetLineWidth ( const double  width)
pure virtual

Abstract method to set the line width associated with an object

Parameters
widthwidth of the line

Implemented in ns_whiteboard::ps_display.


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