VTK  9.2.6
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 =========================================================================*/
130 #ifndef vtkLegendBoxActor_h
131 #define vtkLegendBoxActor_h
132 
133 #include "vtkActor2D.h"
134 #include "vtkRenderingAnnotationModule.h" // For export macro
135 
136 class vtkActor;
137 class vtkDoubleArray;
138 class vtkImageData;
139 class vtkPolyData;
140 class vtkPolyDataMapper2D;
141 class vtkPolyDataMapper;
142 class vtkPlaneSource;
143 class vtkTextMapper;
144 class vtkTextProperty;
145 class vtkTexturedActor2D;
146 class vtkTransform;
148 class vtkProperty2D;
149 
150 class VTKRENDERINGANNOTATION_EXPORT vtkLegendBoxActor : public vtkActor2D
151 {
152 public:
154  void PrintSelf(ostream& os, vtkIndent indent) override;
155 
161 
165  void SetNumberOfEntries(int num);
166  int GetNumberOfEntries() { return this->NumberOfEntries; }
167 
169 
179  void SetEntry(int i, vtkPolyData* symbol, const char* string, double color[3]);
180  void SetEntry(int i, vtkImageData* symbol, const char* string, double color[3]);
181  void SetEntry(
182  int i, vtkPolyData* symbol, vtkImageData* icon, const char* string, double color[3]);
184 
185  void SetEntrySymbol(int i, vtkPolyData* symbol);
186  void SetEntryIcon(int i, vtkImageData* icon);
187  void SetEntryString(int i, const char* string);
188  void SetEntryColor(int i, double color[3]);
189  void SetEntryColor(int i, double r, double g, double b);
190 
193  const char* GetEntryString(int i);
194  double* GetEntryColor(int i) VTK_SIZEHINT(3);
195 
197 
201  vtkGetObjectMacro(EntryTextProperty, vtkTextProperty);
203 
205 
209  vtkSetMacro(Border, vtkTypeBool);
210  vtkGetMacro(Border, vtkTypeBool);
211  vtkBooleanMacro(Border, vtkTypeBool);
213 
215 
223  vtkSetMacro(LockBorder, vtkTypeBool);
224  vtkGetMacro(LockBorder, vtkTypeBool);
225  vtkBooleanMacro(LockBorder, vtkTypeBool);
227 
229 
233  vtkSetMacro(Box, vtkTypeBool);
234  vtkGetMacro(Box, vtkTypeBool);
235  vtkBooleanMacro(Box, vtkTypeBool);
237 
241  vtkProperty2D* GetBoxProperty() { return this->BoxActor->GetProperty(); }
242 
244 
248  vtkSetClampMacro(Padding, int, 0, 50);
249  vtkGetMacro(Padding, int);
251 
253 
258  vtkSetMacro(ScalarVisibility, vtkTypeBool);
259  vtkGetMacro(ScalarVisibility, vtkTypeBool);
260  vtkBooleanMacro(ScalarVisibility, vtkTypeBool);
262 
264 
267  vtkSetMacro(UseBackground, vtkTypeBool);
268  vtkGetMacro(UseBackground, vtkTypeBool);
269  vtkBooleanMacro(UseBackground, vtkTypeBool);
271 
273 
277  vtkSetVector3Macro(BackgroundColor, double);
278  vtkGetVector3Macro(BackgroundColor, double);
280 
282 
286  vtkSetClampMacro(BackgroundOpacity, double, 0.0, 1.0);
287  vtkGetMacro(BackgroundOpacity, double);
289 
294  void ShallowCopy(vtkProp* prop) override;
295 
304 
306 
311  int RenderOpaqueGeometry(vtkViewport* viewport) override;
312  int RenderTranslucentPolygonalGeometry(vtkViewport*) override { return 0; }
313  int RenderOverlay(vtkViewport* viewport) override;
315 
320 
321 protected:
323  ~vtkLegendBoxActor() override;
324 
326 
328 
331  int Padding;
334  double BoxOpacity;
335 
336  // Internal actors, mappers, data to represent the legend
338  int Size; // allocation size
342 
348 
355 
363 
364  // Background plane.
367  double BackgroundColor[3];
369 
370  // May use texture.
373 
374  // Used to control whether the stuff is recomputed
376  int CachedSize[2];
378 
379 private:
380  vtkLegendBoxActor(const vtkLegendBoxActor&) = delete;
381  void operator=(const vtkLegendBoxActor&) = delete;
382 };
383 
384 #endif
a actor that draws 2D data
Definition: vtkActor2D.h:155
represents an object (geometry & properties) in a rendered scene
Definition: vtkActor.h:161
dynamic, self-adjusting array of double
topologically and geometrically regular array of data
Definition: vtkImageData.h:163
a simple class to control print indentation
Definition: vtkIndent.h:119
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:200
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:76
represent surface properties of a 2D image
2D text annotation
represent text properties.
actor that draws 2D data with texture support
record modification and/or execution time
Definition: vtkTimeStamp.h:55
transform points and associated normals and vectors for polygonal dataset
describes linear transformations via a 4x4 matrix
Definition: vtkTransform.h:170
abstract specification for Viewports
Definition: vtkViewport.h:56
window superclass for vtkRenderWindow
Definition: vtkWindow.h:39
@ Box
Definition: vtkX3D.h:71
@ color
Definition: vtkX3D.h:227
int vtkTypeBool
Definition: vtkABI.h:69
#define VTK_SIZEHINT(...)