VTK  9.0.1
vtkAxisActor2D.h
Go to the documentation of this file.
1 /*=========================================================================
2 
3  Program: Visualization Toolkit
4  Module: vtkAxisActor2D.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 =========================================================================*/
58 #ifndef vtkAxisActor2D_h
59 #define vtkAxisActor2D_h
60 
61 #include "vtkActor2D.h"
62 #include "vtkRenderingAnnotationModule.h" // For export macro
63 
65 class vtkPolyData;
66 class vtkTextMapper;
67 class vtkTextProperty;
68 
69 class VTKRENDERINGANNOTATION_EXPORT vtkAxisActor2D : public vtkActor2D
70 {
71 public:
72  vtkTypeMacro(vtkAxisActor2D, vtkActor2D);
73  void PrintSelf(ostream& os, vtkIndent indent) override;
74 
78  static vtkAxisActor2D* New();
79 
81 
86  virtual void SetPoint1(double x[2]) { this->SetPosition(x); }
87  virtual void SetPoint1(double x, double y) { this->SetPosition(x, y); }
88  virtual double* GetPoint1() { return this->GetPosition(); }
90 
92 
99  virtual void SetPoint2(double x[2]) { this->SetPosition2(x); }
100  virtual void SetPoint2(double x, double y) { this->SetPosition2(x, y); }
101  virtual double* GetPoint2() { return this->GetPosition2(); }
103 
105 
109  vtkSetVector2Macro(Range, double);
110  vtkGetVectorMacro(Range, double, 2);
112 
114 
119  vtkSetMacro(RulerMode, vtkTypeBool);
120  vtkGetMacro(RulerMode, vtkTypeBool);
121  vtkBooleanMacro(RulerMode, vtkTypeBool);
123 
125 
129  vtkSetClampMacro(RulerDistance, double, 0, VTK_FLOAT_MAX);
130  vtkGetMacro(RulerDistance, double);
132 
133  enum LabelMax
134  {
135  VTK_MAX_LABELS = 25
136  };
137 
139 
144  vtkSetClampMacro(NumberOfLabels, int, 2, VTK_MAX_LABELS);
145  vtkGetMacro(NumberOfLabels, int);
147 
149 
153  vtkSetStringMacro(LabelFormat);
154  vtkGetStringMacro(LabelFormat);
156 
158 
166  vtkSetMacro(AdjustLabels, vtkTypeBool);
167  vtkGetMacro(AdjustLabels, vtkTypeBool);
168  vtkBooleanMacro(AdjustLabels, vtkTypeBool);
169  virtual double* GetAdjustedRange()
170  {
171  this->UpdateAdjustedRange();
172  return this->AdjustedRange;
173  }
174  virtual void GetAdjustedRange(double& _arg1, double& _arg2)
175  {
176  this->UpdateAdjustedRange();
177  _arg1 = this->AdjustedRange[0];
178  _arg2 = this->AdjustedRange[1];
179  };
180  virtual void GetAdjustedRange(double _arg[2]) { this->GetAdjustedRange(_arg[0], _arg[1]); }
182  {
183  this->UpdateAdjustedRange();
184  return this->AdjustedNumberOfLabels;
185  }
187 
189 
192  vtkSetStringMacro(Title);
193  vtkGetStringMacro(Title);
195 
197 
200  virtual void SetTitleTextProperty(vtkTextProperty* p);
201  vtkGetObjectMacro(TitleTextProperty, vtkTextProperty);
203 
205 
208  virtual void SetLabelTextProperty(vtkTextProperty* p);
209  vtkGetObjectMacro(LabelTextProperty, vtkTextProperty);
211 
213 
217  vtkSetClampMacro(TickLength, int, 0, 100);
218  vtkGetMacro(TickLength, int);
220 
222 
226  vtkSetClampMacro(NumberOfMinorTicks, int, 0, 20);
227  vtkGetMacro(NumberOfMinorTicks, int);
229 
231 
235  vtkSetClampMacro(MinorTickLength, int, 0, 100);
236  vtkGetMacro(MinorTickLength, int);
238 
240 
245  vtkSetClampMacro(TickOffset, int, 0, 100);
246  vtkGetMacro(TickOffset, int);
248 
250 
253  vtkSetMacro(AxisVisibility, vtkTypeBool);
254  vtkGetMacro(AxisVisibility, vtkTypeBool);
255  vtkBooleanMacro(AxisVisibility, vtkTypeBool);
257 
259 
262  vtkSetMacro(TickVisibility, vtkTypeBool);
263  vtkGetMacro(TickVisibility, vtkTypeBool);
264  vtkBooleanMacro(TickVisibility, vtkTypeBool);
266 
268 
271  vtkSetMacro(LabelVisibility, vtkTypeBool);
272  vtkGetMacro(LabelVisibility, vtkTypeBool);
273  vtkBooleanMacro(LabelVisibility, vtkTypeBool);
275 
277 
280  vtkSetMacro(TitleVisibility, vtkTypeBool);
281  vtkGetMacro(TitleVisibility, vtkTypeBool);
282  vtkBooleanMacro(TitleVisibility, vtkTypeBool);
284 
286 
290  vtkSetMacro(TitlePosition, double);
291  vtkGetMacro(TitlePosition, double);
293 
295 
300  vtkSetClampMacro(FontFactor, double, 0.1, 2.0);
301  vtkGetMacro(FontFactor, double);
303 
305 
309  vtkSetClampMacro(LabelFactor, double, 0.1, 2.0);
310  vtkGetMacro(LabelFactor, double);
312 
314 
317  int RenderOverlay(vtkViewport* viewport) override;
318  int RenderOpaqueGeometry(vtkViewport* viewport) override;
319  int RenderTranslucentPolygonalGeometry(vtkViewport*) override { return 0; }
321 
326 
332  void ReleaseGraphicsResources(vtkWindow*) override;
333 
344  static void ComputeRange(
345  double inRange[2], double outRange[2], int inNumTicks, int& outNumTicks, double& interval);
346 
355  static int SetMultipleFontSize(vtkViewport* viewport, vtkTextMapper** textMappers,
356  int nbOfMappers, int* targetSize, double factor, int* stringSize);
357 
359 
363  vtkSetMacro(SizeFontRelativeToAxis, vtkTypeBool);
364  vtkGetMacro(SizeFontRelativeToAxis, vtkTypeBool);
365  vtkBooleanMacro(SizeFontRelativeToAxis, vtkTypeBool);
367 
369 
374  vtkSetMacro(UseFontSizeFromProperty, vtkTypeBool);
375  vtkGetMacro(UseFontSizeFromProperty, vtkTypeBool);
376  vtkBooleanMacro(UseFontSizeFromProperty, vtkTypeBool);
378 
382  void ShallowCopy(vtkProp* prop) override;
383 
384 protected:
385  vtkAxisActor2D();
386  ~vtkAxisActor2D() override;
387 
390 
391  char* Title;
392  double Range[2];
397  char* LabelFormat;
399  double FontFactor;
400  double LabelFactor;
405 
406  double AdjustedRange[2];
409 
414 
415  int LastPosition[2];
416  int LastPosition2[2];
417 
418  int LastSize[2];
419  int LastMaxLabelSize[2];
420 
423 
424  virtual void BuildAxis(vtkViewport* viewport);
425  static double ComputeStringOffset(double width, double height, double theta);
426  static void SetOffsetPosition(double xTick[3], double theta, int stringWidth, int stringHeight,
427  int offset, vtkActor2D* actor);
428  virtual void UpdateAdjustedRange();
429 
432 
435 
439 
442 
443 private:
444  vtkAxisActor2D(const vtkAxisActor2D&) = delete;
445  void operator=(const vtkAxisActor2D&) = delete;
446 };
447 
448 #endif
vtkAxisActor2D::SetPoint2
virtual void SetPoint2(double x[2])
Definition: vtkAxisActor2D.h:99
vtk::Range
auto Range(IterablePtr iterable, Options &&... opts) -> typename detail::IterableTraits< typename detail::StripPointers< IterablePtr >::type >::RangeType
Generate an iterable STL proxy object for a VTK container.
Definition: vtkRange.h:85
vtkActor2D::SetPosition2
virtual void SetPosition2(float x[2])
vtkActor2D::RenderOpaqueGeometry
int RenderOpaqueGeometry(vtkViewport *viewport) override
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...
vtkAxisActor2D::LabelFormat
char * LabelFormat
Definition: vtkAxisActor2D.h:397
vtkAxisActor2D::RulerDistance
double RulerDistance
Definition: vtkAxisActor2D.h:395
vtkAxisActor2D::AxisMapper
vtkPolyDataMapper2D * AxisMapper
Definition: vtkAxisActor2D.h:437
vtkAxisActor2D::LabelTextProperty
vtkTextProperty * LabelTextProperty
Definition: vtkAxisActor2D.h:389
vtkAxisActor2D::TitleMapper
vtkTextMapper * TitleMapper
Definition: vtkAxisActor2D.h:430
vtkPolyDataMapper2D
draw vtkPolyData onto the image plane
Definition: vtkPolyDataMapper2D.h:44
vtkAxisActor2D::RulerMode
vtkTypeBool RulerMode
Definition: vtkAxisActor2D.h:394
vtkAxisActor2D::LabelVisibility
vtkTypeBool LabelVisibility
Definition: vtkAxisActor2D.h:412
vtkAxisActor2D::GetPoint2Coordinate
virtual vtkCoordinate * GetPoint2Coordinate()
Specify the position of the second point defining the axis.
Definition: vtkAxisActor2D.h:98
vtkActor2D::GetPosition2
virtual float * GetPosition2()
vtkActor2D::GetPositionCoordinate
virtual vtkCoordinate * GetPositionCoordinate()
Get the PositionCoordinate instance of vtkCoordinate.
vtkAxisActor2D::FontFactor
double FontFactor
Definition: vtkAxisActor2D.h:399
vtkAxisActor2D::UseFontSizeFromProperty
vtkTypeBool UseFontSizeFromProperty
Definition: vtkAxisActor2D.h:422
vtkActor2D::ShallowCopy
void ShallowCopy(vtkProp *prop) override
Shallow copy of this vtkActor2D.
vtkAxisActor2D::TitleActor
vtkActor2D * TitleActor
Definition: vtkAxisActor2D.h:431
vtkTimeStamp
record modification and/or execution time
Definition: vtkTimeStamp.h:32
vtkAxisActor2D::NumberOfLabels
int NumberOfLabels
Definition: vtkAxisActor2D.h:396
vtkActor2D::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
vtkAxisActor2D::NumberOfLabelsBuilt
int NumberOfLabelsBuilt
Definition: vtkAxisActor2D.h:408
vtkAxisActor2D::AdjustedNumberOfLabels
int AdjustedNumberOfLabels
Definition: vtkAxisActor2D.h:407
vtkAxisActor2D::TickLength
int TickLength
Definition: vtkAxisActor2D.h:401
vtkAxisActor2D::SetPoint1
virtual void SetPoint1(double x, double y)
Definition: vtkAxisActor2D.h:87
vtkAxisActor2D::TickVisibility
vtkTypeBool TickVisibility
Definition: vtkAxisActor2D.h:411
vtkAxisActor2D::GetAdjustedRange
virtual double * GetAdjustedRange()
Definition: vtkAxisActor2D.h:169
vtkAxisActor2D::NumberOfMinorTicks
int NumberOfMinorTicks
Definition: vtkAxisActor2D.h:404
vtkWindow
window superclass for vtkRenderWindow
Definition: vtkWindow.h:37
vtkAxisActor2D::AxisVisibility
vtkTypeBool AxisVisibility
Definition: vtkAxisActor2D.h:410
vtkAxisActor2D::GetPoint1
virtual double * GetPoint1()
Definition: vtkAxisActor2D.h:88
vtkAxisActor2D::AdjustedRangeBuildTime
vtkTimeStamp AdjustedRangeBuildTime
Definition: vtkAxisActor2D.h:440
vtkActor2D::ReleaseGraphicsResources
void ReleaseGraphicsResources(vtkWindow *) override
Release any graphics resources that are being consumed by this actor.
vtkTextMapper
2D text annotation
Definition: vtkTextMapper.h:47
vtkAxisActor2D::TitleTextProperty
vtkTextProperty * TitleTextProperty
Definition: vtkAxisActor2D.h:388
vtkAxisActor2D::AxisActor
vtkActor2D * AxisActor
Definition: vtkAxisActor2D.h:438
vtkX3D::height
@ height
Definition: vtkX3D.h:260
vtkX3D::offset
@ offset
Definition: vtkX3D.h:444
vtkActor2D::GetPosition2Coordinate
virtual vtkCoordinate * GetPosition2Coordinate()
Access the Position2 instance variable.
vtkAxisActor2D::AdjustLabels
vtkTypeBool AdjustLabels
Definition: vtkAxisActor2D.h:398
vtkActor2D::RenderOverlay
int RenderOverlay(vtkViewport *viewport) override
Support the standard render methods.
vtkAxisActor2D::GetAdjustedRange
virtual void GetAdjustedRange(double &_arg1, double &_arg2)
Definition: vtkAxisActor2D.h:174
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:33
vtkAxisActor2D::GetAdjustedNumberOfLabels
virtual int GetAdjustedNumberOfLabels()
Definition: vtkAxisActor2D.h:181
vtkAxisActor2D::TitleVisibility
vtkTypeBool TitleVisibility
Definition: vtkAxisActor2D.h:413
vtkCoordinate
perform coordinate transformation, and represent position, in a variety of vtk coordinate systems
Definition: vtkCoordinate.h:76
vtkAxisActor2D::TickOffset
int TickOffset
Definition: vtkAxisActor2D.h:403
VTK_FLOAT_MAX
#define VTK_FLOAT_MAX
Definition: vtkType.h:163
vtkAxisActor2D::Axis
vtkPolyData * Axis
Definition: vtkAxisActor2D.h:436
vtkViewport
abstract specification for Viewports
Definition: vtkViewport.h:44
vtkTextProperty
represent text properties.
Definition: vtkTextProperty.h:33
vtkAxisActor2D::RenderTranslucentPolygonalGeometry
int RenderTranslucentPolygonalGeometry(vtkViewport *) override
Definition: vtkAxisActor2D.h:319
vtkAxisActor2D::GetPoint2
virtual double * GetPoint2()
Definition: vtkAxisActor2D.h:101
vtkActor2D::GetPosition
virtual float * GetPosition()
vtkProp
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:53
vtkAxisActor2D::SetPoint2
virtual void SetPoint2(double x, double y)
Definition: vtkAxisActor2D.h:100
vtkActor2D::SetPosition
virtual void SetPosition(float x[2])
vtkActor2D
a actor that draws 2D data
Definition: vtkActor2D.h:39
vtkActor2D.h
vtkActor2D::New
static vtkActor2D * New()
Creates an actor2D with the following defaults: position (0,0) (coordinate system is viewport); at la...
vtkAxisActor2D::Title
char * Title
Definition: vtkAxisActor2D.h:391
vtkAxisActor2D::LabelMax
LabelMax
Definition: vtkAxisActor2D.h:133
vtkAxisActor2D::LabelFactor
double LabelFactor
Definition: vtkAxisActor2D.h:400
vtkAxisActor2D::SetPoint1
virtual void SetPoint1(double x[2])
Definition: vtkAxisActor2D.h:86
vtkAxisActor2D::GetAdjustedRange
virtual void GetAdjustedRange(double _arg[2])
Definition: vtkAxisActor2D.h:180
vtkPolyData
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:84
vtkAxisActor2D
Create an axis with tick marks and labels.
Definition: vtkAxisActor2D.h:69
vtkAxisActor2D::BuildTime
vtkTimeStamp BuildTime
Definition: vtkAxisActor2D.h:441
vtkAxisActor2D::LabelActors
vtkActor2D ** LabelActors
Definition: vtkAxisActor2D.h:434
vtkAxisActor2D::LabelMappers
vtkTextMapper ** LabelMappers
Definition: vtkAxisActor2D.h:433
vtkAxisActor2D::TitlePosition
double TitlePosition
Definition: vtkAxisActor2D.h:393
vtkAxisActor2D::SizeFontRelativeToAxis
int SizeFontRelativeToAxis
Definition: vtkAxisActor2D.h:421
vtkAxisActor2D::GetPoint1Coordinate
virtual vtkCoordinate * GetPoint1Coordinate()
Specify the position of the first point defining the axis.
Definition: vtkAxisActor2D.h:85
vtkActor2D::HasTranslucentPolygonalGeometry
vtkTypeBool HasTranslucentPolygonalGeometry() override
Does this prop have some translucent polygonal geometry?
vtkTypeBool
int vtkTypeBool
Definition: vtkABI.h:69
vtkAxisActor2D::MinorTickLength
int MinorTickLength
Definition: vtkAxisActor2D.h:402