albaTextKit Class Reference

#include <albaTextKit.h>

Inheritance diagram for albaTextKit:

Collaboration diagram for albaTextKit:

Public Types
enum	TEXT_KIT_ALIGN_MODALITY {   UPPER_LEFT = 0 , UPPER_CENTER , UPPER_RIGHT , CENTER_LEFT ,   CENTER_CENTER , CENTER_RIGHT , LOWER_LEFT , LOWER_CENTER ,   LOWER_RIGHT }

Public Member Functions
	albaTextKit (wxWindow *parent, vtkRenderer *renderer, albaObserver *Listener=NULL)
	~albaTextKit ()
void	OnEvent (albaEventBase *alba_event)
void	SetListener (albaObserver *Listener)
void	SetText (const char *text)
void	SetTextPosition (double nv_x, double nv_y)
void	SetTextColor (int textColor[3])
void	SetTextColor (int textColorRed, int textColorGreen, int textColorBlue)
void	SetTextSize (int size)
void	SetTextAlignment (int align=UPPER_LEFT)
albaGUI *	GetGui ()
Public Member Functions inherited from albaObserver
	albaObserver ()
virtual	~albaObserver ()
virtual void	OnEvent (albaEventBase *e)=0

Protected Member Functions
void	CreateGui ()

Protected Attributes
int	m_ShowText
int	m_TextAlign
int	m_TextSize
double	m_TextPosition [2]
albaString	m_TextInView
double	m_TextOffset
wxColor	m_TextColor
vtkTextMapper *	m_TextMapper
vtkActor2D *	m_TextActor
albaObserver *	m_Listener
albaGUI *	m_Gui
vtkRenderer *	m_TextRenderer
wxWindow *	m_ParentPanel

Detailed Description

albaTextKit is tool to visualize text into a given albaRWI.

See also

albaRWI

Definition at line 43 of file albaTextKit.h.

Member Enumeration Documentation

TEXT_KIT_ALIGN_MODALITY

enum albaTextKit::TEXT_KIT_ALIGN_MODALITY

Enumerator
UPPER_LEFT
UPPER_CENTER
UPPER_RIGHT
CENTER_LEFT
CENTER_CENTER
CENTER_RIGHT
LOWER_LEFT
LOWER_CENTER
LOWER_RIGHT

Definition at line 52 of file albaTextKit.h.

Constructor & Destructor Documentation

albaTextKit()

albaTextKit::albaTextKit	(	wxWindow *	parent,
		vtkRenderer *	renderer,
		albaObserver *	Listener = NULL
	)

~albaTextKit()

albaTextKit::~albaTextKit

(

)

Member Function Documentation

OnEvent()

void albaTextKit::OnEvent ( albaEventBase *  e )

virtual

process the events sent by subjects

Implements albaObserver.

SetListener()

void albaTextKit::SetListener ( albaObserver *  Listener )

inline

Definition at line 50 of file albaTextKit.h.

SetText()

void albaTextKit::SetText

(

const char *

text

)

Insert a text into the render window.

SetTextPosition()

void albaTextKit::SetTextPosition	(	double	nv_x,
		double	nv_y
	)

Position the text into the render window at normalized view's position x,y.

(0,0) is the lower left corner.

SetTextColor() [1/2]

void albaTextKit::SetTextColor

(

int

textColor[3]

)

Allow to change the text color.

Values passed are from 0 (black) to 255 (white).

SetTextColor() [2/2]

void albaTextKit::SetTextColor	(	int	textColorRed,
		int	textColorGreen,
		int	textColorBlue
	)

SetTextSize()

void albaTextKit::SetTextSize

(

int

size

)

Allow to change the font size.

SetTextAlignment()

void albaTextKit::SetTextAlignment

(

int

align = UPPER_LEFT

)

Align text into the render window.

GetGui()

albaGUI * albaTextKit::GetGui ( )

inline

Returns the albaTextKit's GUI.

Definition at line 82 of file albaTextKit.h.

CreateGui()

void albaTextKit::CreateGui ( )

protected

Create GUI for AttachCamera module.

Member Data Documentation

m_ShowText

int albaTextKit::m_ShowText

protected

Definition at line 88 of file albaTextKit.h.

m_TextAlign

int albaTextKit::m_TextAlign

protected

Definition at line 89 of file albaTextKit.h.

m_TextSize

int albaTextKit::m_TextSize

protected

Definition at line 90 of file albaTextKit.h.

m_TextPosition

double albaTextKit::m_TextPosition[2]

protected

Position of the text in normalized view coordinate system. (0,0) is the lower left corner.

Definition at line 91 of file albaTextKit.h.

m_TextInView

albaString albaTextKit::m_TextInView

protected

Text visualized inside the view.

Definition at line 92 of file albaTextKit.h.

m_TextOffset

double albaTextKit::m_TextOffset

protected

Offset in positioning the text.

Definition at line 93 of file albaTextKit.h.

m_TextColor

wxColor albaTextKit::m_TextColor

protected

Color applied to text.

Definition at line 94 of file albaTextKit.h.

m_TextMapper

vtkTextMapper* albaTextKit::m_TextMapper

protected

Definition at line 96 of file albaTextKit.h.

m_TextActor

vtkActor2D* albaTextKit::m_TextActor

protected

Definition at line 97 of file albaTextKit.h.

m_Listener

albaObserver* albaTextKit::m_Listener

protected

Definition at line 99 of file albaTextKit.h.

m_Gui

albaGUI* albaTextKit::m_Gui

protected

Definition at line 100 of file albaTextKit.h.

m_TextRenderer

vtkRenderer* albaTextKit::m_TextRenderer

protected

Definition at line 101 of file albaTextKit.h.

m_ParentPanel

wxWindow* albaTextKit::m_ParentPanel

protected

Definition at line 102 of file albaTextKit.h.

---

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

• albaTextKit.h