VTK  9.1.0
vtkCoordinate.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkCoordinate.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=========================================================================*/
169#ifndef vtkCoordinate_h
170#define vtkCoordinate_h
171
172#include "vtkObject.h"
173#include "vtkRenderingCoreModule.h" // For export macro
174class vtkViewport;
175
176#define VTK_DISPLAY 0
177#define VTK_NORMALIZED_DISPLAY 1
178#define VTK_VIEWPORT 2
179#define VTK_NORMALIZED_VIEWPORT 3
180#define VTK_VIEW 4
181#define VTK_POSE 5
182#define VTK_WORLD 6
183#define VTK_USERDEFINED 7
184
185class VTKRENDERINGCORE_EXPORT vtkCoordinate : public vtkObject
186{
187public:
188 vtkTypeMacro(vtkCoordinate, vtkObject);
189 void PrintSelf(ostream& os, vtkIndent indent) override;
190
196
198
203 vtkSetMacro(CoordinateSystem, int);
204 vtkGetMacro(CoordinateSystem, int);
205 void SetCoordinateSystemToDisplay() { this->SetCoordinateSystem(VTK_DISPLAY); }
207 {
208 this->SetCoordinateSystem(VTK_NORMALIZED_DISPLAY);
209 }
210 void SetCoordinateSystemToViewport() { this->SetCoordinateSystem(VTK_VIEWPORT); }
212 {
213 this->SetCoordinateSystem(VTK_NORMALIZED_VIEWPORT);
214 }
215 void SetCoordinateSystemToView() { this->SetCoordinateSystem(VTK_VIEW); }
216 void SetCoordinateSystemToPose() { this->SetCoordinateSystem(VTK_POSE); }
217 void SetCoordinateSystemToWorld() { this->SetCoordinateSystem(VTK_WORLD); }
219
221
223
227 vtkSetVector3Macro(Value, double);
228 vtkGetVector3Macro(Value, double);
229 void SetValue(double a, double b) { this->SetValue(a, b, 0.0); }
231
233
239 vtkGetObjectMacro(ReferenceCoordinate, vtkCoordinate);
241
243
250 void SetViewport(vtkViewport* viewport);
251 vtkGetObjectMacro(Viewport, vtkViewport);
253
255
263
266
274
282 virtual double* GetComputedUserDefinedValue(vtkViewport*) VTK_SIZEHINT(3) { return this->Value; }
283
284protected:
286 ~vtkCoordinate() override;
287
288 double Value[3];
292 double ComputedWorldValue[3];
293 int ComputedDisplayValue[2];
294 int ComputedViewportValue[2];
296
297 double ComputedDoubleDisplayValue[2];
298 double ComputedDoubleViewportValue[2];
299 double ComputedUserDefinedValue[3];
300
301private:
302 vtkCoordinate(const vtkCoordinate&) = delete;
303 void operator=(const vtkCoordinate&) = delete;
304};
305
306#endif
perform coordinate transformation, and represent position, in a variety of vtk coordinate systems
double * GetComputedWorldValue(vtkViewport *)
Return the computed value in a specified coordinate system.
virtual double * GetComputedUserDefinedValue(vtkViewport *)
GetComputedUserDefinedValue() is to be used only when the coordinate system is VTK_USERDEFINED.
void SetCoordinateSystemToWorld()
Set/get the coordinate system which this coordinate is defined in.
double * GetComputedDoubleViewportValue(vtkViewport *)
double * GetComputedDoubleDisplayValue(vtkViewport *)
virtual void SetReferenceCoordinate(vtkCoordinate *)
If this coordinate is relative to another coordinate, then specify that coordinate as the ReferenceCo...
static vtkCoordinate * New()
Creates an instance of this class with the following defaults: value of (0,0,0) in world coordinates.
int * GetComputedLocalDisplayValue(vtkViewport *)
Return the computed value in a specified coordinate system.
void SetCoordinateSystemToNormalizedViewport()
Set/get the coordinate system which this coordinate is defined in.
void SetCoordinateSystemToDisplay()
Set/get the coordinate system which this coordinate is defined in.
int * GetComputedViewportValue(vtkViewport *)
Return the computed value in a specified coordinate system.
~vtkCoordinate() override
void SetCoordinateSystemToPose()
Set/get the coordinate system which this coordinate is defined in.
const char * GetCoordinateSystemAsString()
int * GetComputedDisplayValue(vtkViewport *)
Return the computed value in a specified coordinate system.
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
double * GetComputedValue(vtkViewport *)
GetComputedValue() will return either World, Viewport or Display based on what has been set as the co...
vtkCoordinate * ReferenceCoordinate
void SetCoordinateSystemToViewport()
Set/get the coordinate system which this coordinate is defined in.
void SetViewport(vtkViewport *viewport)
If you want this coordinate to be relative to a specific vtkViewport (vtkRenderer) then you can speci...
vtkViewport * Viewport
void SetCoordinateSystemToView()
Set/get the coordinate system which this coordinate is defined in.
void SetCoordinateSystemToNormalizedDisplay()
Set/get the coordinate system which this coordinate is defined in.
void SetValue(double a, double b)
Set/get the value of this coordinate.
a simple class to control print indentation
Definition: vtkIndent.h:113
abstract base class for most VTK objects
Definition: vtkObject.h:82
abstract specification for Viewports
Definition: vtkViewport.h:47
#define VTK_DISPLAY
#define VTK_WORLD
#define VTK_VIEW
#define VTK_NORMALIZED_VIEWPORT
#define VTK_VIEWPORT
#define VTK_POSE
#define VTK_NORMALIZED_DISPLAY
#define VTK_SIZEHINT(...)