vtkLegendBoxActor Class Reference
#include <vtkLegendBoxActor.h>
Inheritance diagram for vtkLegendBoxActor:
[legend]Collaboration diagram for vtkLegendBoxActor:
[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
- Created by:
-
- CVS contributions (if > 5%):
- Schroeder, Will (62%)
- Barre, Sebastien (20%)
- Martin, Ken (8%)
- CVS logs (CVSweb):
/Hybrid/vtkLegendBoxActor.cxx)/Hybrid/vtkLegendBoxActor.h)
Definition at line 65 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) |
| 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 | SetEntrySymbol (int i, vtkPolyData *symbol) |
| 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) |
| const char * | GetEntryString (int i) |
| double * | GetEntryColor (int i) |
|
| 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 () |
|
| int | RenderOpaqueGeometry (vtkViewport *viewport) |
| int | RenderTranslucentGeometry (vtkViewport *) |
| int | RenderOverlay (vtkViewport *viewport) |
Static Public Member Functions |
| int | IsTypeOf (const char *type) |
| vtkLegendBoxActor * | SafeDownCast (vtkObject *o) |
| vtkLegendBoxActor * | New () |
Protected Member Functions |
| | vtkLegendBoxActor () |
| | ~vtkLegendBoxActor () |
| void | InitializeEntries () |
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 |
| vtkPolyData * | BorderPolyData |
| vtkPolyDataMapper2D * | BorderMapper |
| vtkActor2D * | BorderActor |
| vtkPolyData * | BoxPolyData |
| vtkPolyDataMapper2D * | BoxMapper |
| vtkActor2D * | BoxActor |
| vtkTextProperty * | EntryTextProperty |
| int | LegendEntriesVisible |
| int | CachedSize [2] |
| vtkTimeStamp | BuildTime |
Member Typedef Documentation
Constructor & Destructor Documentation
| vtkLegendBoxActor::vtkLegendBoxActor |
( |
|
) |
[protected] |
|
Member Function Documentation
| virtual const char* vtkLegendBoxActor::GetClassName |
( |
|
) |
[virtual] |
|
| 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 vtkTypeRevisionMacro 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 vtkTypeRevisionMacro 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. |
|
|
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] |
|
| 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::SetEntrySymbol |
( |
int |
i, |
|
|
vtkPolyData * |
symbol |
|
) |
|
|
|
|
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::SetEntryString |
( |
int |
i, |
|
|
const char * |
string |
|
) |
|
|
|
|
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::SetEntryColor |
( |
int |
i, |
|
|
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::SetEntryColor |
( |
int |
i, |
|
|
double |
r, |
|
|
double |
g, |
|
|
double |
b |
|
) |
|
|
|
|
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().) |
| vtkPolyData* vtkLegendBoxActor::GetEntrySymbol |
( |
int |
i |
) |
|
|
|
|
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().) |
| const char* vtkLegendBoxActor::GetEntryString |
( |
int |
i |
) |
|
|
|
|
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().) |
| double* vtkLegendBoxActor::GetEntryColor |
( |
int |
i |
) |
|
|
|
|
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().) |
| 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. |
| 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. |
| 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 * |
|
) |
[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 170 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. |
| void vtkLegendBoxActor::InitializeEntries |
( |
|
) |
[protected] |
|
Member Data Documentation
The documentation for this class was generated from the following file: