VTK
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 =========================================================================*/
39 #ifndef vtkCornerAnnotation_h
40 #define vtkCornerAnnotation_h
41 
42 #include "vtkRenderingAnnotationModule.h" // For export macro
43 #include "vtkActor2D.h"
44 
45 class vtkTextMapper;
47 class vtkImageActor;
48 class vtkTextProperty;
49 
50 class VTKRENDERINGANNOTATION_EXPORT vtkCornerAnnotation : public vtkActor2D
51 {
52 public:
54  void PrintSelf(ostream& os, vtkIndent indent) override;
55 
61 
63 
66  int RenderOpaqueGeometry(vtkViewport* viewport) override;
67  int RenderTranslucentPolygonalGeometry(vtkViewport* ) override {return 0;};
68  int RenderOverlay(vtkViewport* viewport) override;
70 
75 
77 
82  vtkSetMacro(MaximumLineHeight,double);
83  vtkGetMacro(MaximumLineHeight,double);
85 
87 
91  vtkSetMacro(MinimumFontSize,int);
92  vtkGetMacro(MinimumFontSize,int);
93  vtkSetMacro(MaximumFontSize,int);
94  vtkGetMacro(MaximumFontSize,int);
96 
98 
107  vtkSetMacro( LinearFontScaleFactor, double );
108  vtkGetMacro( LinearFontScaleFactor, double );
109  vtkSetMacro( NonlinearFontScaleFactor, double );
110  vtkGetMacro( NonlinearFontScaleFactor, double );
112 
119 
121 
126  {
127  LowerLeft = 0,
134  UpperEdge
135  };
136  static const int NumTextPositions = 8;
138 
140 
144  void SetText(int i, const char *text);
145  const char* GetText(int i);
149 
151 
155  vtkGetObjectMacro(ImageActor,vtkImageActor);
157 
159 
164  vtkGetObjectMacro(WindowLevel,vtkImageMapToWindowLevelColors);
166 
168 
171  vtkSetMacro(LevelShift, double);
172  vtkGetMacro(LevelShift, double);
174 
176 
179  vtkSetMacro(LevelScale, double);
180  vtkGetMacro(LevelScale, double);
182 
184 
188  vtkGetObjectMacro(TextProperty,vtkTextProperty);
190 
192 
195  vtkBooleanMacro(ShowSliceAndImage, vtkTypeBool);
196  vtkSetMacro(ShowSliceAndImage, vtkTypeBool);
197  vtkGetMacro(ShowSliceAndImage, vtkTypeBool);
199 
200 protected:
203 
205 
207 
209  double LevelShift;
210  double LevelScale;
213 
214  char *CornerText[NumTextPositions];
215 
216  int FontSize;
217  vtkActor2D *TextActor[NumTextPositions];
219  int LastSize[2];
220  vtkTextMapper *TextMapper[NumTextPositions];
221 
224 
227 
229 
233  virtual void TextReplace(
235 
237 
240  virtual void SetTextActorsPosition(int vsize[2]);
243 
244 private:
245  vtkCornerAnnotation(const vtkCornerAnnotation&) = delete;
246  void operator=(const vtkCornerAnnotation&) = delete;
247 };
248 
249 
250 #endif
251 
252 
253 
vtkCornerAnnotation::LeftEdge
@ LeftEdge
Uses the left edge center.
Definition: vtkCornerAnnotation.h:133
vtkCornerAnnotation::MinimumFontSize
int MinimumFontSize
Definition: vtkCornerAnnotation.h:222
vtkCornerAnnotation::MaximumFontSize
int MaximumFontSize
Definition: vtkCornerAnnotation.h:223
vtkCornerAnnotation::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkCornerAnnotation::TextProperty
vtkTextProperty * TextProperty
Definition: vtkCornerAnnotation.h:206
vtkCornerAnnotation::ClearAllTexts
void ClearAllTexts()
vtkCornerAnnotation::ReleaseGraphicsResources
void ReleaseGraphicsResources(vtkWindow *) override
Release any graphics resources that are being consumed by this actor.
vtkCornerAnnotation::LevelScale
double LevelScale
Definition: vtkCornerAnnotation.h:210
vtkTimeStamp
record modification and/or execution time
Definition: vtkTimeStamp.h:36
vtkCornerAnnotation::SetTextProperty
virtual void SetTextProperty(vtkTextProperty *p)
Set/Get the text property of all corners.
vtkCornerAnnotation::ImageActor
vtkImageActor * ImageActor
Definition: vtkCornerAnnotation.h:211
vtkCornerAnnotation::ShowSliceAndImage
vtkTypeBool ShowSliceAndImage
Definition: vtkCornerAnnotation.h:228
vtkWindow
window superclass for vtkRenderWindow
Definition: vtkWindow.h:38
vtkCornerAnnotation::vtkCornerAnnotation
vtkCornerAnnotation()
vtkCornerAnnotation::UpperRight
@ UpperRight
Uses the upper right corner.
Definition: vtkCornerAnnotation.h:130
vtkCornerAnnotation::BuildTime
vtkTimeStamp BuildTime
Definition: vtkCornerAnnotation.h:218
vtkCornerAnnotation::LastImageActor
vtkImageActor * LastImageActor
Definition: vtkCornerAnnotation.h:212
vtkCornerAnnotation::LowerRight
@ LowerRight
Uses the lower right corner.
Definition: vtkCornerAnnotation.h:128
vtkCornerAnnotation::RenderOverlay
int RenderOverlay(vtkViewport *viewport) override
vtkTextMapper
2D text annotation
Definition: vtkTextMapper.h:54
vtkCornerAnnotation::SetText
void SetText(int i, const char *text)
Set/Get the text to be displayed for each corner.
vtkCornerAnnotation::SetTextActorsPosition
virtual void SetTextActorsPosition(int vsize[2])
Set text actor positions given a viewport size and justification.
vtkCornerAnnotation::GetText
const char * GetText(int i)
vtkCornerAnnotation::RightEdge
@ RightEdge
Uses the right edge center.
Definition: vtkCornerAnnotation.h:132
vtkCornerAnnotation::RenderOpaqueGeometry
int RenderOpaqueGeometry(vtkViewport *viewport) override
Draw the scalar bar and annotation text to the screen.
vtkCornerAnnotation::LowerEdge
@ LowerEdge
Uses the lower edge center.
Definition: vtkCornerAnnotation.h:131
vtkImageMapToWindowLevelColors
Map an image through a lookup table and/or a window/level.
Definition: vtkImageMapToWindowLevelColors.h:53
vtkCornerAnnotation
text annotation in four corners
Definition: vtkCornerAnnotation.h:51
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
vtkCornerAnnotation::UpperLeft
@ UpperLeft
Uses the upper left corner.
Definition: vtkCornerAnnotation.h:129
vtkCornerAnnotation::SetTextActorsJustification
virtual void SetTextActorsJustification()
vtkCornerAnnotation::MaximumLineHeight
double MaximumLineHeight
Definition: vtkCornerAnnotation.h:204
vtkCornerAnnotation::LevelShift
double LevelShift
Definition: vtkCornerAnnotation.h:209
vtkViewport
abstract specification for Viewports
Definition: vtkViewport.h:48
vtkTextProperty
represent text properties.
Definition: vtkTextProperty.h:40
vtkCornerAnnotation::NonlinearFontScaleFactor
double NonlinearFontScaleFactor
Definition: vtkCornerAnnotation.h:226
vtkCornerAnnotation::TextReplace
virtual void TextReplace(vtkImageActor *ia, vtkImageMapToWindowLevelColors *wl)
Search for replaceable tokens and replace.
vtkCornerAnnotation::HasTranslucentPolygonalGeometry
vtkTypeBool HasTranslucentPolygonalGeometry() override
Does this prop have some translucent polygonal geometry?
vtkActor2D
a actor that draws 2D data
Definition: vtkActor2D.h:46
vtkActor2D.h
vtkCornerAnnotation::TextPosition
TextPosition
Position used to get or set the corner annotation text.
Definition: vtkCornerAnnotation.h:126
vtkCornerAnnotation::New
static vtkCornerAnnotation * New()
Instantiate object with a rectangle in normaled view coordinates of (0.2,0.85, 0.8,...
vtkCornerAnnotation::FontSize
int FontSize
Definition: vtkCornerAnnotation.h:216
vtkCornerAnnotation::WindowLevel
vtkImageMapToWindowLevelColors * WindowLevel
Definition: vtkCornerAnnotation.h:208
vtkImageActor
draw an image in a rendered 3D scene
Definition: vtkImageActor.h:50
vtkCornerAnnotation::LinearFontScaleFactor
double LinearFontScaleFactor
Definition: vtkCornerAnnotation.h:225
vtkCornerAnnotation::CopyAllTextsFrom
void CopyAllTextsFrom(vtkCornerAnnotation *ca)
vtkCornerAnnotation::SetImageActor
void SetImageActor(vtkImageActor *)
Set an image actor to look at for slice information.
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkCornerAnnotation::RenderTranslucentPolygonalGeometry
int RenderTranslucentPolygonalGeometry(vtkViewport *) override
Definition: vtkCornerAnnotation.h:67
vtkCornerAnnotation::SetWindowLevel
void SetWindowLevel(vtkImageMapToWindowLevelColors *)
Set an instance of vtkImageMapToWindowLevelColors to use for looking at window level changes.
vtkCornerAnnotation::~vtkCornerAnnotation
~vtkCornerAnnotation() override