VTK
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 =========================================================================*/
61 #ifndef vtkAxisActor2D_h
62 #define vtkAxisActor2D_h
63 
64 #include "vtkRenderingAnnotationModule.h" // For export macro
65 #include "vtkActor2D.h"
66 
68 class vtkPolyData;
69 class vtkTextMapper;
70 class vtkTextProperty;
71 
72 class VTKRENDERINGANNOTATION_EXPORT vtkAxisActor2D : public vtkActor2D
73 {
74 public:
75  vtkTypeMacro(vtkAxisActor2D,vtkActor2D);
76  void PrintSelf(ostream& os, vtkIndent indent) override;
77 
81  static vtkAxisActor2D *New();
82 
84 
89  { return this->GetPositionCoordinate(); };
90  virtual void SetPoint1(double x[2]) { this->SetPosition(x); };
91  virtual void SetPoint1(double x, double y) { this->SetPosition(x,y); };
92  virtual double *GetPoint1() { return this->GetPosition(); };
94 
96 
103  { return this->GetPosition2Coordinate(); };
104  virtual void SetPoint2(double x[2]) { this->SetPosition2(x); };
105  virtual void SetPoint2(double x, double y) { this->SetPosition2(x,y); };
106  virtual double *GetPoint2() { return this->GetPosition2(); };
108 
110 
114  vtkSetVector2Macro(Range,double);
115  vtkGetVectorMacro(Range,double,2);
117 
119 
124  vtkSetMacro(RulerMode,vtkTypeBool);
125  vtkGetMacro(RulerMode,vtkTypeBool);
126  vtkBooleanMacro(RulerMode,vtkTypeBool);
128 
130 
134  vtkSetClampMacro(RulerDistance,double,0,VTK_FLOAT_MAX);
135  vtkGetMacro(RulerDistance,double);
137 
138  enum LabelMax
139  {
140  VTK_MAX_LABELS = 25
141  };
142 
144 
149  vtkSetClampMacro(NumberOfLabels, int, 2, VTK_MAX_LABELS);
150  vtkGetMacro(NumberOfLabels, int);
152 
154 
158  vtkSetStringMacro(LabelFormat);
159  vtkGetStringMacro(LabelFormat);
161 
163 
171  vtkSetMacro(AdjustLabels, vtkTypeBool);
172  vtkGetMacro(AdjustLabels, vtkTypeBool);
173  vtkBooleanMacro(AdjustLabels, vtkTypeBool);
174  virtual double *GetAdjustedRange()
175  {
176  this->UpdateAdjustedRange();
177  return this->AdjustedRange;
178  }
179  virtual void GetAdjustedRange(double &_arg1, double &_arg2)
180  {
181  this->UpdateAdjustedRange();
182  _arg1 = this->AdjustedRange[0];
183  _arg2 = this->AdjustedRange[1];
184  };
185  virtual void GetAdjustedRange(double _arg[2])
186  {
187  this->GetAdjustedRange(_arg[0], _arg[1]);
188  }
190  {
191  this->UpdateAdjustedRange();
192  return this->AdjustedNumberOfLabels;
193  }
195 
197 
200  vtkSetStringMacro(Title);
201  vtkGetStringMacro(Title);
203 
205 
208  virtual void SetTitleTextProperty(vtkTextProperty *p);
209  vtkGetObjectMacro(TitleTextProperty,vtkTextProperty);
211 
213 
216  virtual void SetLabelTextProperty(vtkTextProperty *p);
217  vtkGetObjectMacro(LabelTextProperty,vtkTextProperty);
219 
221 
225  vtkSetClampMacro(TickLength, int, 0, 100);
226  vtkGetMacro(TickLength, int);
228 
230 
234  vtkSetClampMacro(NumberOfMinorTicks, int, 0, 20);
235  vtkGetMacro(NumberOfMinorTicks, int);
237 
239 
243  vtkSetClampMacro(MinorTickLength, int, 0, 100);
244  vtkGetMacro(MinorTickLength, int);
246 
248 
253  vtkSetClampMacro(TickOffset, int, 0, 100);
254  vtkGetMacro(TickOffset, int);
256 
258 
261  vtkSetMacro(AxisVisibility, vtkTypeBool);
262  vtkGetMacro(AxisVisibility, vtkTypeBool);
263  vtkBooleanMacro(AxisVisibility, vtkTypeBool);
265 
267 
270  vtkSetMacro(TickVisibility, vtkTypeBool);
271  vtkGetMacro(TickVisibility, vtkTypeBool);
272  vtkBooleanMacro(TickVisibility, vtkTypeBool);
274 
276 
279  vtkSetMacro(LabelVisibility, vtkTypeBool);
280  vtkGetMacro(LabelVisibility, vtkTypeBool);
281  vtkBooleanMacro(LabelVisibility, vtkTypeBool);
283 
285 
288  vtkSetMacro(TitleVisibility, vtkTypeBool);
289  vtkGetMacro(TitleVisibility, vtkTypeBool);
290  vtkBooleanMacro(TitleVisibility, vtkTypeBool);
292 
294 
298  vtkSetMacro(TitlePosition, double);
299  vtkGetMacro(TitlePosition, double);
301 
303 
308  vtkSetClampMacro(FontFactor, double, 0.1, 2.0);
309  vtkGetMacro(FontFactor, double);
311 
313 
317  vtkSetClampMacro(LabelFactor, double, 0.1, 2.0);
318  vtkGetMacro(LabelFactor, double);
320 
322 
325  int RenderOverlay(vtkViewport* viewport) override;
326  int RenderOpaqueGeometry(vtkViewport* viewport) override;
329 
334 
340  void ReleaseGraphicsResources(vtkWindow *) override;
341 
352  static void ComputeRange(double inRange[2],
353  double outRange[2],
354  int inNumTicks,
355  int &outNumTicks,
356  double &interval);
357 
366  static int SetMultipleFontSize(vtkViewport *viewport,
367  vtkTextMapper **textMappers,
368  int nbOfMappers,
369  int *targetSize,
370  double factor,
371  int *stringSize);
372 
374 
378  vtkSetMacro(SizeFontRelativeToAxis,vtkTypeBool);
379  vtkGetMacro(SizeFontRelativeToAxis,vtkTypeBool);
380  vtkBooleanMacro(SizeFontRelativeToAxis,vtkTypeBool);
382 
384 
389  vtkSetMacro(UseFontSizeFromProperty,vtkTypeBool);
390  vtkGetMacro(UseFontSizeFromProperty,vtkTypeBool);
391  vtkBooleanMacro(UseFontSizeFromProperty,vtkTypeBool);
393 
397  void ShallowCopy(vtkProp *prop) override;
398 
399 protected:
400  vtkAxisActor2D();
401  ~vtkAxisActor2D() override;
402 
405 
406  char *Title;
407  double Range[2];
412  char *LabelFormat;
414  double FontFactor;
415  double LabelFactor;
420 
421  double AdjustedRange[2];
424 
429 
430  int LastPosition[2];
431  int LastPosition2[2];
432 
433  int LastSize[2];
434  int LastMaxLabelSize[2];
435 
438 
439  virtual void BuildAxis(vtkViewport *viewport);
440  static double ComputeStringOffset(double width, double height, double theta);
441  static void SetOffsetPosition(double xTick[3], double theta,
442  int stringWidth, int stringHeight,
443  int offset, vtkActor2D *actor);
444  virtual void UpdateAdjustedRange();
445 
448 
451 
455 
458 
459 private:
460  vtkAxisActor2D(const vtkAxisActor2D&) = delete;
461  void operator=(const vtkAxisActor2D&) = delete;
462 };
463 
464 
465 #endif
vtkAxisActor2D::SetPoint2
virtual void SetPoint2(double x[2])
Definition: vtkAxisActor2D.h:104
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:412
vtkAxisActor2D::RulerDistance
double RulerDistance
Definition: vtkAxisActor2D.h:410
vtkAxisActor2D::AxisMapper
vtkPolyDataMapper2D * AxisMapper
Definition: vtkAxisActor2D.h:453
vtkAxisActor2D::LabelTextProperty
vtkTextProperty * LabelTextProperty
Definition: vtkAxisActor2D.h:404
vtkAxisActor2D::TitleMapper
vtkTextMapper * TitleMapper
Definition: vtkAxisActor2D.h:446
vtkPolyDataMapper2D
draw vtkPolyData onto the image plane
Definition: vtkPolyDataMapper2D.h:51
vtkAxisActor2D::RulerMode
vtkTypeBool RulerMode
Definition: vtkAxisActor2D.h:409
vtkAxisActor2D::LabelVisibility
vtkTypeBool LabelVisibility
Definition: vtkAxisActor2D.h:427
vtkAxisActor2D::GetPoint2Coordinate
virtual vtkCoordinate * GetPoint2Coordinate()
Specify the position of the second point defining the axis.
Definition: vtkAxisActor2D.h:102
vtkActor2D::GetPosition2
virtual float * GetPosition2()
vtkActor2D::GetPositionCoordinate
virtual vtkCoordinate * GetPositionCoordinate()
Get the PositionCoordinate instance of vtkCoordinate.
vtkAxisActor2D::FontFactor
double FontFactor
Definition: vtkAxisActor2D.h:414
vtkAxisActor2D::UseFontSizeFromProperty
vtkTypeBool UseFontSizeFromProperty
Definition: vtkAxisActor2D.h:437
vtkActor2D::ShallowCopy
void ShallowCopy(vtkProp *prop) override
Shallow copy of this vtkActor2D.
vtkAxisActor2D::TitleActor
vtkActor2D * TitleActor
Definition: vtkAxisActor2D.h:447
vtkTimeStamp
record modification and/or execution time
Definition: vtkTimeStamp.h:35
vtkAxisActor2D::NumberOfLabels
int NumberOfLabels
Definition: vtkAxisActor2D.h:411
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:423
vtkAxisActor2D::AdjustedNumberOfLabels
int AdjustedNumberOfLabels
Definition: vtkAxisActor2D.h:422
vtkAxisActor2D::TickLength
int TickLength
Definition: vtkAxisActor2D.h:416
vtkAxisActor2D::SetPoint1
virtual void SetPoint1(double x, double y)
Definition: vtkAxisActor2D.h:91
vtkAxisActor2D::TickVisibility
vtkTypeBool TickVisibility
Definition: vtkAxisActor2D.h:426
vtkAxisActor2D::GetAdjustedRange
virtual double * GetAdjustedRange()
Definition: vtkAxisActor2D.h:174
vtkAxisActor2D::NumberOfMinorTicks
int NumberOfMinorTicks
Definition: vtkAxisActor2D.h:419
vtkWindow
window superclass for vtkRenderWindow
Definition: vtkWindow.h:37
vtkAxisActor2D::AxisVisibility
vtkTypeBool AxisVisibility
Definition: vtkAxisActor2D.h:425
vtkAxisActor2D::GetPoint1
virtual double * GetPoint1()
Definition: vtkAxisActor2D.h:92
vtkAxisActor2D::AdjustedRangeBuildTime
vtkTimeStamp AdjustedRangeBuildTime
Definition: vtkAxisActor2D.h:456
vtkActor2D::ReleaseGraphicsResources
void ReleaseGraphicsResources(vtkWindow *) override
Release any graphics resources that are being consumed by this actor.
vtkTextMapper
2D text annotation
Definition: vtkTextMapper.h:53
vtkAxisActor2D::TitleTextProperty
vtkTextProperty * TitleTextProperty
Definition: vtkAxisActor2D.h:403
vtkAxisActor2D::AxisActor
vtkActor2D * AxisActor
Definition: vtkAxisActor2D.h:454
vtkX3D::height
Definition: vtkX3D.h:254
vtkX3D::offset
Definition: vtkX3D.h:438
vtkActor2D::GetPosition2Coordinate
virtual vtkCoordinate * GetPosition2Coordinate()
Access the Position2 instance variable.
vtkAxisActor2D::AdjustLabels
vtkTypeBool AdjustLabels
Definition: vtkAxisActor2D.h:413
vtkActor2D::RenderOverlay
int RenderOverlay(vtkViewport *viewport) override
Support the standard render methods.
vtkAxisActor2D::GetAdjustedRange
virtual void GetAdjustedRange(double &_arg1, double &_arg2)
Definition: vtkAxisActor2D.h:179
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:39
vtkAxisActor2D::GetAdjustedNumberOfLabels
virtual int GetAdjustedNumberOfLabels()
Definition: vtkAxisActor2D.h:189
vtkAxisActor2D::TitleVisibility
vtkTypeBool TitleVisibility
Definition: vtkAxisActor2D.h:428
vtkCoordinate
perform coordinate transformation, and represent position, in a variety of vtk coordinate systems
Definition: vtkCoordinate.h:81
vtkAxisActor2D::TickOffset
int TickOffset
Definition: vtkAxisActor2D.h:418
VTK_FLOAT_MAX
#define VTK_FLOAT_MAX
Definition: vtkType.h:167
vtkAxisActor2D::Axis
vtkPolyData * Axis
Definition: vtkAxisActor2D.h:452
vtkViewport
abstract specification for Viewports
Definition: vtkViewport.h:47
vtkTextProperty
represent text properties.
Definition: vtkTextProperty.h:39
vtkAxisActor2D::RenderTranslucentPolygonalGeometry
int RenderTranslucentPolygonalGeometry(vtkViewport *) override
Definition: vtkAxisActor2D.h:327
vtkAxisActor2D::GetPoint2
virtual double * GetPoint2()
Definition: vtkAxisActor2D.h:106
vtkActor2D::GetPosition
virtual float * GetPosition()
vtkProp
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:52
vtkAxisActor2D::SetPoint2
virtual void SetPoint2(double x, double y)
Definition: vtkAxisActor2D.h:105
vtkActor2D::SetPosition
virtual void SetPosition(float x[2])
vtkActor2D
a actor that draws 2D data
Definition: vtkActor2D.h:45
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:406
vtkAxisActor2D::LabelMax
LabelMax
Definition: vtkAxisActor2D.h:138
vtkAxisActor2D::LabelFactor
double LabelFactor
Definition: vtkAxisActor2D.h:415
vtkAxisActor2D::SetPoint1
virtual void SetPoint1(double x[2])
Definition: vtkAxisActor2D.h:90
vtkAxisActor2D::GetAdjustedRange
virtual void GetAdjustedRange(double _arg[2])
Definition: vtkAxisActor2D.h:185
vtkPolyData
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:85
vtkAxisActor2D
Create an axis with tick marks and labels.
Definition: vtkAxisActor2D.h:72
vtkAxisActor2D::BuildTime
vtkTimeStamp BuildTime
Definition: vtkAxisActor2D.h:457
vtkAxisActor2D::LabelActors
vtkActor2D ** LabelActors
Definition: vtkAxisActor2D.h:450
vtkAxisActor2D::LabelMappers
vtkTextMapper ** LabelMappers
Definition: vtkAxisActor2D.h:449
vtkAxisActor2D::TitlePosition
double TitlePosition
Definition: vtkAxisActor2D.h:408
vtkAxisActor2D::SizeFontRelativeToAxis
int SizeFontRelativeToAxis
Definition: vtkAxisActor2D.h:436
vtkAxisActor2D::GetPoint1Coordinate
virtual vtkCoordinate * GetPoint1Coordinate()
Specify the position of the first point defining the axis.
Definition: vtkAxisActor2D.h:88
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:417