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 Member Functions
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class. More...

vtkLegendBoxActor *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

void	SetNumberOfEntries (int num)
	Specify the number of entries in the legend box. More...

int	GetNumberOfEntries ()

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 ()
	Get the box vtkProperty2D. More...

void	ShallowCopy (vtkProp *prop) override
	Shallow copy of this scaled text actor. More...

void	ReleaseGraphicsResources (vtkWindow *) override
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...

vtkTypeBool	HasTranslucentPolygonalGeometry () override
	Does this prop have some translucent polygonal geometry? More...


void	SetEntry (int i, vtkPolyData symbol, const char string, double color[3])
	Add an entry to the legend box. More...

void	SetEntry (int i, vtkImageData symbol, const char string, double color[3])
	Add an entry to the legend box. More...

void	SetEntry (int i, vtkPolyData symbol, vtkImageData icon, const char *string, double color[3])
	Add an entry to the legend box. More...


virtual void	SetEntryTextProperty (vtkTextProperty *p)
	Set/Get the text property. More...

virtual vtkTextProperty *	GetEntryTextProperty ()
	Set/Get the text property. More...


virtual void	SetBorder (vtkTypeBool)
	Set/Get the flag that controls whether a border will be drawn around the legend box. More...

virtual vtkTypeBool	GetBorder ()
	Set/Get the flag that controls whether a border will be drawn around the legend box. More...

virtual void	BorderOn ()
	Set/Get the flag that controls whether a border will be drawn around the legend box. More...

virtual void	BorderOff ()
	Set/Get the flag that controls whether a border will be drawn around the legend box. More...


virtual void	SetLockBorder (vtkTypeBool)
	Set/Get the flag that controls whether the border and legend placement is locked into the rectangle defined by (Position,Position2). More...

virtual vtkTypeBool	GetLockBorder ()
	Set/Get the flag that controls whether the border and legend placement is locked into the rectangle defined by (Position,Position2). More...

virtual void	LockBorderOn ()
	Set/Get the flag that controls whether the border and legend placement is locked into the rectangle defined by (Position,Position2). More...

virtual void	LockBorderOff ()
	Set/Get the flag that controls whether the border and legend placement is locked into the rectangle defined by (Position,Position2). More...


virtual void	SetBox (vtkTypeBool)
	Set/Get the flag that controls whether a box will be drawn/filled corresponding to the legend box. More...

virtual vtkTypeBool	GetBox ()
	Set/Get the flag that controls whether a box will be drawn/filled corresponding to the legend box. More...

virtual void	BoxOn ()
	Set/Get the flag that controls whether a box will be drawn/filled corresponding to the legend box. More...

virtual void	BoxOff ()
	Set/Get the flag that controls whether a box will be drawn/filled corresponding to the legend box. More...


virtual void	SetPadding (int)
	Set/Get the padding between the legend entries and the border. More...

virtual int	GetPadding ()
	Set/Get the padding between the legend entries and the border. More...


virtual void	SetScalarVisibility (vtkTypeBool)
	Turn on/off flag to control whether the symbol's scalar data is used to color the symbol. More...

virtual vtkTypeBool	GetScalarVisibility ()
	Turn on/off flag to control whether the symbol's scalar data is used to color the symbol. More...

virtual void	ScalarVisibilityOn ()
	Turn on/off flag to control whether the symbol's scalar data is used to color the symbol. More...

virtual void	ScalarVisibilityOff ()
	Turn on/off flag to control whether the symbol's scalar data is used to color the symbol. More...


virtual void	SetUseBackground (vtkTypeBool)
	Turn on/off background. More...

virtual vtkTypeBool	GetUseBackground ()
	Turn on/off background. More...

virtual void	UseBackgroundOn ()
	Turn on/off background. More...

virtual void	UseBackgroundOff ()
	Turn on/off background. More...


virtual void	SetBackgroundColor (double, double, double)
	Set/Get background color. More...

virtual void	SetBackgroundColor (double[3])
	Set/Get background color. More...

virtual double *	GetBackgroundColor ()
	Set/Get background color. More...

