VTK
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 =========================================================================*/
65 #ifndef vtkCoordinate_h
66 #define vtkCoordinate_h
67 
68 #include "vtkRenderingCoreModule.h" // For export macro
69 #include "vtkObject.h"
70 class vtkViewport;
71 
72 #define VTK_DISPLAY 0
73 #define VTK_NORMALIZED_DISPLAY 1
74 #define VTK_VIEWPORT 2
75 #define VTK_NORMALIZED_VIEWPORT 3
76 #define VTK_VIEW 4
77 #define VTK_POSE 5
78 #define VTK_WORLD 6
79 #define VTK_USERDEFINED 7
80 
81 class VTKRENDERINGCORE_EXPORT vtkCoordinate : public vtkObject
82 {
83 public:
84  vtkTypeMacro(vtkCoordinate, vtkObject);
85  void PrintSelf(ostream& os, vtkIndent indent) override;
86 
91  static vtkCoordinate* New();
92 
94 
99  vtkSetMacro(CoordinateSystem, int);
100  vtkGetMacro(CoordinateSystem, int);
102  { this->SetCoordinateSystem(VTK_DISPLAY); }
104  { this->SetCoordinateSystem(VTK_NORMALIZED_DISPLAY); }
106  { this->SetCoordinateSystem(VTK_VIEWPORT); }
108  { this->SetCoordinateSystem(VTK_NORMALIZED_VIEWPORT); }
110  { this->SetCoordinateSystem(VTK_VIEW); }
112  { this->SetCoordinateSystem(VTK_POSE); }
114  { this->SetCoordinateSystem(VTK_WORLD); }
116 
118 
120 
124  vtkSetVector3Macro(Value, double);
125  vtkGetVector3Macro(Value, double);
126  void SetValue(double a, double b)
127  { this->SetValue(a, b, 0.0); }
129 
131 
137  vtkGetObjectMacro(ReferenceCoordinate, vtkCoordinate);
139 
141 
148  void SetViewport(vtkViewport *viewport);
149  vtkGetObjectMacro(Viewport, vtkViewport);
151 
153 
161 
164 
172 
181  { return this->Value; }
182 
183 protected:
185  ~vtkCoordinate() override;
186 
187  double Value[3];
191  double ComputedWorldValue[3];
192  int ComputedDisplayValue[2];
193  int ComputedViewportValue[2];
195 
196  double ComputedDoubleDisplayValue[2];
197  double ComputedDoubleViewportValue[2];
198  double ComputedUserDefinedValue[3];
199 
200 private:
201  vtkCoordinate(const vtkCoordinate&) = delete;
202  void operator=(const vtkCoordinate&) = delete;
203 };
204 
205 #endif
vtkCoordinate::New
static vtkCoordinate * New()
Creates an instance of this class with the following defaults: value of (0,0,0) in world coordinates.
vtkCoordinate::SetValue
void SetValue(double a, double b)
Definition: vtkCoordinate.h:126
vtkCoordinate::SetReferenceCoordinate
virtual void SetReferenceCoordinate(vtkCoordinate *)
If this coordinate is relative to another coordinate, then specify that coordinate as the ReferenceCo...
vtkCoordinate::PrintSelf
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
VTK_NORMALIZED_VIEWPORT
#define VTK_NORMALIZED_VIEWPORT
Definition: vtkCoordinate.h:75
vtkCoordinate::SetCoordinateSystemToNormalizedViewport
void SetCoordinateSystemToNormalizedViewport()
Definition: vtkCoordinate.h:107
vtkCoordinate::SetCoordinateSystemToDisplay
void SetCoordinateSystemToDisplay()
Definition: vtkCoordinate.h:101
vtkObject
abstract base class for most VTK objects
Definition: vtkObject.h:60
VTK_POSE
#define VTK_POSE
Definition: vtkCoordinate.h:77
vtkCoordinate::GetCoordinateSystemAsString
const char * GetCoordinateSystemAsString()
vtkCoordinate::ReferenceCoordinate
vtkCoordinate * ReferenceCoordinate
Definition: vtkCoordinate.h:189
vtkCoordinate::GetComputedWorldValue
double * GetComputedWorldValue(vtkViewport *)
Return the computed value in a specified coordinate system.
VTK_VIEW
#define VTK_VIEW
Definition: vtkCoordinate.h:76
vtkCoordinate::SetCoordinateSystemToWorld
void SetCoordinateSystemToWorld()
Definition: vtkCoordinate.h:113
vtkCoordinate::CoordinateSystem
int CoordinateSystem
Definition: vtkCoordinate.h:188
vtkCoordinate::vtkCoordinate
vtkCoordinate()
vtkCoordinate::GetComputedValue
double * GetComputedValue(vtkViewport *)
GetComputedValue() will return either World, Viewport or Display based on what has been set as the co...
VTK_SIZEHINT
#define VTK_SIZEHINT(...)
Definition: vtkWrappingHints.h:42
VTK_VIEWPORT
#define VTK_VIEWPORT
Definition: vtkCoordinate.h:74
vtkCoordinate::GetComputedLocalDisplayValue
int * GetComputedLocalDisplayValue(vtkViewport *)
vtkCoordinate::Computing
int Computing
Definition: vtkCoordinate.h:194
vtkIndent
a simple class to control print indentation
Definition: vtkIndent.h:40
VTK_NORMALIZED_DISPLAY
#define VTK_NORMALIZED_DISPLAY
Definition: vtkCoordinate.h:73
vtkCoordinate::SetCoordinateSystemToViewport
void SetCoordinateSystemToViewport()
Definition: vtkCoordinate.h:105
vtkCoordinate
perform coordinate transformation, and represent position, in a variety of vtk coordinate systems
Definition: vtkCoordinate.h:82
vtkCoordinate::GetComputedUserDefinedValue
virtual double * GetComputedUserDefinedValue(vtkViewport *)
GetComputedUserDefinedValue() is to be used only when the coordinate system is VTK_USERDEFINED.
Definition: vtkCoordinate.h:180
vtkViewport
abstract specification for Viewports
Definition: vtkViewport.h:48
vtkCoordinate::SetViewport
void SetViewport(vtkViewport *viewport)
If you want this coordinate to be relative to a specific vtkViewport (vtkRenderer) then you can speci...
vtkObject.h
vtkCoordinate::SetCoordinateSystemToNormalizedDisplay
void SetCoordinateSystemToNormalizedDisplay()
Definition: vtkCoordinate.h:103
vtkCoordinate::GetComputedDisplayValue
int * GetComputedDisplayValue(vtkViewport *)
vtkCoordinate::GetComputedViewportValue
int * GetComputedViewportValue(vtkViewport *)
vtkCoordinate::~vtkCoordinate
~vtkCoordinate() override
VTK_WORLD
#define VTK_WORLD
Definition: vtkCoordinate.h:78
vtkCoordinate::SetCoordinateSystemToView
void SetCoordinateSystemToView()
Definition: vtkCoordinate.h:109
vtkCoordinate::GetComputedDoubleDisplayValue
double * GetComputedDoubleDisplayValue(vtkViewport *)
vtkCoordinate::GetComputedDoubleViewportValue
double * GetComputedDoubleViewportValue(vtkViewport *)
vtkCoordinate::SetCoordinateSystemToPose
void SetCoordinateSystemToPose()
Definition: vtkCoordinate.h:111
vtkCoordinate::Viewport
vtkViewport * Viewport
Definition: vtkCoordinate.h:190
VTK_DISPLAY
#define VTK_DISPLAY
Definition: vtkCoordinate.h:72