vtkSideAnnotation Class Reference

Subclass of vtkCornerAnnotation to display annotations on the four sides of a render window, instead of its corners. Additionally, the class supports setting different colours for each annotations, individually. More...

Inheritance diagram for vtkSideAnnotation:

Collaboration diagram for vtkSideAnnotation:

Public Member Functions
	vtkTypeMacro (vtkSideAnnotation, vtkCornerAnnotation)
int	RenderOpaqueGeometry (vtkViewport *viewport) override
	Overrides vtkCornerAnnotation::RenderOpaqueGeometry(vtkViewPort*) to restore the colours after the annotations are re-rendered. More...
void	SetColour (int i, double *colour)
	Sets the colour of the text on the specified side. More...
void	GetColour (int i, double *colour)
	Gets the colour of the text on the specified side. More...

Static Public Member Functions
static vtkSideAnnotation *	New ()

Protected Member Functions
	vtkSideAnnotation ()
	Constructs the vtkSideAnnotation object. More...
virtual	~vtkSideAnnotation ()
	Destructs the vtkSideAnnotation object. More...
virtual void	SetTextActorsPosition (int vsize[2]) override
	Overrides vtkCornerAnnotation::SetTextActorsPosition(int vsize[2]) to position the annotations on the sides instead of the corners. More...
virtual void	SetTextActorsJustification () override
	Overrides vtkCornerAnnotation::SetTextActorsJustification() to align the text to the inner side of the render window. More...

Detailed Description

Subclass of vtkCornerAnnotation to display annotations on the four sides of a render window, instead of its corners. Additionally, the class supports setting different colours for each annotations, individually.

The sides are numbered from 0 to 3 in the following order: top, right, bottom, left.

Constructor & Destructor Documentation

vtkSideAnnotation::vtkSideAnnotation ( )

protected

Constructs the vtkSideAnnotation object.

vtkSideAnnotation::~vtkSideAnnotation ( )

protectedvirtual

Destructs the vtkSideAnnotation object.

Member Function Documentation

void vtkSideAnnotation::GetColour	(	int	i,
		double *	colour
	)

Gets the colour of the text on the specified side.

static vtkSideAnnotation* vtkSideAnnotation::New ( )

static

int vtkSideAnnotation::RenderOpaqueGeometry ( vtkViewport *  viewport )

override

Overrides vtkCornerAnnotation::RenderOpaqueGeometry(vtkViewPort*) to restore the colours after the annotations are re-rendered.

void vtkSideAnnotation::SetColour	(	int	i,
		double *	colour
	)

Sets the colour of the text on the specified side.

void vtkSideAnnotation::SetTextActorsJustification ( )

overrideprotectedvirtual

Overrides vtkCornerAnnotation::SetTextActorsJustification() to align the text to the inner side of the render window.

void vtkSideAnnotation::SetTextActorsPosition ( int  vsize[2] )

overrideprotectedvirtual

Overrides vtkCornerAnnotation::SetTextActorsPosition(int vsize[2]) to position the annotations on the sides instead of the corners.

vtkSideAnnotation::vtkTypeMacro	(	vtkSideAnnotation	,
		vtkCornerAnnotation
	)

---

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

• vtkSideAnnotation_p.h
• vtkSideAnnotation.cxx