draw symbols with text More...

#include <vtkLegendBoxActor.h>

Inheritance diagram for vtkLegendBoxActor:

Collaboration diagram for vtkLegendBoxActor:

Public Types
typedef vtkActor2D	Superclass

Public Types inherited from vtkActor2D
typedef vtkProp	Superclass

Public Types inherited from vtkProp
typedef vtkObject	Superclass

Public Types inherited from vtkObject
typedef vtkObjectBase	Superclass

Public Member Functions
virtual int	IsA (const char *type)

vtkLegendBoxActor *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

void	SetEntrySymbol (int i, vtkPolyData *symbol)

void	SetEntryIcon (int i, vtkImageData *icon)

void	SetEntryString (int i, const char *string)

void	SetEntryColor (int i, double color[3])

void	SetEntryColor (int i, double r, double g, double b)

vtkPolyData *	GetEntrySymbol (int i)

vtkImageData *	GetEntryIcon (int i)

const char *	GetEntryString (int i)

double *	GetEntryColor (int i)

vtkProperty2D *	GetBoxProperty ()

void	ShallowCopy (vtkProp *prop)

virtual void	ReleaseGraphicsResources (vtkWindow *)


void	SetNumberOfEntries (int num)

int	GetNumberOfEntries ()


void	SetEntry (int i, vtkPolyData symbol, const char string, double color[3])

void	SetEntry (int i, vtkImageData symbol, const char string, double color[3])

void	SetEntry (int i, vtkPolyData symbol, vtkImageData icon, const char *string, double color[3])


virtual void	SetEntryTextProperty (vtkTextProperty *p)

virtual vtkTextProperty *	GetEntryTextProperty ()


virtual void	SetBorder (int)

virtual int	GetBorder ()

virtual void	BorderOn ()

virtual void	BorderOff ()


virtual void	SetLockBorder (int)

virtual int	GetLockBorder ()

virtual void	LockBorderOn ()

virtual void	LockBorderOff ()


virtual void	SetBox (int)

virtual int	GetBox ()

virtual void	BoxOn ()

virtual void	BoxOff ()


virtual void	SetPadding (int)

virtual int	GetPadding ()


virtual void	SetScalarVisibility (int)

virtual int	GetScalarVisibility ()

virtual void	ScalarVisibilityOn ()

virtual void	ScalarVisibilityOff ()


virtual void	SetUseBackground (int)

virtual int	GetUseBackground ()

virtual void	UseBackgroundOn ()

virtual void	UseBackgroundOff ()


virtual void	SetBackgroundColor (double, double, double)

virtual void	SetBackgroundColor (double[3])

virtual double *	GetBackgroundColor ()

virtual void	GetBackgroundColor (double &, double &, double &)

virtual void	GetBackgroundColor (double[3])


virtual void	SetBackgroundOpacity (double)

virtual double	GetBackgroundOpacity ()


int	RenderOpaqueGeometry (vtkViewport *viewport)

virtual int	RenderTranslucentPolygonalGeometry (vtkViewport *)

int	RenderOverlay (vtkViewport *viewport)


virtual int	HasTranslucentPolygonalGeometry ()

Public Member Functions inherited from vtkActor2D
void	PrintSelf (ostream &os, vtkIndent indent)

vtkActor2D *	NewInstance () const

vtkProperty2D *	GetProperty ()

virtual void	SetProperty (vtkProperty2D *)

void	SetDisplayPosition (int, int)

virtual unsigned long	GetMTime ()

virtual void	GetActors2D (vtkPropCollection *pc)

virtual void	SetMapper (vtkMapper2D *mapper)

virtual vtkMapper2D *	GetMapper ()

virtual void	SetLayerNumber (int)

virtual int	GetLayerNumber ()

virtual vtkCoordinate *	GetPositionCoordinate ()

virtual void	SetPosition (float x[2])

virtual void	SetPosition (float x, float y)

virtual float *	GetPosition ()

virtual vtkCoordinate *	GetPosition2Coordinate ()

virtual void	SetPosition2 (float x[2])

virtual void	SetPosition2 (float x, float y)

virtual float *	GetPosition2 ()