virtual void	GetBackgroundColor (double &, double &, double &)
	Set/Get background color. More...

virtual void	GetBackgroundColor (double[3])
	Set/Get background color. More...


virtual void	SetBackgroundOpacity (double)
	Set/Get background opacity. More...

virtual double	GetBackgroundOpacity ()
	Set/Get background opacity. More...


int	RenderOpaqueGeometry (vtkViewport *viewport) override
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...

int	RenderTranslucentPolygonalGeometry (vtkViewport *) override
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...

int	RenderOverlay (vtkViewport *viewport) override
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...

Public Member Functions inherited from vtkActor2D
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

vtkActor2D *	NewInstance () const

vtkTypeBool	HasTranslucentPolygonalGeometry () override
	Does this prop have some translucent polygonal geometry? More...

vtkProperty2D *	GetProperty ()
	Returns this actor's vtkProperty2D. More...

virtual void	SetProperty (vtkProperty2D *)
	Set this vtkProp's vtkProperty2D. More...

void	SetDisplayPosition (int, int)
	Set the Prop2D's position in display coordinates. More...

vtkMTimeType	GetMTime () override
	Return this objects MTime. More...

void	GetActors2D (vtkPropCollection *pc) override
	For some exporters and other other operations we must be able to collect all the actors or volumes. More...

void	ShallowCopy (vtkProp *prop) override
	Shallow copy of this vtkActor2D. More...

void	ReleaseGraphicsResources (vtkWindow *) override
	Release any graphics resources that are being consumed by this actor. More...

virtual vtkCoordinate *	GetActualPositionCoordinate (void)
	Return the actual vtkCoordinate reference that the mapper should use to position the actor. More...

virtual vtkCoordinate *	GetActualPosition2Coordinate (void)
	Return the actual vtkCoordinate reference that the mapper should use to position the actor. More...

int	RenderOverlay (vtkViewport *viewport) override
	Support the standard render methods. More...

int	RenderOpaqueGeometry (vtkViewport *viewport) override
	Support the standard render methods. More...

int	RenderTranslucentPolygonalGeometry (vtkViewport *viewport) override
	Support the standard render methods. More...

virtual void	SetMapper (vtkMapper2D *mapper)
	Set/Get the vtkMapper2D which defines the data to be drawn. More...

virtual vtkMapper2D *	GetMapper ()
	Set/Get the vtkMapper2D which defines the data to be drawn. More...

virtual void	SetLayerNumber (int)
	Set/Get the layer number in the overlay planes into which to render. More...

virtual int	GetLayerNumber ()
	Set/Get the layer number in the overlay planes into which to render. More...

virtual vtkCoordinate *	GetPositionCoordinate ()
	Get the PositionCoordinate instance of vtkCoordinate. More...

virtual void	SetPosition (float x[2])
	Get the PositionCoordinate instance of vtkCoordinate. More...

virtual void	SetPosition (float x, float y)
	Get the PositionCoordinate instance of vtkCoordinate. More...

virtual float *	GetPosition ()
	Get the PositionCoordinate instance of vtkCoordinate. More...

virtual vtkCoordinate *	GetPosition2Coordinate ()
	Access the Position2 instance variable. More...

virtual void	SetPosition2 (float x[2])
	Access the Position2 instance variable. More...

virtual void	SetPosition2 (float x, float y)
	Access the Position2 instance variable. More...

virtual float *	GetPosition2 ()
	Access the Position2 instance variable. More...

void	SetWidth (double w)
	Set/Get the height and width of the Actor2D. More...

double	GetWidth ()
	Set/Get the height and width of the Actor2D. More...

void	SetHeight (double h)
	Set/Get the height and width of the Actor2D. More...

double	GetHeight ()
	Set/Get the height and width of the Actor2D. More...

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

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	GetActors (vtkPropCollection *)
	For some exporters and other other operations we must be able to collect all the actors or volumes. More...

virtual void	GetVolumes (vtkPropCollection *)

virtual void	Pick ()
	Method fires PickEvent if the prop is picked. More...

virtual vtkMTimeType	GetRedrawMTime ()
	Return the mtime of anything that would cause the rendered image to appear differently. More...

virtual double *	GetBounds ()
	Get the bounds for this Prop as (Xmin,Xmax,Ymin,Ymax,Zmin,Zmax). More...

virtual void	PokeMatrix (vtkMatrix4x4 *vtkNotUsed(matrix))
	These methods are used by subclasses to place a matrix (if any) in the prop prior to rendering. More...

virtual vtkMatrix4x4 *	GetMatrix ()

virtual bool	HasKeys (vtkInformation *requiredKeys)
	Tells if the prop has all the required keys. More...

virtual int	RenderVolumetricGeometry (vtkViewport *)

virtual bool	RenderFilteredOpaqueGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the opaque geometry only if the prop has all the requiredKeys. More...

virtual bool	RenderFilteredTranslucentPolygonalGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the translucent polygonal geometry only if the prop has all the requiredKeys. More...

virtual bool	RenderFilteredVolumetricGeometry (vtkViewport v, vtkInformation requiredKeys)
	Render the volumetric geometry only if the prop has all the requiredKeys. More...

virtual bool	RenderFilteredOverlay (vtkViewport v, vtkInformation requiredKeys)
	Render in the overlay of the viewport only if the prop has all the requiredKeys. More...

virtual double	GetEstimatedRenderTime (vtkViewport *)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS The EstimatedRenderTime may be used to select between different props, for example in LODProp it is used to select the level-of-detail. More...

virtual double	GetEstimatedRenderTime ()

virtual void	SetEstimatedRenderTime (double t)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS This method is used by, for example, the vtkLODProp3D in order to initialize the estimated render time at start-up to some user defined value. More...

virtual void	RestoreEstimatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDERING PROCESS When the EstimatedRenderTime is first set to 0.0 (in the SetAllocatedRenderTime method) the old value is saved. More...

virtual void	AddEstimatedRenderTime (double t, vtkViewport *vtkNotUsed(vp))
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS This method is intended to allow the renderer to add to the EstimatedRenderTime in props that require information that the renderer has in order to do this. More...

void	SetRenderTimeMultiplier (double t)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Get/Set the multiplier for the render time. More...

virtual double	GetRenderTimeMultiplier ()

virtual void	BuildPaths (vtkAssemblyPaths paths, vtkAssemblyPath path)
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used to construct assembly paths and perform part traversal. More...

virtual bool	GetSupportsSelection ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS Used by vtkHardwareSelector to determine if the prop supports hardware selection. More...

virtual void	ProcessSelectorPixelBuffers (vtkHardwareSelector *, std::vector< unsigned int > &)
	allows a prop to update a selections color buffers More...

virtual void	SetVisibility (vtkTypeBool)
	Set/Get visibility of this vtkProp. More...

virtual vtkTypeBool	GetVisibility ()
	Set/Get visibility of this vtkProp. More...

virtual void	VisibilityOn ()
	Set/Get visibility of this vtkProp. More...

virtual void	VisibilityOff ()
	Set/Get visibility of this vtkProp. More...

virtual void	SetPickable (vtkTypeBool)
	Set/Get the pickable instance variable. More...

virtual vtkTypeBool	GetPickable ()
	Set/Get the pickable instance variable. More...

virtual void	PickableOn ()
	Set/Get the pickable instance variable. More...

virtual void	PickableOff ()
	Set/Get the pickable instance variable. More...

virtual void	SetDragable (vtkTypeBool)
	Set/Get the value of the dragable instance variable. More...

virtual vtkTypeBool	GetDragable ()
	Set/Get the value of the dragable instance variable. More...

virtual void	DragableOn ()
	Set/Get the value of the dragable instance variable. More...

virtual void	DragableOff ()
	Set/Get the value of the dragable instance variable. More...

virtual void	SetUseBounds (bool)
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...

virtual bool	GetUseBounds ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...

virtual void	UseBoundsOn ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...

virtual void	UseBoundsOff ()
	In case the Visibility flag is true, tell if the bounds of this prop should be taken into account or ignored during the computation of other bounding boxes, like in vtkRenderer::ResetCamera(). More...

virtual void	InitPathTraversal ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...

virtual vtkAssemblyPath *	GetNextPath ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...

virtual int	GetNumberOfPaths ()
	vtkProp and its subclasses can be picked by subclasses of vtkAbstractPicker (e.g., vtkPropPicker). More...

virtual vtkInformation *	GetPropertyKeys ()
	Set/Get property keys. More...

virtual void	SetPropertyKeys (vtkInformation *keys)
	Set/Get property keys. More...

virtual void	SetAllocatedRenderTime (double t, vtkViewport *vtkNotUsed(v))
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS The renderer may use the allocated rendering time to determine how to render this actor. More...

virtual double	GetAllocatedRenderTime ()
	WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS. More...

virtual int	GetNumberOfConsumers ()
	Get the number of consumers. More...

void	AddConsumer (vtkObject *c)
	Add or remove or get or check a consumer,. More...

void	RemoveConsumer (vtkObject *c)
	Add or remove or get or check a consumer,. More...

vtkObject *	GetConsumer (int i)
	Add or remove or get or check a consumer,. More...

int	IsConsumer (vtkObject *c)
	Add or remove or get or check a consumer,. More...

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

bool	GetDebug ()
	Get the value of the debug flag. More...

void	SetDebug (bool debugFlag)
	Set the value of the debug flag. More...

virtual void	Modified ()
	Update the modification time for this object. More...

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

int	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not. More...

int	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not. More...

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string. More...

virtual void	Delete ()
	Delete a VTK object. More...

virtual void	FastDelete ()
	Delete a reference to this object. More...

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream. More...

virtual void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object). More...

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object). More...

int	GetReferenceCount ()
	Return the current reference count of this object. More...

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses. More...

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

static vtkLegendBoxActor *	SafeDownCast (vtkObjectBase *o)

static vtkLegendBoxActor *	New ()
	Instantiate object with a rectangle in normaled view coordinates of (0.2,0.85, 0.8, 0.95). More...

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

static vtkActor2D *	SafeDownCast (vtkObjectBase *o)

static vtkActor2D *	New ()
	Creates an actor2D with the following defaults: position (0,0) (coordinate system is viewport); at layer 0. More...

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

static vtkProp *	SafeDownCast (vtkObjectBase *o)

static vtkInformationIntegerKey *	GeneralTextureUnit ()
	Optional Key Indicating the texture unit for general texture mapping Old OpenGL was a state machine where you would push or pop items. More...

static vtkInformationDoubleVectorKey *	GeneralTextureTransform ()
	Optional Key Indicating the texture transform for general texture mapping Old OpenGL was a state machine where you would push or pop items. More...

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes. More...

static void	SetGlobalWarningDisplay (int val)
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

static int	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed. More...

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkLegendBoxActor ()

	~vtkLegendBoxActor () override

void	InitializeEntries ()

vtkPolyData	createTexturedPlane ()

Protected Member Functions inherited from vtkActor2D
	vtkActor2D ()

	~vtkActor2D () override

Protected Member Functions inherited from vtkProp
	vtkProp ()

	~vtkProp () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events. More...

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
vtkTypeBool	Border

vtkTypeBool	Box

int	Padding

vtkTypeBool	LockBorder

vtkTypeBool	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

vtkTypeBool	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
vtkTypeBool	Visibility

vtkTypeBool	Pickable

vtkTypeBool	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 61 of file vtkLegendBoxActor.h.

Member Typedef Documentation

typedef vtkActor2D vtkLegendBoxActor::Superclass

Definition at line 64 of file vtkLegendBoxActor.h.

Constructor & Destructor Documentation

vtkLegendBoxActor::vtkLegendBoxActor ( )

protected

vtkLegendBoxActor::~vtkLegendBoxActor ( )

overrideprotected

Member Function Documentation

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

static

virtual vtkTypeBool 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
	)

overridevirtual

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

Definition at line 77 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 ( vtkTypeBool )

virtual

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

virtual vtkTypeBool 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 ( vtkTypeBool )

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 vtkTypeBool 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 ( vtkTypeBool )

virtual

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

virtual vtkTypeBool 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 153 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 ( vtkTypeBool )

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 vtkTypeBool 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 ( vtkTypeBool )

virtual

Turn on/off background.

virtual vtkTypeBool 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

Set/Get background color.

Default is: (0.3, 0.3, 0.3).

virtual void vtkLegendBoxActor::SetBackgroundColor ( double [3] )

virtual

Set/Get background color.

Default is: (0.3, 0.3, 0.3).

virtual double* vtkLegendBoxActor::GetBackgroundColor ( )

virtual

Set/Get background color.

Default is: (0.3, 0.3, 0.3).

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

virtual

Set/Get background color.

Default is: (0.3, 0.3, 0.3).

virtual void vtkLegendBoxActor::GetBackgroundColor ( double [3] )

virtual

Set/Get background color.

Default is: (0.3, 0.3, 0.3).

virtual void vtkLegendBoxActor::SetBackgroundOpacity ( double )

virtual

Set/Get background opacity.

Default is: 1.0

virtual double vtkLegendBoxActor::GetBackgroundOpacity ( )

virtual

Set/Get background opacity.

Default is: 1.0

void vtkLegendBoxActor::ShallowCopy ( vtkProp * prop )

overridevirtual

Shallow copy of this scaled text actor.

Overloads the virtual vtkProp method.

Reimplemented from vtkProp.

void vtkLegendBoxActor::ReleaseGraphicsResources ( vtkWindow * )

overridevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.

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 vtkProp.

int vtkLegendBoxActor::RenderOpaqueGeometry ( vtkViewport * viewport )

overridevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.

Draw the legend box to the screen.

Reimplemented from vtkProp.

int vtkLegendBoxActor::RenderTranslucentPolygonalGeometry ( vtkViewport * )

inlineoverridevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.

Draw the legend box to the screen.

Reimplemented from vtkProp.

Definition at line 224 of file vtkLegendBoxActor.h.

int vtkLegendBoxActor::RenderOverlay ( vtkViewport * viewport )

overridevirtual

WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERING PROCESS.

Draw the legend box to the screen.

Reimplemented from vtkProp.

vtkTypeBool vtkLegendBoxActor::HasTranslucentPolygonalGeometry ( )

overridevirtual

Does this prop have some translucent polygonal geometry?

Reimplemented from vtkProp.

void vtkLegendBoxActor::InitializeEntries ( )

protected

vtkPolyData vtkLegendBoxActor::createTexturedPlane ( )

protected

Member Data Documentation

vtkTypeBool vtkLegendBoxActor::Border

protected

Definition at line 241 of file vtkLegendBoxActor.h.

vtkTypeBool vtkLegendBoxActor::Box

protected

Definition at line 242 of file vtkLegendBoxActor.h.

int vtkLegendBoxActor::Padding

protected

Definition at line 243 of file vtkLegendBoxActor.h.

vtkTypeBool vtkLegendBoxActor::LockBorder

protected

Definition at line 244 of file vtkLegendBoxActor.h.

vtkTypeBool vtkLegendBoxActor::ScalarVisibility

protected

Definition at line 245 of file vtkLegendBoxActor.h.

double vtkLegendBoxActor::BoxOpacity

protected

Definition at line 246 of file vtkLegendBoxActor.h.

int vtkLegendBoxActor::NumberOfEntries

protected

Definition at line 249 of file vtkLegendBoxActor.h.

int vtkLegendBoxActor::Size

protected

Definition at line 250 of file vtkLegendBoxActor.h.

vtkDoubleArray* vtkLegendBoxActor::Colors

protected

Definition at line 251 of file vtkLegendBoxActor.h.

vtkTextMapper** vtkLegendBoxActor::TextMapper

protected

Definition at line 252 of file vtkLegendBoxActor.h.

vtkActor2D** vtkLegendBoxActor::TextActor

