#include <vtkLegendBoxActor.h>
Inheritance diagram for vtkLegendBoxActor:
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.
Definition at line 53 of file vtkLegendBoxActor.h.
|
Reimplemented from vtkActor2D. Definition at line 56 of file vtkLegendBoxActor.h. |
|
|
|
|
|
Reimplemented from vtkActor2D. |
|
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. |
|
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. |
|
Reimplemented from vtkActor2D. |
|
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. |
|
Specify the number of entries in the legend box. |
|
Specify the number of entries in the legend box. Definition at line 66 of file vtkLegendBoxActor.h. |
|
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().) |
|
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().) |
|
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().) |
|
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().) |
|
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().) |
|
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().) |
|
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().) |
|
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().) |
|
Set/Get the text property. |
|
Set/Get the text property. |
|
Set/Get the flag that controls whether a border will be drawn around the legend box. |
|
Set/Get the flag that controls whether a border will be drawn around the legend box. |
|
Set/Get the flag that controls whether a border will be drawn around the legend box. |
|
Set/Get the flag that controls whether a border will be drawn around the legend box. |
|
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. |
|
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. |
|
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. |
|
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. |
|
Set/Get the flag that controls whether a box will be drawn/filled corresponding to the legend box. |
|
Set/Get the flag that controls whether a box will be drawn/filled corresponding to the legend box. |
|
Set/Get the flag that controls whether a box will be drawn/filled corresponding to the legend box. |
|
Set/Get the flag that controls whether a box will be drawn/filled corresponding to the legend box. |
|
Get the box vtkProperty2D. Definition at line 124 of file vtkLegendBoxActor.h. |
|
Set/Get the padding between the legend entries and the border. The value is specified in pixels. |
|
Get the box vtkProperty2D. |
|
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. |
|
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. |
|
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. |
|
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. |
|
Shallow copy of this scaled text actor. Overloads the virtual vtkProp method. Reimplemented from vtkActor2D. |
|
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. |
|
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. |
|
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. Definition at line 158 of file vtkLegendBoxActor.h. |
|
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. |
|
|
|
Definition at line 170 of file vtkLegendBoxActor.h. |
|
Definition at line 171 of file vtkLegendBoxActor.h. |
|
Definition at line 172 of file vtkLegendBoxActor.h. |
|
Definition at line 173 of file vtkLegendBoxActor.h. |
|
Definition at line 174 of file vtkLegendBoxActor.h. |
|
Definition at line 175 of file vtkLegendBoxActor.h. |
|
Definition at line 178 of file vtkLegendBoxActor.h. |
|
Definition at line 179 of file vtkLegendBoxActor.h. |
|
Definition at line 180 of file vtkLegendBoxActor.h. |
|
Definition at line 181 of file vtkLegendBoxActor.h. |
|
Definition at line 182 of file vtkLegendBoxActor.h. |
|
Definition at line 183 of file vtkLegendBoxActor.h. |
|
Definition at line 184 of file vtkLegendBoxActor.h. |
|
Definition at line 185 of file vtkLegendBoxActor.h. |
|
Definition at line 186 of file vtkLegendBoxActor.h. |
|
Definition at line 187 of file vtkLegendBoxActor.h. |
|
Definition at line 188 of file vtkLegendBoxActor.h. |
|
Definition at line 189 of file vtkLegendBoxActor.h. |
|
Definition at line 190 of file vtkLegendBoxActor.h. |
|
Definition at line 191 of file vtkLegendBoxActor.h. |
|
Definition at line 192 of file vtkLegendBoxActor.h. |
|
Definition at line 193 of file vtkLegendBoxActor.h. |
|
Definition at line 194 of file vtkLegendBoxActor.h. |
|
Definition at line 197 of file vtkLegendBoxActor.h. |
|
Definition at line 198 of file vtkLegendBoxActor.h. |
|
Definition at line 199 of file vtkLegendBoxActor.h. |