void	SetWidth (double w)

double	GetWidth ()

void	SetHeight (double h)

double	GetHeight ()

virtual vtkCoordinate *	GetActualPositionCoordinate (void)

virtual vtkCoordinate *	GetActualPosition2Coordinate (void)

Public Member Functions inherited from vtkProp
vtkProp *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent)

virtual void	Pick ()

virtual bool	HasKeys (vtkInformation *requiredKeys)

virtual void	BuildPaths (vtkAssemblyPaths paths, vtkAssemblyPath path)

virtual void	GetActors (vtkPropCollection *)

virtual void	GetVolumes (vtkPropCollection *)

virtual void	SetVisibility (int)

virtual int	GetVisibility ()

virtual void	VisibilityOn ()

virtual void	VisibilityOff ()

virtual void	SetPickable (int)

virtual int	GetPickable ()

virtual void	PickableOn ()

virtual void	PickableOff ()

virtual void	SetDragable (int)

virtual int	GetDragable ()

virtual void	DragableOn ()

virtual void	DragableOff ()

virtual unsigned long	GetRedrawMTime ()

virtual void	SetUseBounds (bool)

virtual bool	GetUseBounds ()

virtual void	UseBoundsOn ()

virtual void	UseBoundsOff ()

virtual double *	GetBounds ()

virtual void	InitPathTraversal ()

virtual vtkAssemblyPath *	GetNextPath ()

virtual int	GetNumberOfPaths ()

virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))

virtual vtkMatrix4x4 *	GetMatrix ()

virtual vtkInformation *	GetPropertyKeys ()

virtual void	SetPropertyKeys (vtkInformation *keys)

virtual int	RenderVolumetricGeometry (vtkViewport *)

virtual bool	RenderFilteredOpaqueGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredVolumetricGeometry (vtkViewport v, vtkInformation requiredKeys)

virtual bool	RenderFilteredOverlay (vtkViewport v, vtkInformation requiredKeys)

virtual double	GetEstimatedRenderTime (vtkViewport *)

virtual double	GetEstimatedRenderTime ()

virtual void	SetEstimatedRenderTime (double t)

virtual void	RestoreEstimatedRenderTime ()

virtual void	AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))

virtual void	SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))

virtual double	GetAllocatedRenderTime ()

void	SetRenderTimeMultiplier (double t)

virtual double	GetRenderTimeMultiplier ()

virtual bool	GetSupportsSelection ()

virtual int	GetNumberOfConsumers ()

void	AddConsumer (vtkObject *c)

void	RemoveConsumer (vtkObject *c)

vtkObject *	GetConsumer (int i)

int	IsConsumer (vtkObject *c)

Public Member Functions inherited from vtkObject
vtkObject *	NewInstance () const

virtual void	DebugOn ()

virtual void	DebugOff ()

bool	GetDebug ()

void	SetDebug (bool debugFlag)

virtual void	Modified ()

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

int	HasObserver (unsigned long event, vtkCommand *)

int	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

int	HasObserver (unsigned long event)

int	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

int	InvokeEvent (unsigned long event, void *callData)

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const

virtual void	Delete ()

virtual void	FastDelete ()

void	Print (ostream &os)

virtual void	Register (vtkObjectBase *o)

virtual void	UnRegister (vtkObjectBase *o)

void	SetReferenceCount (int)

void	PrintRevisions (ostream &)

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

int	GetReferenceCount ()

Static Public Member Functions
static int	IsTypeOf (const char *type)

static vtkLegendBoxActor *	SafeDownCast (vtkObjectBase *o)

static vtkLegendBoxActor *	New ()

Static Public Member Functions inherited from vtkActor2D
static int	IsTypeOf (const char *type)

static vtkActor2D *	SafeDownCast (vtkObjectBase *o)

static vtkActor2D *	New ()

Static Public Member Functions inherited from vtkProp
static int	IsTypeOf (const char *type)

static vtkProp *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	GeneralTextureUnit ()

static vtkInformationDoubleVectorKey *	GeneralTextureTransform ()

Static Public Member Functions inherited from vtkObject
static int	IsTypeOf (const char *type)