protected

Definition at line 253 of file vtkLegendBoxActor.h.

vtkPolyData** vtkLegendBoxActor::Symbol

protected

Definition at line 255 of file vtkLegendBoxActor.h.

vtkTransform** vtkLegendBoxActor::Transform

protected

Definition at line 256 of file vtkLegendBoxActor.h.

vtkTransformPolyDataFilter** vtkLegendBoxActor::SymbolTransform

protected

Definition at line 257 of file vtkLegendBoxActor.h.

vtkPolyDataMapper2D** vtkLegendBoxActor::SymbolMapper

protected

Definition at line 258 of file vtkLegendBoxActor.h.

vtkActor2D** vtkLegendBoxActor::SymbolActor

protected

Definition at line 259 of file vtkLegendBoxActor.h.

vtkPlaneSource** vtkLegendBoxActor::Icon

protected

Definition at line 261 of file vtkLegendBoxActor.h.

vtkTransform** vtkLegendBoxActor::IconTransform

protected

Definition at line 262 of file vtkLegendBoxActor.h.

vtkTransformPolyDataFilter** vtkLegendBoxActor::IconTransformFilter

protected

Definition at line 263 of file vtkLegendBoxActor.h.

vtkPolyDataMapper2D** vtkLegendBoxActor::IconMapper

protected

Definition at line 264 of file vtkLegendBoxActor.h.

vtkTexturedActor2D** vtkLegendBoxActor::IconActor

protected

Definition at line 265 of file vtkLegendBoxActor.h.

vtkImageData** vtkLegendBoxActor::IconImage

protected

Definition at line 266 of file vtkLegendBoxActor.h.

vtkPolyData* vtkLegendBoxActor::BorderPolyData

protected

Definition at line 268 of file vtkLegendBoxActor.h.

vtkPolyDataMapper2D* vtkLegendBoxActor::BorderMapper

protected

Definition at line 269 of file vtkLegendBoxActor.h.

vtkActor2D* vtkLegendBoxActor::BorderActor

protected

Definition at line 270 of file vtkLegendBoxActor.h.

vtkPolyData* vtkLegendBoxActor::BoxPolyData

protected

Definition at line 271 of file vtkLegendBoxActor.h.

vtkPolyDataMapper2D* vtkLegendBoxActor::BoxMapper

protected

Definition at line 272 of file vtkLegendBoxActor.h.

vtkActor2D* vtkLegendBoxActor::BoxActor

protected

Definition at line 273 of file vtkLegendBoxActor.h.

vtkTextProperty* vtkLegendBoxActor::EntryTextProperty

protected

Definition at line 274 of file vtkLegendBoxActor.h.

vtkTypeBool vtkLegendBoxActor::UseBackground

protected

Definition at line 277 of file vtkLegendBoxActor.h.

double vtkLegendBoxActor::BackgroundOpacity

protected

Definition at line 278 of file vtkLegendBoxActor.h.

double vtkLegendBoxActor::BackgroundColor[3]

protected

Definition at line 279 of file vtkLegendBoxActor.h.

vtkPlaneSource* vtkLegendBoxActor::Background

protected

Definition at line 280 of file vtkLegendBoxActor.h.

vtkTexturedActor2D* vtkLegendBoxActor::BackgroundActor

protected

Definition at line 283 of file vtkLegendBoxActor.h.

vtkPolyDataMapper2D* vtkLegendBoxActor::BackgroundMapper

protected

Definition at line 284 of file vtkLegendBoxActor.h.

int vtkLegendBoxActor::LegendEntriesVisible

protected

Definition at line 287 of file vtkLegendBoxActor.h.

int vtkLegendBoxActor::CachedSize[2]

protected

Definition at line 288 of file vtkLegendBoxActor.h.

vtkTimeStamp vtkLegendBoxActor::BuildTime

protected

Definition at line 289 of file vtkLegendBoxActor.h.

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

/home/demarle/Source/VTK/release/8.2/build/Utilities/Doxygen/dox/Rendering/Annotation/vtkLegendBoxActor.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