VTK  9.2.6
vtkCornerAnnotation.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkCornerAnnotation.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#ifndef vtkCornerAnnotation_h
37#define vtkCornerAnnotation_h
38
39#include "vtkActor2D.h"
40#include "vtkRenderingAnnotationModule.h" // For export macro
41
42class vtkTextMapper;
44class vtkImageActor;
45class vtkTextProperty;
46
47class VTKRENDERINGANNOTATION_EXPORT vtkCornerAnnotation : public vtkActor2D
48{
49public:
51 void PrintSelf(ostream& os, vtkIndent indent) override;
52
58
60
63 int RenderOpaqueGeometry(vtkViewport* viewport) override;
65 int RenderOverlay(vtkViewport* viewport) override;
67
72
74
79 vtkSetMacro(MaximumLineHeight, double);
80 vtkGetMacro(MaximumLineHeight, double);
82
84
88 vtkSetMacro(MinimumFontSize, int);
89 vtkGetMacro(MinimumFontSize, int);
90 vtkSetMacro(MaximumFontSize, int);
91 vtkGetMacro(MaximumFontSize, int);
93
95
104 vtkSetMacro(LinearFontScaleFactor, double);
105 vtkGetMacro(LinearFontScaleFactor, double);
106 vtkSetMacro(NonlinearFontScaleFactor, double);
107 vtkGetMacro(NonlinearFontScaleFactor, double);
109
116
118
123 {
124 LowerLeft = 0,
131 UpperEdge
132 };
133 static const int NumTextPositions = 8;
135
137
141 void SetText(int i, const char* text);
142 const char* GetText(int i);
146
148
152 vtkGetObjectMacro(ImageActor, vtkImageActor);
154
156
161 vtkGetObjectMacro(WindowLevel, vtkImageMapToWindowLevelColors);
163
165
168 vtkSetMacro(LevelShift, double);
169 vtkGetMacro(LevelShift, double);
171
173
176 vtkSetMacro(LevelScale, double);
177 vtkGetMacro(LevelScale, double);
179
181
185 vtkGetObjectMacro(TextProperty, vtkTextProperty);
187
189
192 vtkBooleanMacro(ShowSliceAndImage, vtkTypeBool);
193 vtkSetMacro(ShowSliceAndImage, vtkTypeBool);
194 vtkGetMacro(ShowSliceAndImage, vtkTypeBool);
196
197protected:
200
202
204
210
211 char* CornerText[NumTextPositions];
212
214 vtkActor2D* TextActor[NumTextPositions];
216 int LastSize[2];
217 vtkTextMapper* TextMapper[NumTextPositions];
218
221
224
226
231
233
236 virtual void SetTextActorsPosition(const int vsize[2]);
239
240private:
242 void operator=(const vtkCornerAnnotation&) = delete;
243};
244
245#endif
a actor that draws 2D data
Definition vtkActor2D.h:40
text annotation in four corners
static vtkCornerAnnotation * New()
Instantiate object with a rectangle in normaled view coordinates of (0.2,0.85, 0.8,...
int RenderTranslucentPolygonalGeometry(vtkViewport *) override
Draw the scalar bar and annotation text to the screen.
virtual void SetTextActorsPosition(const int vsize[2])
Set text actor positions given a viewport size and justification.
virtual void SetTextActorsJustification()
Set text actor positions given a viewport size and justification.
TextPosition
Position used to get or set the corner annotation text.
@ LowerEdge
Uses the lower edge center.
@ UpperLeft
Uses the upper left corner.
@ LeftEdge
Uses the left edge center.
@ UpperRight
Uses the upper right corner.
@ RightEdge
Uses the right edge center.
@ LowerRight
Uses the lower right corner.
~vtkCornerAnnotation() override
virtual void SetTextProperty(vtkTextProperty *p)
Set/Get the text property of all corners.
int RenderOpaqueGeometry(vtkViewport *viewport) override
Draw the scalar bar and annotation text to the screen.
vtkImageMapToWindowLevelColors * WindowLevel
void SetWindowLevel(vtkImageMapToWindowLevelColors *)
Set an instance of vtkImageMapToWindowLevelColors to use for looking at window level changes.
void SetText(int i, const char *text)
Set/Get the text to be displayed for each corner.
virtual void TextReplace(vtkImageActor *ia, vtkImageMapToWindowLevelColors *wl)
Search for replaceable tokens and replace.
void SetImageActor(vtkImageActor *)
Set an image actor to look at for slice information.
const char * GetText(int i)
Set/Get the text to be displayed for each corner.
vtkTextProperty * TextProperty
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkImageActor * LastImageActor
void ClearAllTexts()
Set/Get the text to be displayed for each corner.
vtkTypeBool HasTranslucentPolygonalGeometry() override
Does this prop have some translucent polygonal geometry?
int RenderOverlay(vtkViewport *viewport) override
Draw the scalar bar and annotation text to the screen.
void CopyAllTextsFrom(vtkCornerAnnotation *ca)
Set/Get the text to be displayed for each corner.
void ReleaseGraphicsResources(vtkWindow *) override
Release any graphics resources that are being consumed by this actor.
draw an image in a rendered 3D scene
Map an image through a lookup table and/or a window/level.
a simple class to control print indentation
Definition vtkIndent.h:34
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