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
68class vtkPolyData;
69class vtkTextMapper;
70class vtkTextProperty;
71
72class VTKRENDERINGANNOTATION_EXPORT vtkAxisActor2D : public vtkActor2D
73{
74public:
76 void PrintSelf(ostream& os, vtkIndent indent);
77
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,int);
125 vtkGetMacro(RulerMode,int);
126 vtkBooleanMacro(RulerMode,int);
128
130
134 vtkSetClampMacro(RulerDistance,double,0,VTK_FLOAT_MAX);
135 vtkGetMacro(RulerDistance,double);
137
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, int);
172 vtkGetMacro(AdjustLabels, int);
173 vtkBooleanMacro(AdjustLabels, int);
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);
203
205
209 vtkGetObjectMacro(TitleTextProperty,vtkTextProperty);
211
213
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, int);
262 vtkGetMacro(AxisVisibility, int);
263 vtkBooleanMacro(AxisVisibility, int);
265
267
270 vtkSetMacro(TickVisibility, int);
271 vtkGetMacro(TickVisibility, int);
272 vtkBooleanMacro(TickVisibility, int);
274
276
279 vtkSetMacro(LabelVisibility, int);
280 vtkGetMacro(LabelVisibility, int);
281 vtkBooleanMacro(LabelVisibility, int);
283
285
288 vtkSetMacro(TitleVisibility, int);
289 vtkGetMacro(TitleVisibility, int);
290 vtkBooleanMacro(TitleVisibility, int);
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
329
334
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,int);
379 vtkGetMacro(SizeFontRelativeToAxis,int);
380 vtkBooleanMacro(SizeFontRelativeToAxis,int);
382
386 void ShallowCopy(vtkProp *prop);
387
388protected:
391
394
395 char *Title;
396 double Range[2];
409
410 double AdjustedRange[2];
413
418
419 int LastPosition[2];
420 int LastPosition2[2];
421
422 int LastSize[2];
423 int LastMaxLabelSize[2];
424
426
427 virtual void BuildAxis(vtkViewport *viewport);
428 static double ComputeStringOffset(double width, double height, double theta);
429 static void SetOffsetPosition(double xTick[3], double theta,
430 int stringHeight, int stringWidth,
431 int offset, vtkActor2D *actor);
432 virtual void UpdateAdjustedRange();
433
436
439
443
446
447private:
448 vtkAxisActor2D(const vtkAxisActor2D&) VTK_DELETE_FUNCTION;
449 void operator=(const vtkAxisActor2D&) VTK_DELETE_FUNCTION;
450};
451
452
453#endif
a actor that draws 2D data
Definition: vtkActor2D.h:46
virtual vtkCoordinate * GetPositionCoordinate()
Get the PositionCoordinate instance of vtkCoordinate.
virtual void SetPosition2(float x[2])
virtual void SetPosition(float x[2])
virtual vtkCoordinate * GetPosition2Coordinate()
Access the Position2 instance variable.
virtual float * GetPosition2()
virtual float * GetPosition()
Create an axis with tick marks and labels.
int RenderOpaqueGeometry(vtkViewport *viewport)
WARNING: INTERNAL METHOD - NOT INTENDED FOR GENERAL USE DO NOT USE THESE METHODS OUTSIDE OF THE RENDE...
virtual void SetPoint1(double x[2])
virtual double * GetAdjustedRange()
vtkTimeStamp BuildTime
vtkPolyDataMapper2D * AxisMapper
void ShallowCopy(vtkProp *prop)
Shallow copy of an axis actor.
vtkTextMapper * TitleMapper
virtual void SetTitleTextProperty(vtkTextProperty *p)
Set/Get the title text property.
vtkActor2D ** LabelActors
vtkActor2D * AxisActor
virtual void BuildAxis(vtkViewport *viewport)
static int SetMultipleFontSize(vtkViewport *viewport, vtkTextMapper **textMappers, int nbOfMappers, int *targetSize, double factor, int *stringSize)
General method to computes font size from a representative size on the viewport (given by size[2]).
vtkTextProperty * TitleTextProperty
virtual void SetPoint1(double x, double y)
static void ComputeRange(double inRange[2], double outRange[2], int inNumTicks, int &outNumTicks, double &interval)
This method computes the range of the axis given an input range.
virtual vtkCoordinate * GetPoint2Coordinate()
Specify the position of the second point defining the axis.
vtkPolyData * Axis
virtual int HasTranslucentPolygonalGeometry()
Does this prop have some translucent polygonal geometry?
int RenderOverlay(vtkViewport *viewport)
Draw the axis.
virtual vtkCoordinate * GetPoint1Coordinate()
Specify the position of the first point defining the axis.
vtkTimeStamp AdjustedRangeBuildTime
virtual void GetAdjustedRange(double _arg[2])
vtkTextMapper ** LabelMappers
static vtkAxisActor2D * New()
Instantiate object.
static double ComputeStringOffset(double width, double height, double theta)
void PrintSelf(ostream &os, vtkIndent indent)
Methods invoked by print to print information about the object including superclasses.
virtual double * GetPoint1()
virtual void SetPoint2(double x[2])
virtual void SetLabelTextProperty(vtkTextProperty *p)
Set/Get the labels text property.
static void SetOffsetPosition(double xTick[3], double theta, int stringHeight, int stringWidth, int offset, vtkActor2D *actor)
virtual double * GetPoint2()
void ReleaseGraphicsResources(vtkWindow *)
Release any graphics resources that are being consumed by this actor.
vtkTextProperty * LabelTextProperty
virtual int GetAdjustedNumberOfLabels()
virtual void GetAdjustedRange(double &_arg1, double &_arg2)
virtual void SetPoint2(double x, double y)
virtual int RenderTranslucentPolygonalGeometry(vtkViewport *)
vtkActor2D * TitleActor
virtual void UpdateAdjustedRange()
perform coordinate transformation, and represent position, in a variety of vtk coordinate systems
Definition: vtkCoordinate.h:71
a simple class to control print indentation
Definition: vtkIndent.h:40
draw vtkPolyData onto the image plane
concrete dataset represents vertices, lines, polygons, and triangle strips
Definition: vtkPolyData.h:86
abstract superclass for all actors, volumes and annotations
Definition: vtkProp.h:48
2D text annotation
Definition: vtkTextMapper.h:54
represent text properties.
record modification and/or execution time
Definition: vtkTimeStamp.h:36
abstract specification for Viewports
Definition: vtkViewport.h:48
window superclass for vtkRenderWindow
Definition: vtkWindow.h:35
@ height
Definition: vtkX3D.h:254
@ offset
Definition: vtkX3D.h:438
vtkSetMacro(IgnoreDriverBugs, bool)
Updates the extensions string.
vtkBooleanMacro(IgnoreDriverBugs, bool)
Updates the extensions string.
vtkGetStringMacro(ExtensionsString)
Returns a string listing all available extensions.
#define VTK_FLOAT_MAX
Definition: vtkType.h:161