text annotation in four corners More...

#include <vtkCornerAnnotation.h>

Inheritance diagram for vtkCornerAnnotation:

Collaboration diagram for vtkCornerAnnotation:

Public Types
typedef vtkActor2D	Superclass
Public Member Functions
virtual const char *	GetClassName ()
virtual int	IsA (const char *type)
void	PrintSelf (ostream &os, vtkIndent indent)
virtual int	HasTranslucentPolygonalGeometry ()
virtual void	ReleaseGraphicsResources (vtkWindow *)

int	RenderOpaqueGeometry (vtkViewport *viewport)
virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)
int	RenderOverlay (vtkViewport *viewport)

virtual void	SetMaximumLineHeight (double)
virtual double	GetMaximumLineHeight ()

virtual void	SetMinimumFontSize (int)
virtual int	GetMinimumFontSize ()
virtual void	SetMaximumFontSize (int)
virtual int	GetMaximumFontSize ()

virtual void	SetLinearFontScaleFactor (double)
virtual double	GetLinearFontScaleFactor ()
virtual void	SetNonlinearFontScaleFactor (double)
virtual double	GetNonlinearFontScaleFactor ()

void	SetText (int i, const char *text)
const char *	GetText (int i)
void	ClearAllTexts ()
void	CopyAllTextsFrom (vtkCornerAnnotation *ca)

void	SetImageActor (vtkImageActor *)
virtual vtkImageActor *	GetImageActor ()

void	SetWindowLevel (vtkImageMapToWindowLevelColors *)
virtual vtkImageMapToWindowLevelColors *	GetWindowLevel ()

virtual void	SetLevelShift (double)
virtual double	GetLevelShift ()

virtual void	SetLevelScale (double)
virtual double	GetLevelScale ()

virtual void	SetTextProperty (vtkTextProperty *p)
virtual vtkTextProperty *	GetTextProperty ()

virtual void	ShowSliceAndImageOn ()
virtual void	ShowSliceAndImageOff ()
virtual void	SetShowSliceAndImage (int)
virtual int	GetShowSliceAndImage ()
Static Public Member Functions
static int	IsTypeOf (const char *type)
static vtkCornerAnnotation *	SafeDownCast (vtkObject *o)
static vtkCornerAnnotation *	New ()
Protected Member Functions
	vtkCornerAnnotation ()
	~vtkCornerAnnotation ()

virtual void	TextReplace (vtkImageActor ia, vtkImageMapToWindowLevelColors wl)

virtual void	SetTextActorsPosition (int vsize[2])
virtual void	SetTextActorsJustification ()
Protected Attributes
double	MaximumLineHeight
vtkTextProperty *	TextProperty
vtkImageMapToWindowLevelColors *	WindowLevel
double	LevelShift
double	LevelScale
vtkImageActor *	ImageActor
vtkImageActor *	LastImageActor
char *	CornerText [4]
int	FontSize
vtkActor2D *	TextActor [4]
vtkTimeStamp	BuildTime
int	LastSize [2]
vtkTextMapper *	TextMapper [4]
int	MinimumFontSize
int	MaximumFontSize
double	LinearFontScaleFactor
double	NonlinearFontScaleFactor
int	ShowSliceAndImage

Detailed Description

text annotation in four corners

This is an annotation object that manages four text actors / mappers to provide annotation in the four corners of a viewport

Special input text::

<image> : will be replaced with slice number (relative number)
<slice> : will be replaced with slice number (relative number)
<image_and_max> : will be replaced with slice number and slice max (relative)
<slice_and_max> : will be replaced with slice number and slice max (relative)
<slice_pos> : will be replaced by the position of the current slice
<window> : will be replaced with window value
<level> : will be replaced with level value
<window_level> : will be replaced with window and level value

See also:: vtkActor2D vtkTextMapper

Definition at line 45 of file vtkCornerAnnotation.h.

Member Typedef Documentation

typedef vtkActor2D vtkCornerAnnotation::Superclass

Reimplemented from vtkActor2D.

Definition at line 48 of file vtkCornerAnnotation.h.

Constructor & Destructor Documentation

vtkCornerAnnotation::vtkCornerAnnotation ( ) [protected]

vtkCornerAnnotation::~vtkCornerAnnotation ( ) [protected]

Member Function Documentation

virtual const char* vtkCornerAnnotation::GetClassName ( ) [virtual]

Reimplemented from vtkActor2D.

static int vtkCornerAnnotation::IsTypeOf ( const char * name ) [static]

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkActor2D.

virtual int vtkCornerAnnotation::IsA ( const char * name ) [virtual]

Return 1 if this class is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkActor2D.

static vtkCornerAnnotation* vtkCornerAnnotation::SafeDownCast ( vtkObject * o ) [static]

Reimplemented from vtkActor2D.

void vtkCornerAnnotation::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)		`[virtual]`

