igstk::Annotation2D Class Reference

Add 2D annotations to the viewport. More...

#include <igstkAnnotation2D.h>

Inheritance diagram for igstk::Annotation2D:
Inheritance graph
[legend]
Collaboration diagram for igstk::Annotation2D:
Collaboration graph
[legend]

List of all members.

Public Types

typedef std::vector
< vtkTextActor * > 
ActorsListType
 Type defining the container of actors.

Public Member Functions

 igstkStandardClassTraitsMacro (Annotation2D, Object) void RequestSetAnnotationText(int
const std::string &void RequestSetFontColor (int index, double red, double green, double blue)
 Request to change font color.
void RequestSetFontSize (int index, int fontSize)
 Request to change font size.
void RequestAddAnnotations ()
 Request add annotations.
void SetLogger (LoggerType *logger)
 Connect the Logger for this class.
virtual ActorsListType GetActors ()
 Get the VTK actors.

Protected Member Functions

LoggerTypeGetLogger () const
 Declarations needed for the Logging.
 Annotation2D (void)
 ~Annotation2D (void)
void AddActors (vtkTextActor *)
 Add an actor.
void DeleteActors ()
 Delete Actors.
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print the object informations in a stream.
void RequestSetAnnotationsViewPort (int horizontal, int vertical)
 Request to Set viewport.

Friends

class View
class QView
 REMOVE this when QView class is removed from the sandbox.

Detailed Description

Add 2D annotations to the viewport.

This class is used to add 2D annotations to the viewport. Annotations can be added to any of the four corners of the viewport.

TODO image html igstkAnnotation2D.png "2D Annotation State Machine Diagram" TODO image latex igstkAnnotation2D.eps "2D Annotation Machine Diagram"

Definition at line 53 of file igstkAnnotation2D.h.


Member Typedef Documentation

typedef std::vector< vtkTextActor* > igstk::Annotation2D::ActorsListType

Type defining the container of actors.

Definition at line 77 of file igstkAnnotation2D.h.


Constructor & Destructor Documentation

igstk::Annotation2D::Annotation2D ( void   )  [protected]
igstk::Annotation2D::~Annotation2D ( void   )  [protected]

Member Function Documentation

igstk::Annotation2D::igstkStandardClassTraitsMacro ( Annotation2D  ,
Object   
)
const std::string& void igstk::Annotation2D::RequestSetFontColor ( int  index,
double  red,
double  green,
double  blue 
)

Request to change font color.

void igstk::Annotation2D::RequestSetFontSize ( int  index,
int  fontSize 
)

Request to change font size.

void igstk::Annotation2D::RequestAddAnnotations (  ) 

Request add annotations.

LoggerType* igstk::Annotation2D::GetLogger (  )  const [protected]

Declarations needed for the Logging.

Reimplemented from igstk::Object.

void igstk::Annotation2D::SetLogger ( LoggerType logger  ) 

Connect the Logger for this class.

Reimplemented from igstk::Object.

virtual ActorsListType igstk::Annotation2D::GetActors (  )  [virtual]

Get the VTK actors.

void igstk::Annotation2D::AddActors ( vtkTextActor *   )  [protected]

Add an actor.

void igstk::Annotation2D::DeleteActors (  )  [protected]

Delete Actors.

virtual void igstk::Annotation2D::PrintSelf ( std::ostream &  os,
itk::Indent  indent 
) const [protected, virtual]

Print the object informations in a stream.

Reimplemented from igstk::Object.

void igstk::Annotation2D::RequestSetAnnotationsViewPort ( int  horizontal,
int  vertical 
) [protected]

Request to Set viewport.


Friends And Related Function Documentation

friend class View [friend]

Definition at line 83 of file igstkAnnotation2D.h.

friend class QView [friend]

REMOVE this when QView class is removed from the sandbox.

Definition at line 88 of file igstkAnnotation2D.h.


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

Generated on Tue Dec 22 03:55:47 2009 for IGSTK by  doxygen 1.6.1