Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Related Pages  

vtkLegendBoxActor Class Reference

draw symbols with text. More...

#include <vtkLegendBoxActor.h>

Inheritance diagram for vtkLegendBoxActor:

Inheritance graph
[legend]
Collaboration diagram for vtkLegendBoxActor:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void SetNumberOfEntries (int num)
int GetNumberOfEntries ()
void SetEntry (int i, vtkPolyData *symbol, const char *string, float color[3])
void SetEntrySymbol (int i, vtkPolyData *symbol)
void SetEntryString (int i, const char *string)
void SetEntryColor (int i, float color[3])
void SetEntryColor (int i, float r, float g, float b)
vtkPolyData * GetEntrySymbol (int i)
const char * GetEntryString (int i)
float * GetEntryColor (int i)
virtual void SetBold (int)
virtual int GetBold ()
virtual void BoldOn ()
virtual void BoldOff ()
virtual void SetItalic (int)
virtual int GetItalic ()
virtual void ItalicOn ()
virtual void ItalicOff ()
virtual void SetShadow (int)
virtual int GetShadow ()
virtual void ShadowOn ()
virtual void ShadowOff ()
virtual void SetFontFamily (int)
virtual int GetFontFamily ()
void SetFontFamilyToArial ()
void SetFontFamilyToCourier ()
void SetFontFamilyToTimes ()
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 SetPadding (int)
virtual int GetPadding ()
virtual void SetScalarVisibility (int)
virtual int GetScalarVisibility ()
virtual void ScalarVisibilityOn ()
virtual void ScalarVisibilityOff ()
void ShallowCopy (vtkProp *prop)
virtual void ReleaseGraphicsResources (vtkWindow *)
int RenderOpaqueGeometry (vtkViewport *viewport)
int RenderTranslucentGeometry (vtkViewport *)
int RenderOverlay (vtkViewport *viewport)

Static Public Methods

int IsTypeOf (const char *type)
vtkLegendBoxActor * SafeDownCast (vtkObject *o)
vtkLegendBoxActor * New ()

Protected Methods

 vtkLegendBoxActor ()
 ~vtkLegendBoxActor ()
 vtkLegendBoxActor (const vtkLegendBoxActor &)
void operator= (const vtkLegendBoxActor &)
void InitializeEntries ()

Protected Attributes

int Bold
int Italic
int Shadow
int FontFamily
int Border
int Padding
int LockBorder
int ScalarVisibility
int NumberOfEntries
int Size
vtkFloatArray * Colors
vtkTextMapper ** TextMapper
vtkActor2D ** TextActor
vtkPolyData ** Symbol
vtkTransform ** Transform
vtkTransformPolyDataFilter ** SymbolTransform
vtkPolyDataMapper2D ** SymbolMapper
vtkActor2D ** SymbolActor
vtkPolyData * BorderPolyData
vtkPolyDataMapper2D * BorderMapper
vtkActor2D * BorderActor
int LegendEntriesVisible
int CachedSize [2]
vtkTimeStamp BuildTime

Detailed Description

draw symbols with text.

Date:
2000/12/10 20:08:24
Revision:
1.6
Thanks:
Tim Smith who sponsored and encouraged the development of this class.
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 (as well as properties such as font). 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
Examples:
vtkLegendBoxActor (examples)

Definition at line 81 of file vtkLegendBoxActor.h.

Constructor & Destructor Documentation

vtkLegendBoxActor::vtkLegendBoxActor (    )  [protected]
 

vtkLegendBoxActor::~vtkLegendBoxActor (    )  [protected]
 

vtkLegendBoxActor::vtkLegendBoxActor (  const vtkLegendBoxActor &    )  [inline, protected]
 

Definition at line 188 of file vtkLegendBoxActor.h.

Member Function Documentation

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

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkActor2D.

int vtkLegendBoxActor::IsTypeOf (  const char *    type )  [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 *    type )  [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.

vtkLegendBoxActor* vtkLegendBoxActor::SafeDownCast (  vtkObject *    o )  [static]
 

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

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.

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]
 

Definition at line 93 of file vtkLegendBoxActor.h.

void vtkLegendBoxActor::SetEntry (  int    i,
vtkPolyData *    symbol,
const char *    string,
float    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::SetEntryString (  int    i,
const char *    string
) 
 

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

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

vtkPolyData* vtkLegendBoxActor::GetEntrySymbol (  int    i ) 
 

const char* vtkLegendBoxActor::GetEntryString (  int    i ) 
 

float* vtkLegendBoxActor::GetEntryColor (  int    i ) 
 

virtual void vtkLegendBoxActor::SetBold (  int    )  [virtual]
 

Enable/Disable bolding legend entries.

virtual int vtkLegendBoxActor::GetBold (    )  [virtual]
 

virtual void vtkLegendBoxActor::BoldOn (    )  [virtual]
 

virtual void vtkLegendBoxActor::BoldOff (    )  [virtual]
 

virtual void vtkLegendBoxActor::SetItalic (  int    )  [virtual]
 

Enable/Disable italicizing legend entries.

virtual int vtkLegendBoxActor::GetItalic (    )  [virtual]
 

virtual void vtkLegendBoxActor::ItalicOn (    )  [virtual]
 

virtual void vtkLegendBoxActor::ItalicOff (    )  [virtual]
 

virtual void vtkLegendBoxActor::SetShadow (  int    )  [virtual]
 

Enable/Disable creating shadows on the legend entries. Shadows make the text easier to read.

virtual int vtkLegendBoxActor::GetShadow (    )  [virtual]
 

virtual void vtkLegendBoxActor::ShadowOn (    )  [virtual]
 

virtual void vtkLegendBoxActor::ShadowOff (    )  [virtual]
 

virtual void vtkLegendBoxActor::SetFontFamily (  int    )  [virtual]
 

Set/Get the font family for the legend entries. Three font types are available: Arial (VTK_ARIAL), Courier (VTK_COURIER), and Times (VTK_TIMES).

virtual int vtkLegendBoxActor::GetFontFamily (    )  [virtual]
 

void vtkLegendBoxActor::SetFontFamilyToArial (    )  [inline]
 

Definition at line 134 of file vtkLegendBoxActor.h.

void vtkLegendBoxActor::SetFontFamilyToCourier (    )  [inline]
 

Definition at line 135 of file vtkLegendBoxActor.h.

void vtkLegendBoxActor::SetFontFamilyToTimes (    )  [inline]
 

Definition at line 136 of file vtkLegendBoxActor.h.

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]
 

