VTK  9.2.5
vtkLegendBoxActor.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkLegendBoxActor.h
5
6 Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
7 All rights reserved.
8 See Copyright.txt or http://www.kitware.com/Copyright.htm for details.
9
10 This software is distributed WITHOUT ANY WARRANTY; without even
11 the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
12 PURPOSE. See the above copyright notice for more information.
13
14=========================================================================*/
41#ifndef vtkLegendBoxActor_h
42#define vtkLegendBoxActor_h
43
44#include "vtkActor2D.h"
45#include "vtkRenderingAnnotationModule.h" // For export macro
46
47class vtkActor;
48class vtkDoubleArray;
49class vtkImageData;
50class vtkPolyData;
53class vtkPlaneSource;
54class vtkTextMapper;
55class vtkTextProperty;
57class vtkTransform;
59class vtkProperty2D;
60
61class VTKRENDERINGANNOTATION_EXPORT vtkLegendBoxActor : public vtkActor2D
62{
63public:
65 void PrintSelf(ostream& os, vtkIndent indent) override;
66
72
76 void SetNumberOfEntries(int num);
77 int GetNumberOfEntries() { return this->NumberOfEntries; }
78
80
90 void SetEntry(int i, vtkPolyData* symbol, const char* string, double color[3]);
91 void SetEntry(int i, vtkImageData* symbol, const char* string, double color[3]);
93 int i, vtkPolyData* symbol, vtkImageData* icon, const char* string, double color[3]);
95
96 void SetEntrySymbol(int i, vtkPolyData* symbol);
97 void SetEntryIcon(int i, vtkImageData* icon);
98 void SetEntryString(int i, const char* string);
99 void SetEntryColor(int i, double color[3]);
100 void SetEntryColor(int i, double r, double g, double b);
101
104 const char* GetEntryString(int i);
105 double* GetEntryColor(int i) VTK_SIZEHINT(3);
106
108
112 vtkGetObjectMacro(EntryTextProperty, vtkTextProperty);
114
116
120 vtkSetMacro(Border, vtkTypeBool);
121 vtkGetMacro(Border, vtkTypeBool);
122 vtkBooleanMacro(Border, vtkTypeBool);
124
126
134 vtkSetMacro(LockBorder, vtkTypeBool);
135 vtkGetMacro(LockBorder, vtkTypeBool);
136 vtkBooleanMacro(LockBorder, vtkTypeBool);
138
140
144 vtkSetMacro(Box, vtkTypeBool);
145 vtkGetMacro(Box, vtkTypeBool);
146 vtkBooleanMacro(Box, vtkTypeBool);
148
152 vtkProperty2D* GetBoxProperty() { return this->BoxActor->GetProperty(); }
153
155
159 vtkSetClampMacro(Padding, int, 0, 50);
160 vtkGetMacro(Padding, int);
162
164
169 vtkSetMacro(ScalarVisibility, vtkTypeBool);
170 vtkGetMacro(ScalarVisibility, vtkTypeBool);
171 vtkBooleanMacro(ScalarVisibility, vtkTypeBool);
173
175
178 vtkSetMacro(UseBackground, vtkTypeBool);
179 vtkGetMacro(UseBackground, vtkTypeBool);
180 vtkBooleanMacro(UseBackground, vtkTypeBool);
182
184
188 vtkSetVector3Macro(BackgroundColor, double);
189 vtkGetVector3Macro(BackgroundColor, double);
191
193
197 vtkSetClampMacro(BackgroundOpacity, double, 0.0, 1.0);
198 vtkGetMacro(BackgroundOpacity, double);
200
205 void ShallowCopy(vtkProp* prop) override;
206
215
217
222 int RenderOpaqueGeometry(vtkViewport* viewport) override;
224 int RenderOverlay(vtkViewport* viewport) override;
226
231
232protected:
235
237
239
246
247 // Internal actors, mappers, data to represent the legend
249 int Size; // allocation size
253
259
266
274
275 // Background plane.
278 double BackgroundColor[3];
280
281 // May use texture.
284
285 // Used to control whether the stuff is recomputed
287 int CachedSize[2];
289
290private:
291 vtkLegendBoxActor(const vtkLegendBoxActor&) = delete;
292 void operator=(const vtkLegendBoxActor&) = delete;
293};
294
295#endif
a actor that draws 2D data
Definition: vtkActor2D.h:46
represents an object (geometry & properties) in a rendered scene
Definition: vtkActor.h:52
dynamic, self-adjusting array of double
topologically and geometrically regular array of data
Definition: vtkImageData.h:54
a simple class to control print indentation
Definition: vtkIndent.h:40
draw symbols with text
int RenderOpaqueGeometry(vtkViewport *viewport) override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
vtkTypeBool UseBackground
void SetNumberOfEntries(int num)
Specify the number of entries in the legend box.
int RenderOverlay(vtkViewport *viewport) override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
vtkPolyData * BoxPolyData
vtkTexturedActor2D ** IconActor
vtkTexturedActor2D * BackgroundActor
vtkTypeBool HasTranslucentPolygonalGeometry() override
Does this prop have some translucent polygonal geometry?
vtkTimeStamp BuildTime
vtkImageData ** IconImage
vtkTextProperty * EntryTextProperty
vtkTransformPolyDataFilter ** SymbolTransform
int RenderTranslucentPolygonalGeometry(vtkViewport *) override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
vtkPlaneSource * Background
void SetEntry(int i, vtkImageData *symbol, const char *string, double color[3])
Add an entry to the legend box.
void SetEntry(int i, vtkPolyData *symbol, vtkImageData *icon, const char *string, double color[3])
Add an entry to the legend box.
vtkPlaneSource ** Icon
vtkTransform ** IconTransform
vtkPolyDataMapper2D * BorderMapper
void ReleaseGraphicsResources(vtkWindow *) override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THIS METHOD OUTSIDE OF THE RENDERI...
vtkProperty2D * GetBoxProperty()
Get the box vtkProperty2D.
vtkActor2D * BorderActor
vtkPolyData createTexturedPlane()
void SetEntryColor(int i, double color[3])
vtkDoubleArray * Colors
void ShallowCopy(vtkProp *prop) override
Shallow copy of this scaled text actor.
double * GetEntryColor(int i)
vtkImageData * GetEntryIcon(int i)
vtkPolyDataMapper2D * BackgroundMapper
void SetEntrySymbol(int i, vtkPolyData *symbol)
vtkTypeBool ScalarVisibility
~vtkLegendBoxActor() override
vtkTextMapper ** TextMapper
virtual void SetEntryTextProperty(vtkTextProperty *p)
Set/Get the text property.
void SetEntry(int i, vtkPolyData *symbol, const char *string, double color[3])
Add an entry to the legend box.
void InitializeEntries()
vtkPolyDataMapper2D ** IconMapper
vtkTransformPolyDataFilter ** IconTransformFilter
vtkPolyData * BorderPolyData
vtkTransform ** Transform
void SetEntryColor(int i, double r, double g, double b)
static vtkLegendBoxActor * New()
Instantiate object with a rectangle in normaled view coordinates of (0.2,0.85, 0.8,...
vtkPolyDataMapper2D ** SymbolMapper
vtkPolyDataMapper2D * BoxMapper
vtkPolyData ** Symbol
void SetEntryString(int i, const char *string)
vtkPolyData * GetEntrySymbol(int i)
vtkActor2D ** SymbolActor
vtkActor2D ** TextActor
const char * GetEntryString(int i)
void SetEntryIcon(int i, vtkImageData *icon)
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
create an array of quadrilaterals located in a plane
draw vtkPolyData onto the image plane
map vtkPolyData to graphics primitives
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:91
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:57
represent surface properties of a 2D image
Definition: vtkProperty2D.h:41
2D text annotation
Definition: vtkTextMapper.h:51
represent text properties.
actor that draws 2D data with texture support
record modification and/or execution time
Definition: vtkTimeStamp.h:36
transform points and associated normals and vectors for polygonal dataset
describes linear transformations via a 4x4 matrix
Definition: vtkTransform.h:61
abstract specification for Viewports
Definition: vtkViewport.h:56
window superclass for vtkRenderWindow
Definition: vtkWindow.h:39
int vtkTypeBool
Definition: vtkABI.h:69
#define VTK_SIZEHINT(...)