vtkLegendBoxActor Class Reference

#include <vtkLegendBoxActor.h>

Inheritance diagram for vtkLegendBoxActor:

Inheritance graph
[legend]
Collaboration diagram for vtkLegendBoxActor:

Collaboration graph
[legend]

List of all members.


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


Public Types

typedef vtkActor2D Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
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)
vtkPolyDataGetEntrySymbol (int i)
vtkImageDataGetEntryIcon (int i)
const char * GetEntryString (int i)
double * GetEntryColor (int i)
vtkProperty2DGetBoxProperty ()
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 vtkTextPropertyGetEntryTextProperty ()
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 ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkLegendBoxActorSafeDownCast (vtkObject *o)
static vtkLegendBoxActorNew ()

Protected Member Functions

 vtkLegendBoxActor ()
 ~vtkLegendBoxActor ()
void InitializeEntries ()
vtkPolyData createTexturedPlane ()

Protected Attributes

int Border
int Box
int Padding
int LockBorder
int ScalarVisibility
double BoxOpacity
int NumberOfEntries
int Size
vtkDoubleArrayColors
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
vtkPolyDataBorderPolyData
vtkPolyDataMapper2DBorderMapper
vtkActor2DBorderActor
vtkPolyDataBoxPolyData
vtkPolyDataMapper2DBoxMapper
vtkActor2DBoxActor
vtkTextPropertyEntryTextProperty
int UseBackground
double BackgroundOpacity
double BackgroundColor [3]
vtkPlaneSourceBackground
vtkTexturedActor2DBackgroundActor
vtkPolyDataMapper2DBackgroundMapper
int LegendEntriesVisible
int CachedSize [2]
vtkTimeStamp BuildTime

Member Typedef Documentation

Reimplemented from vtkActor2D.

Definition at line 62 of file vtkLegendBoxActor.h.


Constructor & Destructor Documentation

vtkLegendBoxActor::vtkLegendBoxActor (  )  [protected]

vtkLegendBoxActor::~vtkLegendBoxActor (  )  [protected]


Member Function Documentation

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

Reimplemented from vtkActor2D.

static int vtkLegendBoxActor::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 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 ( vtkObject o  )  [static]

Reimplemented from vtkActor2D.

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

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

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

Reimplemented from vtkActor2D.

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 72 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 137 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]

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  )  [virtual]

Shallow copy of this scaled text actor. Overloads the virtual vtkProp method.

Reimplemented from vtkActor2D.

virtual void vtkLegendBoxActor::ReleaseGraphicsResources ( vtkWindow  )  [virtual]

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

int vtkLegendBoxActor::RenderOpaqueGeometry ( vtkViewport viewport  )  [virtual]

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

virtual int vtkLegendBoxActor::RenderTranslucentPolygonalGeometry ( vtkViewport  )  [inline, virtual]

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

Definition at line 190 of file vtkLegendBoxActor.h.

int vtkLegendBoxActor::RenderOverlay ( vtkViewport viewport  )  [virtual]

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

virtual int vtkLegendBoxActor::HasTranslucentPolygonalGeometry (  )  [virtual]

Does this prop have some translucent polygonal geometry?

Reimplemented from vtkActor2D.

void vtkLegendBoxActor::InitializeEntries (  )  [protected]

vtkPolyData vtkLegendBoxActor::createTexturedPlane (  )  [protected]


Member Data Documentation

int vtkLegendBoxActor::Border [protected]

Definition at line 208 of file vtkLegendBoxActor.h.

int vtkLegendBoxActor::Box [protected]

Definition at line 209 of file vtkLegendBoxActor.h.

int vtkLegendBoxActor::Padding [protected]

Definition at line 210 of file vtkLegendBoxActor.h.

Definition at line 211 of file vtkLegendBoxActor.h.

Definition at line 212 of file vtkLegendBoxActor.h.

double vtkLegendBoxActor::BoxOpacity [protected]

Definition at line 213 of file vtkLegendBoxActor.h.

Definition at line 216 of file vtkLegendBoxActor.h.

int vtkLegendBoxActor::Size [protected]

Definition at line 217 of file vtkLegendBoxActor.h.

Definition at line 218 of file vtkLegendBoxActor.h.

Definition at line 219 of file vtkLegendBoxActor.h.

Definition at line 220 of file vtkLegendBoxActor.h.

Definition at line 222 of file vtkLegendBoxActor.h.

Definition at line 223 of file vtkLegendBoxActor.h.

Definition at line 224 of file vtkLegendBoxActor.h.

Definition at line 225 of file vtkLegendBoxActor.h.

Definition at line 226 of file vtkLegendBoxActor.h.

Definition at line 228 of file vtkLegendBoxActor.h.

Definition at line 229 of file vtkLegendBoxActor.h.

Definition at line 230 of file vtkLegendBoxActor.h.

Definition at line 231 of file vtkLegendBoxActor.h.

Definition at line 232 of file vtkLegendBoxActor.h.

Definition at line 233 of file vtkLegendBoxActor.h.

Definition at line 235 of file vtkLegendBoxActor.h.

Definition at line 236 of file vtkLegendBoxActor.h.

Definition at line 237 of file vtkLegendBoxActor.h.

Definition at line 238 of file vtkLegendBoxActor.h.

Definition at line 239 of file vtkLegendBoxActor.h.

Definition at line 240 of file vtkLegendBoxActor.h.

Definition at line 241 of file vtkLegendBoxActor.h.

Definition at line 244 of file vtkLegendBoxActor.h.

Definition at line 245 of file vtkLegendBoxActor.h.

double vtkLegendBoxActor::BackgroundColor[3] [protected]

Definition at line 246 of file vtkLegendBoxActor.h.

Definition at line 247 of file vtkLegendBoxActor.h.

Definition at line 250 of file vtkLegendBoxActor.h.

Definition at line 251 of file vtkLegendBoxActor.h.

Definition at line 254 of file vtkLegendBoxActor.h.

int vtkLegendBoxActor::CachedSize[2] [protected]

Definition at line 255 of file vtkLegendBoxActor.h.

Definition at line 256 of file vtkLegendBoxActor.h.


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

Generated on Wed Aug 24 11:45:33 2011 for VTK by  doxygen 1.5.6