1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
|
/*=========================================================================
Program: ParaView
Module: vtkRulerSourceRepresentation.h
Copyright (c) Kitware, Inc.
All rights reserved.
See Copyright.txt or http://www.paraview.org/HTML/Copyright.html for details.
This software is distributed WITHOUT ANY WARRANTY; without even
the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the above copyright notice for more information.
=========================================================================*/
/**
* @class vtkRulerSourceRepresentation
*
* vtkRulerSourceRepresentation is a representation to show a ruler. The input
* is expected to be vtkPolyData with two points.
*/
#ifndef vtkRulerSourceRepresentation_h
#define vtkRulerSourceRepresentation_h
#include "vtkNew.h" //needed for instances of vtkPVCacheKeeper, vtkPolyData
#include "vtkPVClientServerCoreRenderingModule.h" //needed for exports
#include "vtkPVDataRepresentation.h"
class vtkDistanceRepresentation2D;
class vtkPolyData;
class vtkProperty2D;
class vtkPVCacheKeeper;
class vtkTextProperty;
class VTKPVCLIENTSERVERCORERENDERING_EXPORT vtkRulerSourceRepresentation
: public vtkPVDataRepresentation
{
public:
static vtkRulerSourceRepresentation* New();
vtkTypeMacro(vtkRulerSourceRepresentation, vtkPVDataRepresentation);
void PrintSelf(ostream& os, vtkIndent indent) VTK_OVERRIDE;
//@{
/**
* Set the text widget.
*/
void SetDistanceRepresentation(vtkDistanceRepresentation2D*);
vtkGetObjectMacro(DistanceRepresentation, vtkDistanceRepresentation2D);
//@}
/**
* Set the text property for the printed distance.
*/
void SetTextProperty(vtkTextProperty* prop);
/**
* Set the line width for the displayed axis in screen units.
*/
void SetAxisLineWidth(float width);
/**
* Set the color for the displayed axis.
*/
void SetAxisColor(double red, double green, double blue);
virtual void MarkModified() VTK_OVERRIDE;
/**
* Set the visibility.
*/
virtual void SetVisibility(bool) VTK_OVERRIDE;
/**
* Specify the format to use for labelling the distance. Note that an empty
* string results in no label, or a format string without a "%" character
* will not print the distance value.
*/
void SetLabelFormat(char* labelFormat);
//@{
/**
* Enable or disable ruler mode. When enabled, the ticks on the distance
* widget are separated by the amount specified by
* vtkDistanceRepresentation::RulerDistance. Otherwise, the value
* vtkDistanceRepresentation::NumberOfRulerTicks is used to draw the tick
* marks.
*/
void SetRulerMode(int choice);
int GetRulerMode();
//@}
//@{
/**
* Specify the RulerDistance which indicates the spacing of the major ticks
* in the unit space obtained after the Scale is applied (see SetScale()).
* This ivar only has effect when the RulerMode is on.
*/
void SetRulerDistance(double distance);
double GetRulerDistance();
//@}
//@{
/**
* Set scale factor to apply to the ruler graduation scale and the displayed
* distance. Used to transform VTK world space units to a desired unit,
* e.g., inches to centimeters.
*/
void SetScale(double distance);
double GetScale();
//@}
/**
* Specify the number of major ruler ticks. Note: the number of ticks is the
* number between the two handle endpoints. This ivar only has effect
* when the RulerMode is off.
*/
void SetNumberOfRulerTicks(int numberOfRulerTicks);
/**
* vtkAlgorithm::ProcessRequest() equivalent for rendering passes. This is
* typically called by the vtkView to request meta-data from the
* representations or ask them to perform certain tasks e.g.
* PrepareForRendering.
*/
int ProcessViewRequest(vtkInformationRequestKey* request_type, vtkInformation* inInfo,
vtkInformation* outInfo) VTK_OVERRIDE;
protected:
vtkRulerSourceRepresentation();
~vtkRulerSourceRepresentation();
virtual int RequestData(
vtkInformation*, vtkInformationVector**, vtkInformationVector*) VTK_OVERRIDE;
/**
* Fill input port information.
*/
virtual int FillInputPortInformation(int port, vtkInformation* info) VTK_OVERRIDE;
/**
* Adds the representation to the view. This is called from
* vtkView::AddRepresentation(). Subclasses should override this method.
* Returns true if the addition succeeds.
*/
virtual bool AddToView(vtkView* view) VTK_OVERRIDE;
/**
* Removes the representation to the view. This is called from
* vtkView::RemoveRepresentation(). Subclasses should override this method.
* Returns true if the removal succeeds.
*/
virtual bool RemoveFromView(vtkView* view) VTK_OVERRIDE;
/**
* Overridden to check with the vtkPVCacheKeeper to see if the key is cached.
*/
virtual bool IsCached(double cache_key) VTK_OVERRIDE;
vtkDistanceRepresentation2D* DistanceRepresentation;
vtkNew<vtkPVCacheKeeper> CacheKeeper;
vtkNew<vtkPolyData> Clone;
private:
vtkRulerSourceRepresentation(const vtkRulerSourceRepresentation&) VTK_DELETE_FUNCTION;
void operator=(const vtkRulerSourceRepresentation&) VTK_DELETE_FUNCTION;
};
#endif
|