virtual void vtkLegendBoxActor::BorderOn (    )  [virtual]
 

virtual void vtkLegendBoxActor::BorderOff (    )  [virtual]
 

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]
 

virtual void vtkLegendBoxActor::LockBorderOn (    )  [virtual]
 

virtual void vtkLegendBoxActor::LockBorderOff (    )  [virtual]
 

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]
 

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]
 

virtual void vtkLegendBoxActor::ScalarVisibilityOn (    )  [virtual]
 

virtual void vtkLegendBoxActor::ScalarVisibilityOff (    )  [virtual]
 

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.

int vtkLegendBoxActor::RenderTranslucentGeometry (  vtkViewport *    viewport )  [inline, virtual]
 

Reimplemented from vtkActor2D.

Definition at line 181 of file vtkLegendBoxActor.h.

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

Support the standard render methods.

Reimplemented from vtkActor2D.

void vtkLegendBoxActor::operator= (  const vtkLegendBoxActor &    )  [inline, protected]
 

Definition at line 189 of file vtkLegendBoxActor.h.

void vtkLegendBoxActor::InitializeEntries (    )  [protected]
 

Member Data Documentation

int vtkLegendBoxActor::Bold [protected]
 

Definition at line 193 of file vtkLegendBoxActor.h.

int vtkLegendBoxActor::Italic [protected]
 

Definition at line 194 of file vtkLegendBoxActor.h.

int vtkLegendBoxActor::Shadow [protected]
 

Definition at line 195 of file vtkLegendBoxActor.h.

int vtkLegendBoxActor::FontFamily [protected]
 

Definition at line 196 of file vtkLegendBoxActor.h.

int vtkLegendBoxActor::Border [protected]
 

Definition at line 197 of file vtkLegendBoxActor.h.

int vtkLegendBoxActor::Padding [protected]
 

Definition at line 198 of file vtkLegendBoxActor.h.

int vtkLegendBoxActor::LockBorder [protected]
 

Definition at line 199 of file vtkLegendBoxActor.h.

int vtkLegendBoxActor::ScalarVisibility [protected]
 

Definition at line 200 of file vtkLegendBoxActor.h.

int vtkLegendBoxActor::NumberOfEntries [protected]
 

Definition at line 203 of file vtkLegendBoxActor.h.

int vtkLegendBoxActor::Size [protected]
 

Definition at line 204 of file vtkLegendBoxActor.h.

vtkFloatArray* vtkLegendBoxActor::Colors [protected]
 

Definition at line 205 of file vtkLegendBoxActor.h.

vtkTextMapper** vtkLegendBoxActor::TextMapper [protected]
 

Definition at line 206 of file vtkLegendBoxActor.h.

vtkActor2D** vtkLegendBoxActor::TextActor [protected]
 

Definition at line 207 of file vtkLegendBoxActor.h.

vtkPolyData** vtkLegendBoxActor::Symbol [protected]
 

Definition at line 208 of file vtkLegendBoxActor.h.

vtkTransform** vtkLegendBoxActor::Transform [protected]
 

Definition at line 209 of file vtkLegendBoxActor.h.

vtkTransformPolyDataFilter** vtkLegendBoxActor::SymbolTransform [protected]
 

Definition at line 210 of file vtkLegendBoxActor.h.

vtkPolyDataMapper2D** vtkLegendBoxActor::SymbolMapper [protected]
 

Definition at line 211 of file vtkLegendBoxActor.h.

vtkActor2D** vtkLegendBoxActor::SymbolActor [protected]
 

Definition at line 212 of file vtkLegendBoxActor.h.

vtkPolyData* vtkLegendBoxActor::BorderPolyData [protected]
 

Definition at line 213 of file vtkLegendBoxActor.h.

vtkPolyDataMapper2D* vtkLegendBoxActor::BorderMapper [protected]
 

Definition at line 214 of file vtkLegendBoxActor.h.

vtkActor2D* vtkLegendBoxActor::BorderActor [protected]
 

Definition at line 215 of file vtkLegendBoxActor.h.

int vtkLegendBoxActor::LegendEntriesVisible [protected]
 

Definition at line 218 of file vtkLegendBoxActor.h.

int vtkLegendBoxActor::CachedSize[2] [protected]
 

Definition at line 219 of file vtkLegendBoxActor.h.

vtkTimeStamp vtkLegendBoxActor::BuildTime [protected]
 

Definition at line 220 of file vtkLegendBoxActor.h.

The documentation for this class was generated from the following file:
Generated on Wed Nov 21 12:52:42 2001 for VTK by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001