Methods invoked by print to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkActor2D.

static vtkCornerAnnotation* vtkCornerAnnotation::New ( ) [static]

Instantiate object with a rectangle in normaled view coordinates of (0.2,0.85, 0.8, 0.95).

Reimplemented from vtkActor2D.

int vtkCornerAnnotation::RenderOpaqueGeometry ( vtkViewport * viewport ) [virtual]

Draw the scalar bar and annotation text to the screen.

Reimplemented from vtkActor2D.

virtual int vtkCornerAnnotation::RenderTranslucentPolygonalGeometry ( vtkViewport * ) [inline, virtual]

Draw the scalar bar and annotation text to the screen.

Reimplemented from vtkActor2D.

Definition at line 58 of file vtkCornerAnnotation.h.

int vtkCornerAnnotation::RenderOverlay ( vtkViewport * viewport ) [virtual]

Draw the scalar bar and annotation text to the screen.

Reimplemented from vtkActor2D.

virtual int vtkCornerAnnotation::HasTranslucentPolygonalGeometry ( ) [virtual]

Does this prop have some translucent polygonal geometry?

Reimplemented from vtkActor2D.

virtual void vtkCornerAnnotation::SetMaximumLineHeight ( double ) [virtual]

Set/Get the maximum height of a line of text as a percentage of the vertical area allocated to this scaled text actor. Defaults to 1.0

virtual double vtkCornerAnnotation::GetMaximumLineHeight ( ) [virtual]

Set/Get the maximum height of a line of text as a percentage of the vertical area allocated to this scaled text actor. Defaults to 1.0

virtual void vtkCornerAnnotation::SetMinimumFontSize ( int ) [virtual]

Set/Get the minimum/maximum size font that will be shown. If the font drops below the minimum size it will not be rendered.

virtual int vtkCornerAnnotation::GetMinimumFontSize ( ) [virtual]

Set/Get the minimum/maximum size font that will be shown. If the font drops below the minimum size it will not be rendered.

virtual void vtkCornerAnnotation::SetMaximumFontSize ( int ) [virtual]

Set/Get the minimum/maximum size font that will be shown. If the font drops below the minimum size it will not be rendered.

virtual int vtkCornerAnnotation::GetMaximumFontSize ( ) [virtual]

Set/Get the minimum/maximum size font that will be shown. If the font drops below the minimum size it will not be rendered.

virtual void vtkCornerAnnotation::SetLinearFontScaleFactor ( double ) [virtual]

Set/Get font scaling factors The font size, f, is calculated as the largest possible value such that the annotations for the given viewport do not overlap. This font size is scaled non-linearly with the viewport size, to maintain an acceptable readable size at larger viewport sizes, without being too big. f' = linearScale * pow(f,nonlinearScale)

virtual double vtkCornerAnnotation::GetLinearFontScaleFactor ( ) [virtual]

Set/Get font scaling factors The font size, f, is calculated as the largest possible value such that the annotations for the given viewport do not overlap. This font size is scaled non-linearly with the viewport size, to maintain an acceptable readable size at larger viewport sizes, without being too big. f' = linearScale * pow(f,nonlinearScale)

virtual void vtkCornerAnnotation::SetNonlinearFontScaleFactor ( double ) [virtual]

Set/Get font scaling factors The font size, f, is calculated as the largest possible value such that the annotations for the given viewport do not overlap. This font size is scaled non-linearly with the viewport size, to maintain an acceptable readable size at larger viewport sizes, without being too big. f' = linearScale * pow(f,nonlinearScale)

virtual double vtkCornerAnnotation::GetNonlinearFontScaleFactor ( ) [virtual]

Set/Get font scaling factors The font size, f, is calculated as the largest possible value such that the annotations for the given viewport do not overlap. This font size is scaled non-linearly with the viewport size, to maintain an acceptable readable size at larger viewport sizes, without being too big. f' = linearScale * pow(f,nonlinearScale)

virtual void vtkCornerAnnotation::ReleaseGraphicsResources ( vtkWindow * ) [virtual]

Release any graphics resources that are being consumed by this actor. The parameter window could be used to determine which graphic resources to release.

Reimplemented from vtkActor2D.

void vtkCornerAnnotation::SetText	(	int	i,
		const char *	text
	)

Set/Get the text to be displayed for each corner

const char* vtkCornerAnnotation::GetText ( int i )

Set/Get the text to be displayed for each corner

void vtkCornerAnnotation::ClearAllTexts ( )

Set/Get the text to be displayed for each corner

void vtkCornerAnnotation::CopyAllTextsFrom ( vtkCornerAnnotation * ca )

Set/Get the text to be displayed for each corner

void vtkCornerAnnotation::SetImageActor ( vtkImageActor * )

Set an image actor to look at for slice information

virtual vtkImageActor* vtkCornerAnnotation::GetImageActor ( ) [virtual]

Set an image actor to look at for slice information

void vtkCornerAnnotation::SetWindowLevel ( vtkImageMapToWindowLevelColors * )

Set an instance of vtkImageMapToWindowLevelColors to use for looking at window level changes

virtual vtkImageMapToWindowLevelColors* vtkCornerAnnotation::GetWindowLevel ( ) [virtual]

Set an instance of vtkImageMapToWindowLevelColors to use for looking at window level changes

virtual void vtkCornerAnnotation::SetLevelShift ( double ) [virtual]

Set the value to shift the level by.

virtual double vtkCornerAnnotation::GetLevelShift ( ) [virtual]

Set the value to shift the level by.

virtual void vtkCornerAnnotation::SetLevelScale ( double ) [virtual]

Set the value to scale the level by.

virtual double vtkCornerAnnotation::GetLevelScale ( ) [virtual]

Set the value to scale the level by.

virtual void vtkCornerAnnotation::SetTextProperty ( vtkTextProperty * p ) [virtual]

Set/Get the text property of all corners.

virtual vtkTextProperty* vtkCornerAnnotation::GetTextProperty ( ) [virtual]

Set/Get the text property of all corners.

virtual void vtkCornerAnnotation::ShowSliceAndImageOn ( ) [virtual]

Even if there is an image actor, should `slice' and `image' be displayed?

virtual void vtkCornerAnnotation::ShowSliceAndImageOff ( ) [virtual]

Even if there is an image actor, should `slice' and `image' be displayed?

virtual void vtkCornerAnnotation::SetShowSliceAndImage ( int ) [virtual]

Even if there is an image actor, should `slice' and `image' be displayed?

virtual int vtkCornerAnnotation::GetShowSliceAndImage ( ) [virtual]

Even if there is an image actor, should `slice' and `image' be displayed?

virtual void vtkCornerAnnotation::TextReplace	(	vtkImageActor *	ia,
		vtkImageMapToWindowLevelColors *	wl
	)		`[protected, virtual]`

Search for replacable tokens and replace

virtual void vtkCornerAnnotation::SetTextActorsPosition ( int vsize[2] ) [protected, virtual]

Set text actor positions given a viewport size and justification

virtual void vtkCornerAnnotation::SetTextActorsJustification ( ) [protected, virtual]

Set text actor positions given a viewport size and justification

Member Data Documentation

double vtkCornerAnnotation::MaximumLineHeight [protected]

Definition at line 150 of file vtkCornerAnnotation.h.

vtkTextProperty* vtkCornerAnnotation::TextProperty [protected]

Definition at line 152 of file vtkCornerAnnotation.h.

vtkImageMapToWindowLevelColors* vtkCornerAnnotation::WindowLevel [protected]

Definition at line 154 of file vtkCornerAnnotation.h.

double vtkCornerAnnotation::LevelShift [protected]

Definition at line 155 of file vtkCornerAnnotation.h.

double vtkCornerAnnotation::LevelScale [protected]

Definition at line 156 of file vtkCornerAnnotation.h.

vtkImageActor* vtkCornerAnnotation::ImageActor [protected]

Definition at line 157 of file vtkCornerAnnotation.h.

vtkImageActor* vtkCornerAnnotation::LastImageActor [protected]

Definition at line 158 of file vtkCornerAnnotation.h.

char* vtkCornerAnnotation::CornerText[4] [protected]

Definition at line 160 of file vtkCornerAnnotation.h.

int vtkCornerAnnotation::FontSize [protected]

Definition at line 162 of file vtkCornerAnnotation.h.

vtkActor2D* vtkCornerAnnotation::TextActor[4] [protected]

Definition at line 163 of file vtkCornerAnnotation.h.

vtkTimeStamp vtkCornerAnnotation::BuildTime [protected]

Definition at line 164 of file vtkCornerAnnotation.h.

int vtkCornerAnnotation::LastSize[2] [protected]

Definition at line 165 of file vtkCornerAnnotation.h.

vtkTextMapper* vtkCornerAnnotation::TextMapper[4] [protected]

Definition at line 166 of file vtkCornerAnnotation.h.

int vtkCornerAnnotation::MinimumFontSize [protected]

Definition at line 168 of file vtkCornerAnnotation.h.

int vtkCornerAnnotation::MaximumFontSize [protected]

Definition at line 169 of file vtkCornerAnnotation.h.

double vtkCornerAnnotation::LinearFontScaleFactor [protected]

Definition at line 171 of file vtkCornerAnnotation.h.

double vtkCornerAnnotation::NonlinearFontScaleFactor [protected]

Definition at line 172 of file vtkCornerAnnotation.h.

int vtkCornerAnnotation::ShowSliceAndImage [protected]

Definition at line 174 of file vtkCornerAnnotation.h.

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

dox/Hybrid/vtkCornerAnnotation.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation