VTK  9.2.6
vtkLegendScaleActor.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkLegendScaleActor.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=========================================================================*/
36
37#ifndef vtkLegendScaleActor_h
38#define vtkLegendScaleActor_h
39
40#include "vtkCoordinate.h" // For vtkViewportCoordinateMacro
41#include "vtkProp.h"
42#include "vtkRenderingAnnotationModule.h" // For export macro
43
44class vtkAxisActor2D;
45class vtkTextProperty;
46class vtkPolyData;
48class vtkActor2D;
49class vtkTextMapper;
50class vtkPoints;
51class vtkCoordinate;
52
53class VTKRENDERINGANNOTATION_EXPORT vtkLegendScaleActor : public vtkProp
54{
55public:
60
62
66 void PrintSelf(ostream& os, vtkIndent indent) override;
68
74
76
82 vtkSetClampMacro(LabelMode, int, DISTANCE, XY_COORDINATES);
83 vtkGetMacro(LabelMode, int);
87
89
98 vtkBooleanMacro(TopAxisVisibility, vtkTypeBool);
106
108
114 vtkBooleanMacro(LegendVisibility, vtkTypeBool);
116
118
121 void AllAxesOn();
124
126
132
134
139 vtkSetClampMacro(RightBorderOffset, int, 5, VTK_INT_MAX);
140 vtkGetMacro(RightBorderOffset, int);
142
144
149 vtkSetClampMacro(TopBorderOffset, int, 5, VTK_INT_MAX);
150 vtkGetMacro(TopBorderOffset, int);
152
154
159 vtkSetClampMacro(LeftBorderOffset, int, 5, VTK_INT_MAX);
160 vtkGetMacro(LeftBorderOffset, int);
162
164
169 vtkSetClampMacro(BottomBorderOffset, int, 5, VTK_INT_MAX);
170 vtkGetMacro(BottomBorderOffset, int);
172
174
178 vtkSetClampMacro(CornerOffsetFactor, double, 1.0, 10.0);
179 vtkGetMacro(CornerOffsetFactor, double);
181
183
189
191
196 vtkGetObjectMacro(RightAxis, vtkAxisActor2D);
197 vtkGetObjectMacro(TopAxis, vtkAxisActor2D);
198 vtkGetObjectMacro(LeftAxis, vtkAxisActor2D);
199 vtkGetObjectMacro(BottomAxis, vtkAxisActor2D);
201
203
206 virtual void BuildRepresentation(vtkViewport* viewport);
212
213protected:
216
223
224 // The four axes around the borders of the renderer
229
230 // Control the display of the axes
235
236 // Support for the legend.
247
249
250private:
252 void operator=(const vtkLegendScaleActor&) = delete;
253};
254
255#endif
a actor that draws 2D data
Definition vtkActor2D.h:40
Create an axis with tick marks and labels.
perform coordinate transformation, and represent position, in a variety of vtk coordinate systems
a simple class to control print indentation
Definition vtkIndent.h:34
vtkTextProperty * LegendLabelProperty
~vtkLegendScaleActor() override
void GetActors2D(vtkPropCollection *) override
Standard methods supporting the rendering process.
void PrintSelf(ostream &os, vtkIndent indent) override
Standard methods for the class.
void AllAnnotationsOff()
Convenience method that turns all the axes and the legend scale.
vtkAxisActor2D * LeftAxis
virtual void SetLabelMode(int)
Specify the mode for labeling the scale axes.
vtkTextMapper * LabelMappers[6]
vtkAxisActor2D * RightAxis
void SetLabelModeToDistance()
Specify the mode for labeling the scale axes.
vtkTextProperty * LegendTitleProperty
void AllAxesOn()
Convenience method that turns all the axes either on or off.
int RenderOpaqueGeometry(vtkViewport *) override
Standard methods supporting the rendering process.
vtkAxisActor2D * BottomAxis
vtkPolyDataMapper2D * LegendMapper
void AllAxesOff()
Convenience method that turns all the axes either on or off.
void ReleaseGraphicsResources(vtkWindow *) override
Standard methods supporting the rendering process.
vtkActor2D * LabelActors[6]
virtual void BuildRepresentation(vtkViewport *viewport)
Standard methods supporting the rendering process.
static vtkLegendScaleActor * New()
Instantiate the class.
void AllAnnotationsOn()
Convenience method that turns all the axes and the legend scale.
void SetLabelModeToXYCoordinates()
Specify the mode for labeling the scale axes.
int RenderOverlay(vtkViewport *) override
Standard methods supporting the rendering process.
represent and manipulate 3D points
Definition vtkPoints.h:34
draw vtkPolyData onto the image plane
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition vtkPolyData.h:85
an ordered list of Props
2D text annotation
represent text properties.
record modification and/or execution time
abstract specification for Viewports
Definition vtkViewport.h:50
window superclass for vtkRenderWindow
Definition vtkWindow.h:39
int vtkTypeBool
Definition vtkABI.h:69
#define VTK_INT_MAX
Definition vtkType.h:155