static vtkObject *	SafeDownCast (vtkObjectBase *o)

static vtkObject *	New ()

static void	BreakOnError ()

static void	SetGlobalWarningDisplay (int val)

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static int	IsTypeOf (const char *name)

static vtkObjectBase *	New ()

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkLegendBoxActor ()

	~vtkLegendBoxActor ()

void	InitializeEntries ()

vtkPolyData	createTexturedPlane ()

Protected Member Functions inherited from vtkActor2D
	vtkActor2D ()

	~vtkActor2D ()

Protected Member Functions inherited from vtkProp
	vtkProp ()

	~vtkProp ()

Protected Member Functions inherited from vtkObject
	vtkObject ()

virtual	~vtkObject ()

virtual void	RegisterInternal (vtkObjectBase *, int check)

virtual void	UnRegisterInternal (vtkObjectBase *, int check)

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=NULL)

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
int	Border

int	Box

int	Padding

int	LockBorder

int	ScalarVisibility

double	BoxOpacity

int	NumberOfEntries

int	Size

vtkDoubleArray *	Colors

vtkTextMapper **	TextMapper

vtkActor2D **	TextActor

vtkPolyData **	Symbol

vtkTransform **	Transform

vtkTransformPolyDataFilter **	SymbolTransform

vtkPolyDataMapper2D **	SymbolMapper

vtkActor2D **	SymbolActor

vtkPlaneSource **	Icon

vtkTransform **	IconTransform

vtkTransformPolyDataFilter **	IconTransformFilter

vtkPolyDataMapper2D **	IconMapper

vtkTexturedActor2D **	IconActor

vtkImageData **	IconImage

vtkPolyData *	BorderPolyData

vtkPolyDataMapper2D *	BorderMapper

vtkActor2D *	BorderActor

vtkPolyData *	BoxPolyData

vtkPolyDataMapper2D *	BoxMapper

vtkActor2D *	BoxActor

vtkTextProperty *	EntryTextProperty

int	UseBackground

double	BackgroundOpacity

double	BackgroundColor [3]

vtkPlaneSource *	Background

vtkTexturedActor2D *	BackgroundActor

vtkPolyDataMapper2D *	BackgroundMapper

int	LegendEntriesVisible

int	CachedSize [2]

vtkTimeStamp	BuildTime

Protected Attributes inherited from vtkActor2D
vtkMapper2D *	Mapper

int	LayerNumber

vtkProperty2D *	Property

vtkCoordinate *	PositionCoordinate

vtkCoordinate *	Position2Coordinate

Protected Attributes inherited from vtkProp
int	Visibility

int	Pickable

int	Dragable

bool	UseBounds

double	AllocatedRenderTime

double	EstimatedRenderTime

double	SavedEstimatedRenderTime

double	RenderTimeMultiplier

int	NumberOfConsumers

vtkObject **	Consumers

vtkAssemblyPaths *	Paths

vtkInformation *	PropertyKeys

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Detailed Description

draw symbols with text

vtkLegendBoxActor is used to associate a symbol with a text string. The user specifies a vtkPolyData to use as the symbol, and a string associated with the symbol. The actor can then be placed in the scene in the same way that any other vtkActor2D can be used.

To use this class, you must define the position of the legend box by using the superclasses' vtkActor2D::Position coordinate and Position2 coordinate. Then define the set of symbols and text strings that make up the menu box. The font attributes of the entries can be set through the vtkTextProperty associated to this actor. The class will scale the symbols and text to fit in the legend box defined by (Position,Position2). Optional features like turning on a border line and setting the spacing between the border and the symbols/text can also be set.

See also: vtkXYPlotActor vtkActor2D vtkGlyphSource2D

Tests:: vtkLegendBoxActor (Tests)

Definition at line 60 of file vtkLegendBoxActor.h.

Member Typedef Documentation

typedef vtkActor2D vtkLegendBoxActor::Superclass

Definition at line 63 of file vtkLegendBoxActor.h.

Constructor & Destructor Documentation

vtkLegendBoxActor::vtkLegendBoxActor ( )

protected

vtkLegendBoxActor::~vtkLegendBoxActor ( )

