VTK  9.3.0
vtkLegendBoxActor.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
38 #ifndef vtkLegendBoxActor_h
39 #define vtkLegendBoxActor_h
40 
41 #include "vtkActor2D.h"
42 #include "vtkRenderingAnnotationModule.h" // For export macro
43 
44 VTK_ABI_NAMESPACE_BEGIN
45 class vtkActor;
46 class vtkDoubleArray;
47 class vtkImageData;
48 class vtkPolyData;
50 class vtkPolyDataMapper;
51 class vtkPlaneSource;
52 class vtkTextMapper;
53 class vtkTextProperty;
54 class vtkTexturedActor2D;
55 class vtkTransform;
57 class vtkProperty2D;
58 
59 class VTKRENDERINGANNOTATION_EXPORT vtkLegendBoxActor : public vtkActor2D
60 {
61 public:
62  vtkTypeMacro(vtkLegendBoxActor, vtkActor2D);
63  void PrintSelf(ostream& os, vtkIndent indent) override;
64 
70 
74  void SetNumberOfEntries(int num);
75  int GetNumberOfEntries() { return this->NumberOfEntries; }
76 
78 
88  void SetEntry(int i, vtkPolyData* symbol, const char* string, double color[3]);
89  void SetEntry(int i, vtkImageData* symbol, const char* string, double color[3]);
90  void SetEntry(
91  int i, vtkPolyData* symbol, vtkImageData* icon, const char* string, double color[3]);
93 
94  void SetEntrySymbol(int i, vtkPolyData* symbol);
95  void SetEntryIcon(int i, vtkImageData* icon);
96  void SetEntryString(int i, const char* string);
97  void SetEntryColor(int i, double color[3]);
98  void SetEntryColor(int i, double r, double g, double b);
99 
102  const char* GetEntryString(int i);
103  double* GetEntryColor(int i) VTK_SIZEHINT(3);
104 
106 
110  vtkGetObjectMacro(EntryTextProperty, vtkTextProperty);
112 
114 
118  vtkSetMacro(Border, vtkTypeBool);
119  vtkGetMacro(Border, vtkTypeBool);
120  vtkBooleanMacro(Border, vtkTypeBool);
122 
124 
132  vtkSetMacro(LockBorder, vtkTypeBool);
133  vtkGetMacro(LockBorder, vtkTypeBool);
134  vtkBooleanMacro(LockBorder, vtkTypeBool);
136 
138 
142  vtkSetMacro(Box, vtkTypeBool);
143  vtkGetMacro(Box, vtkTypeBool);
144  vtkBooleanMacro(Box, vtkTypeBool);
146 
150  vtkProperty2D* GetBoxProperty() { return this->BoxActor->GetProperty(); }
151 
153 
157  vtkSetClampMacro(Padding, int, 0, 50);
158  vtkGetMacro(Padding, int);
160 
162 
167  vtkSetMacro(ScalarVisibility, vtkTypeBool);
168  vtkGetMacro(ScalarVisibility, vtkTypeBool);
169  vtkBooleanMacro(ScalarVisibility, vtkTypeBool);
171 
173 
176  vtkSetMacro(UseBackground, vtkTypeBool);
177  vtkGetMacro(UseBackground, vtkTypeBool);
178  vtkBooleanMacro(UseBackground, vtkTypeBool);
180 
182 
186  vtkSetVector3Macro(BackgroundColor, double);
187  vtkGetVector3Macro(BackgroundColor, double);
189 
191 
195  vtkSetClampMacro(BackgroundOpacity, double, 0.0, 1.0);
196  vtkGetMacro(BackgroundOpacity, double);
198 
203  void ShallowCopy(vtkProp* prop) override;
204 
213 
215 
220  int RenderOpaqueGeometry(vtkViewport* viewport) override;
221  int RenderTranslucentPolygonalGeometry(vtkViewport*) override { return 0; }
222  int RenderOverlay(vtkViewport* viewport) override;
224 
229 
230 protected:
232  ~vtkLegendBoxActor() override;
233 
235 
237 
240  int Padding;
243  double BoxOpacity;
244 
245  // Internal actors, mappers, data to represent the legend
247  int Size; // allocation size
251 
257 
264 
272 
273  // Background plane.
276  double BackgroundColor[3];
278 
279  // May use texture.
282 
283  // Used to control whether the stuff is recomputed
285  int CachedSize[2];
287 
288 private:
289  vtkLegendBoxActor(const vtkLegendBoxActor&) = delete;
290  void operator=(const vtkLegendBoxActor&) = delete;
291 };
292 
293 VTK_ABI_NAMESPACE_END
294 #endif
a actor that draws 2D data
Definition: vtkActor2D.h:44
represents an object (geometry & properties) in a rendered scene
Definition: vtkActor.h:50
dynamic, self-adjusting array of double
topologically and geometrically regular array of data
Definition: vtkImageData.h:52
a simple class to control print indentation
Definition: vtkIndent.h:38
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
vtkProperty2D * GetBoxProperty()
Get the box vtkProperty2D.
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.
vtkImageData * GetEntryIcon(int i)
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...
vtkActor2D * BorderActor
vtkPolyData createTexturedPlane()
void SetEntryColor(int i, double color[3])
vtkDoubleArray * Colors
vtkPolyData * GetEntrySymbol(int i)
void ShallowCopy(vtkProp *prop) override
Shallow copy of this scaled text actor.
vtkPolyDataMapper2D * BackgroundMapper
static vtkLegendBoxActor * New()
Instantiate object with a rectangle in normaled view coordinates of (0.2,0.85, 0.8,...
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.
const char * GetEntryString(int i)
void InitializeEntries()
vtkPolyDataMapper2D ** IconMapper
vtkTransformPolyDataFilter ** IconTransformFilter
vtkPolyData * BorderPolyData
vtkTransform ** Transform
void SetEntryColor(int i, double r, double g, double b)
vtkPolyDataMapper2D ** SymbolMapper
vtkPolyDataMapper2D * BoxMapper
vtkPolyData ** Symbol
double * GetEntryColor(int i)
void SetEntryString(int i, const char *string)
vtkActor2D ** SymbolActor
vtkActor2D ** TextActor
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:89
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:55
represent surface properties of a 2D image
Definition: vtkProperty2D.h:39
2D text annotation
Definition: vtkTextMapper.h:49
represent text properties.
actor that draws 2D data with texture support
record modification and/or execution time
Definition: vtkTimeStamp.h:34
transform points and associated normals and vectors for polygonal dataset
describes linear transformations via a 4x4 matrix
Definition: vtkTransform.h:59
abstract specification for Viewports
Definition: vtkViewport.h:54
window superclass for vtkRenderWindow
Definition: vtkWindow.h:37
@ Box
Definition: vtkX3D.h:65
@ color
Definition: vtkX3D.h:221
int vtkTypeBool
Definition: vtkABI.h:64
#define VTK_SIZEHINT(...)