IGSTK
Public Types | Public Member Functions | Protected Member Functions | Friends | List of all members
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]

Public Types

typedef std::vector
< vtkTextActor * > 
ActorsListType
 Type defining the container of actors. More...
 
- Public Types inherited from igstk::Object
typedef Object Self
 General Typedefs. More...
 
typedef ::itk::Object Superclass
 
typedef ::itk::SmartPointer< SelfPointer
 
typedef ::itk::SmartPointer
< const Self
ConstPointer
 
typedef igstk::Logger LoggerType
 

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. More...
 
void RequestSetFontSize (int index, int fontSize)
 Request to change font size. More...
 
void RequestAddAnnotations ()
 Request add annotations. More...
 
void SetLogger (LoggerType *logger)
 
virtual ActorsListType GetActors ()
 Get the VTK actors. More...
 
- Public Member Functions inherited from igstk::Object
virtual const char * GetNameOfClass () const
 
void SetLogger (LoggerType *logger)
 Connect the Logger for this class. More...
 
void RemoveObserver (unsigned long tag) const
 

Protected Member Functions

LoggerTypeGetLogger () const
 Declarations needed for the Logging. More...
 
 Annotation2D (void)
 
 ~Annotation2D (void)
 
void AddActors (vtkTextActor *)
 Add an actor. More...
 
void DeleteActors ()
 Delete Actors. More...
 
virtual void PrintSelf (std::ostream &os, itk::Indent indent) const
 Print the object informations in a stream. More...
 
void RequestSetAnnotationsViewPort (int horizontal, int vertical)
 Request to Set viewport. More...
 
- Protected Member Functions inherited from igstk::Object
LoggerTypeGetLogger () const
 
 Object (void)
 Constructor is protected in order to enforce the use of the New() operator. More...
 
virtual ~Object (void)
 
void RegisterObservedObject (const ::igstk::Object *object, unsigned long tag)
 Register observed objects in an internal array so that they can be disconnected upon destruction. More...
 
void RemoveFromObservedObjects ()
 Remove observers that this object may have connected to other objects. More...
 

Friends

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

Additional Inherited Members

- Static Public Member Functions inherited from igstk::Object
static Pointer New (void)
 

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.

void igstk::Annotation2D::SetLogger ( LoggerType logger)
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
protectedvirtual

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: