vtkLegendBoxEntryInternal Class Reference

A single entry to use inside vtkLegendBoxActor. More...

#include <vtkLegendBoxEntryInternal.h>

Public Member Functions
	vtkLegendBoxEntryInternal ()
	~vtkLegendBoxEntryInternal ()
bool	HasSymbol ()
	Returns true if the entry has a symbol set (i.e.
bool	HasIcon ()
	Returns true if the entry has an icon set (i.e.
void	SetTextPosition (double X, double Y)
	Set the text position.
void	UpdateIconTransform (int width, int height, double posX, double posY)
	Update the icon transform (scale and position).
void	UpdateSymbolTransform (int width, int height, double posX, double posY)
	Update the symbol transform (scale and position).
void	UpdateProperties (bool visibility, vtkProperty2D *prop)
	Update internal actors properties.
void	CopyTextProperty (vtkTextProperty *prop)
	Copy given property into internal TextActor property.
double *	GetSymbolBounds ()
	Get the entry symbol bounds.
double *	GetIconBounds ()
	Get the entry symbol bounds.
bool	SetText (const char *text)
	Set / Get the entry text.
const char *	GetText ()
	Set / Get the entry text.
bool	SetSymbol (vtkPolyData *)
	Set / Get the entry symbol.
vtkPolyData *	GetSymbol ()
	Set / Get the entry symbol.
bool	SetIcon (vtkImageData *)
	Set / Get the entry icon.
vtkImageData *	GetIcon ()
	Set / Get the entry icon.
bool	SetColor (double color[3])
	Set / Get the entry color.
double *	GetColor ()
	Set / Get the entry color.
void	ReleaseGraphicsResources (vtkWindow *win)
	Forward usual rendering methods to internal actors.
int	RenderOverlay (vtkViewport *)
	Forward usual rendering methods to internal actors.
int	RenderOpaqueGeometry (vtkViewport *)
	Forward usual rendering methods to internal actors.
void	SetFontSize (int size)
	Forwarded to internal text mapper.
int	SetConstrainedFontSize (vtkViewport *viewport, int size[2])
	Forwarded to internal text mapper.
void	GetSize (vtkViewport *viewport, int size[2])
	Forwarded to internal text mapper.

Detailed Description

A single entry to use inside vtkLegendBoxActor.

vtkLegendBoxEntryInternal represents an entry of the vtkLegendBoxActor: a text with optional symbol (vtkPolyData) and icon (vtkImageData). It is intended to be used from inside VTK RenderingAnnotation module only.

Definition at line 33 of file vtkLegendBoxEntryInternal.h.

Constructor & Destructor Documentation

vtkLegendBoxEntryInternal()

vtkLegendBoxEntryInternal::vtkLegendBoxEntryInternal

(

)

~vtkLegendBoxEntryInternal()

vtkLegendBoxEntryInternal::~vtkLegendBoxEntryInternal

(

)

Member Function Documentation

SetText()

bool vtkLegendBoxEntryInternal::SetText

(

const char *

text

)

Set / Get the entry text.

Empty by default.

GetText()

const char * vtkLegendBoxEntryInternal::GetText

(

)

Set / Get the entry text.

Empty by default.

SetSymbol()

bool vtkLegendBoxEntryInternal::SetSymbol

(

vtkPolyData *

)

Set / Get the entry symbol.

Default is nullptr.

GetSymbol()

vtkPolyData * vtkLegendBoxEntryInternal::GetSymbol

(

)

Set / Get the entry symbol.

Default is nullptr.

HasSymbol()

bool vtkLegendBoxEntryInternal::HasSymbol

(

)

Returns true if the entry has a symbol set (i.e.

if GetSymbol is not nullptr) Default is false.

SetIcon()

bool vtkLegendBoxEntryInternal::SetIcon

(

vtkImageData *

)

Set / Get the entry icon.

Default is nullptr.

GetIcon()

vtkImageData * vtkLegendBoxEntryInternal::GetIcon

(

)

Set / Get the entry icon.

Default is nullptr.

HasIcon()

bool vtkLegendBoxEntryInternal::HasIcon

(

)

Returns true if the entry has an icon set (i.e.

if GetIcon is not nullptr). Default is false.

SetColor()

bool vtkLegendBoxEntryInternal::SetColor

(

double

color[3]

)

Set / Get the entry color.

This applies to the text and the symbol.

GetColor()

double * vtkLegendBoxEntryInternal::GetColor

(

)

Set / Get the entry color.

This applies to the text and the symbol.

ReleaseGraphicsResources()

void vtkLegendBoxEntryInternal::ReleaseGraphicsResources

(

vtkWindow *

win

)

Forward usual rendering methods to internal actors.

RenderOverlay()

int vtkLegendBoxEntryInternal::RenderOverlay

(

vtkViewport *

)

Forward usual rendering methods to internal actors.

RenderOpaqueGeometry()

int vtkLegendBoxEntryInternal::RenderOpaqueGeometry

(

vtkViewport *

)

Forward usual rendering methods to internal actors.

SetTextPosition()

void vtkLegendBoxEntryInternal::SetTextPosition	(	double	X,
		double	Y )

Set the text position.

UpdateIconTransform()

void vtkLegendBoxEntryInternal::UpdateIconTransform	(	int	width,
		int	height,
		double	posX,
		double	posY )

Update the icon transform (scale and position).

width and height being the targeted dimensions and posX/posY the targeted coordinates.

UpdateSymbolTransform()

void vtkLegendBoxEntryInternal::UpdateSymbolTransform	(	int	width,
		int	height,
		double	posX,
		double	posY )

Update the symbol transform (scale and position).

width and height being the targeted dimensions and posX/posY the targeted coordinates.

UpdateProperties()

void vtkLegendBoxEntryInternal::UpdateProperties	(	bool	visibility,
		vtkProperty2D *	prop )

Update internal actors properties.

Use prop as base. Override with Color. And set ScalarVisibility.

CopyTextProperty()

void vtkLegendBoxEntryInternal::CopyTextProperty

(

vtkTextProperty *

prop

)

Copy given property into internal TextActor property.

GetSymbolBounds()

double * vtkLegendBoxEntryInternal::GetSymbolBounds

(

)

Get the entry symbol bounds.

GetIconBounds()

double * vtkLegendBoxEntryInternal::GetIconBounds

(

)

Get the entry symbol bounds.

SetFontSize()

void vtkLegendBoxEntryInternal::SetFontSize

(

int

size

)

Forwarded to internal text mapper.

SetConstrainedFontSize()

int vtkLegendBoxEntryInternal::SetConstrainedFontSize	(	vtkViewport *	viewport,
		int	size[2] )

Forwarded to internal text mapper.

GetSize()

void vtkLegendBoxEntryInternal::GetSize	(	vtkViewport *	viewport,
		int	size[2] )

Forwarded to internal text mapper.

---

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

• Rendering/Annotation/Private/vtkLegendBoxEntryInternal.h