protected

Member Function Documentation

static int vtkLegendBoxActor::IsTypeOf ( const char * type )

static

virtual int vtkLegendBoxActor::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 vtkLegendBoxActor* vtkLegendBoxActor::SafeDownCast ( vtkObjectBase * o )

static

virtual vtkObjectBase* vtkLegendBoxActor::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkActor2D.

vtkLegendBoxActor* vtkLegendBoxActor::NewInstance ( ) const

void vtkLegendBoxActor::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 vtkObject.

static vtkLegendBoxActor* vtkLegendBoxActor::New ( )

static

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

void vtkLegendBoxActor::SetNumberOfEntries ( int num )

Specify the number of entries in the legend box.

int vtkLegendBoxActor::GetNumberOfEntries ( )

inline

Specify the number of entries in the legend box.

Definition at line 73 of file vtkLegendBoxActor.h.

void vtkLegendBoxActor::SetEntry	(	int	i,
		vtkPolyData *	symbol,
		const char *	string,
		double	color[3]
	)

Add an entry to the legend box. You must supply a vtkPolyData to be used as a symbol (it can be NULL) and a text string (which also can be NULL). The vtkPolyData is assumed to be defined in the x-y plane, and the text is assumed to be a single line in height. Note that when this method is invoked previous entries are deleted. Also supply a text string and optionally a color. (If a color is not specified, then the entry color is the same as this actor's color.) (Note: use the set methods when you use SetNumberOfEntries().)

void vtkLegendBoxActor::SetEntry	(	int	i,
		vtkImageData *	symbol,
		const char *	string,
		double	color[3]
	)

Add an entry to the legend box. You must supply a vtkPolyData to be used as a symbol (it can be NULL) and a text string (which also can be NULL). The vtkPolyData is assumed to be defined in the x-y plane, and the text is assumed to be a single line in height. Note that when this method is invoked previous entries are deleted. Also supply a text string and optionally a color. (If a color is not specified, then the entry color is the same as this actor's color.) (Note: use the set methods when you use SetNumberOfEntries().)

void vtkLegendBoxActor::SetEntry	(	int	i,
		vtkPolyData *	symbol,
		vtkImageData *	icon,
		const char *	string,
		double	color[3]
	)

Add an entry to the legend box. You must supply a vtkPolyData to be used as a symbol (it can be NULL) and a text string (which also can be NULL). The vtkPolyData is assumed to be defined in the x-y plane, and the text is assumed to be a single line in height. Note that when this method is invoked previous entries are deleted. Also supply a text string and optionally a color. (If a color is not specified, then the entry color is the same as this actor's color.) (Note: use the set methods when you use SetNumberOfEntries().)

void vtkLegendBoxActor::SetEntrySymbol	(	int	i,
		vtkPolyData *	symbol
	)

void vtkLegendBoxActor::SetEntryIcon	(	int	i,
		vtkImageData *	icon
	)

void vtkLegendBoxActor::SetEntryString	(	int	i,
		const char *	string
	)

void vtkLegendBoxActor::SetEntryColor	(	int	i,
		double	color[3]
	)

void vtkLegendBoxActor::SetEntryColor	(	int	i,
		double	r,
		double	g,
		double	b
	)

vtkPolyData* vtkLegendBoxActor::GetEntrySymbol ( int i )

vtkImageData* vtkLegendBoxActor::GetEntryIcon ( int i )

const char* vtkLegendBoxActor::GetEntryString ( int i )

double* vtkLegendBoxActor::GetEntryColor ( int i )

virtual void vtkLegendBoxActor::SetEntryTextProperty ( vtkTextProperty * p )

virtual

Set/Get the text property.

virtual vtkTextProperty* vtkLegendBoxActor::GetEntryTextProperty ( )

virtual

Set/Get the text property.

virtual void vtkLegendBoxActor::SetBorder ( int )

virtual

Set/Get the flag that controls whether a border will be drawn around the legend box.

virtual int vtkLegendBoxActor::GetBorder ( )

virtual

Set/Get the flag that controls whether a border will be drawn around the legend box.

virtual void vtkLegendBoxActor::BorderOn ( )

virtual

Set/Get the flag that controls whether a border will be drawn around the legend box.

virtual void vtkLegendBoxActor::BorderOff ( )

virtual

Set/Get the flag that controls whether a border will be drawn around the legend box.

virtual void vtkLegendBoxActor::SetLockBorder ( int )

virtual

Set/Get the flag that controls whether the border and legend placement is locked into the rectangle defined by (Position,Position2). If off, then the legend box will adjust its size so that the border fits nicely around the text and symbols. (The ivar is off by default.) Note: the legend box is guaranteed to lie within the original border definition.

virtual int vtkLegendBoxActor::GetLockBorder ( )

virtual

Set/Get the flag that controls whether the border and legend placement is locked into the rectangle defined by (Position,Position2). If off, then the legend box will adjust its size so that the border fits nicely around the text and symbols. (The ivar is off by default.) Note: the legend box is guaranteed to lie within the original border definition.

virtual void vtkLegendBoxActor::LockBorderOn ( )

virtual

Set/Get the flag that controls whether the border and legend placement is locked into the rectangle defined by (Position,Position2). If off, then the legend box will adjust its size so that the border fits nicely around the text and symbols. (The ivar is off by default.) Note: the legend box is guaranteed to lie within the original border definition.

virtual void vtkLegendBoxActor::LockBorderOff ( )

virtual

Set/Get the flag that controls whether the border and legend placement is locked into the rectangle defined by (Position,Position2). If off, then the legend box will adjust its size so that the border fits nicely around the text and symbols. (The ivar is off by default.) Note: the legend box is guaranteed to lie within the original border definition.

virtual void vtkLegendBoxActor::SetBox ( int )

virtual

Set/Get the flag that controls whether a box will be drawn/filled corresponding to the legend box.

virtual int vtkLegendBoxActor::GetBox ( )

virtual

Set/Get the flag that controls whether a box will be drawn/filled corresponding to the legend box.

virtual void vtkLegendBoxActor::BoxOn ( )

virtual

Set/Get the flag that controls whether a box will be drawn/filled corresponding to the legend box.

virtual void vtkLegendBoxActor::BoxOff ( )

virtual

Set/Get the flag that controls whether a box will be drawn/filled corresponding to the legend box.

vtkProperty2D* vtkLegendBoxActor::GetBoxProperty ( )

inline

Get the box vtkProperty2D.

Definition at line 138 of file vtkLegendBoxActor.h.

virtual void vtkLegendBoxActor::SetPadding ( int )

virtual

Set/Get the padding between the legend entries and the border. The value is specified in pixels.

virtual int vtkLegendBoxActor::GetPadding ( )

virtual

Set/Get the padding between the legend entries and the border. The value is specified in pixels.

virtual void vtkLegendBoxActor::SetScalarVisibility ( int )

virtual

Turn on/off flag to control whether the symbol's scalar data is used to color the symbol. If off, the color of the vtkLegendBoxActor is used.

virtual int vtkLegendBoxActor::GetScalarVisibility ( )

virtual

Turn on/off flag to control whether the symbol's scalar data is used to color the symbol. If off, the color of the vtkLegendBoxActor is used.

virtual void vtkLegendBoxActor::ScalarVisibilityOn ( )

virtual

Turn on/off flag to control whether the symbol's scalar data is used to color the symbol. If off, the color of the vtkLegendBoxActor is used.

virtual void vtkLegendBoxActor::ScalarVisibilityOff ( )

virtual

Turn on/off flag to control whether the symbol's scalar data is used to color the symbol. If off, the color of the vtkLegendBoxActor is used.

virtual void vtkLegendBoxActor::SetUseBackground ( int )

virtual

Turn on/off background.

virtual int vtkLegendBoxActor::GetUseBackground ( )

virtual

Turn on/off background.

virtual void vtkLegendBoxActor::UseBackgroundOn ( )

virtual

Turn on/off background.

virtual void vtkLegendBoxActor::UseBackgroundOff ( )

virtual

Turn on/off background.

virtual void vtkLegendBoxActor::SetBackgroundColor	(	double	,
		double	,
		double
	)

virtual