VTK  9.2.5
vtkPerspectiveTransform.h
Go to the documentation of this file.
1/*=========================================================================
2
3 Program: Visualization Toolkit
4 Module: vtkPerspectiveTransform.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=========================================================================*/
15
48#ifndef vtkPerspectiveTransform_h
49#define vtkPerspectiveTransform_h
50
51#include "vtkCommonTransformsModule.h" // For export macro
53
54#include "vtkMatrix4x4.h" // Needed for inline methods
55
56class VTKCOMMONTRANSFORMS_EXPORT vtkPerspectiveTransform : public vtkHomogeneousTransform
57{
58public:
61 void PrintSelf(ostream& os, vtkIndent indent) override;
62
68 void Identity()
69 {
70 this->Concatenation->Identity();
71 this->Modified();
72 }
73
79 void Inverse() override
80 {
81 this->Concatenation->Inverse();
82 this->Modified();
83 }
84
93 void AdjustViewport(double oldXMin, double oldXMax, double oldYMin, double oldYMax,
94 double newXMin, double newXMax, double newYMin, double newYMax);
95
103 void AdjustZBuffer(double oldNearZ, double oldFarZ, double newNearZ, double newFarZ);
104
110 void Ortho(double xmin, double xmax, double ymin, double ymax, double znear, double zfar);
111
118 void Frustum(double xmin, double xmax, double ymin, double ymax, double znear, double zfar);
119
126 void Perspective(double angle, double aspect, double znear, double zfar);
127
141 void Shear(double dxdz, double dydz, double zplane);
142
153 void Stereo(double angle, double focaldistance);
154
160 void SetupCamera(const double position[3], const double focalpoint[3], const double viewup[3]);
161
162 void SetupCamera(double p0, double p1, double p2, double fp0, double fp1, double fp2, double vup0,
163 double vup1, double vup2);
164
166
170 void Translate(double x, double y, double z) { this->Concatenation->Translate(x, y, z); }
171 void Translate(const double x[3]) { this->Translate(x[0], x[1], x[2]); }
172 void Translate(const float x[3]) { this->Translate(x[0], x[1], x[2]); }
174
176
182 void RotateWXYZ(double angle, double x, double y, double z)
183 {
184 this->Concatenation->Rotate(angle, x, y, z);
185 }
186 void RotateWXYZ(double angle, const double axis[3])
187 {
188 this->RotateWXYZ(angle, axis[0], axis[1], axis[2]);
189 }
190 void RotateWXYZ(double angle, const float axis[3])
191 {
192 this->RotateWXYZ(angle, axis[0], axis[1], axis[2]);
193 }
195
197
202 void RotateX(double angle) { this->RotateWXYZ(angle, 1, 0, 0); }
203 void RotateY(double angle) { this->RotateWXYZ(angle, 0, 1, 0); }
204 void RotateZ(double angle) { this->RotateWXYZ(angle, 0, 0, 1); }
206
208
213 void Scale(double x, double y, double z) { this->Concatenation->Scale(x, y, z); }
214 void Scale(const double s[3]) { this->Scale(s[0], s[1], s[2]); }
215 void Scale(const float s[3]) { this->Scale(s[0], s[1], s[2]); }
217
219
223 void SetMatrix(vtkMatrix4x4* matrix) { this->SetMatrix(*matrix->Element); }
224 void SetMatrix(const double elements[16])
225 {
226 this->Identity();
227 this->Concatenate(elements);
228 }
230
232
236 void Concatenate(vtkMatrix4x4* matrix) { this->Concatenate(*matrix->Element); }
237 void Concatenate(const double elements[16]) { this->Concatenation->Concatenate(elements); }
239
248
257 {
258 if (this->Concatenation->GetPreMultiplyFlag())
259 {
260 return;
261 }
262 this->Concatenation->SetPreMultiplyFlag(1);
263 this->Modified();
264 }
265
274 {
275 if (!this->Concatenation->GetPreMultiplyFlag())
276 {
277 return;
278 }
279 this->Concatenation->SetPreMultiplyFlag(0);
280 this->Modified();
281 }
282
288 {
289 return this->Concatenation->GetNumberOfTransforms() + (this->Input == nullptr ? 0 : 1);
290 }
291
293
301 {
303 if (this->Input == nullptr)
304 {
305 t = this->Concatenation->GetTransform(i);
306 }
307 else if (i < this->Concatenation->GetNumberOfPreTransforms())
308 {
309 t = this->Concatenation->GetTransform(i);
310 }
311 else if (i > this->Concatenation->GetNumberOfPreTransforms())
312 {
313 t = this->Concatenation->GetTransform(i - 1);
314 }
315 else if (this->GetInverseFlag())
316 {
317 t = this->Input->GetInverse();
318 }
319 else
320 {
321 t = this->Input;
322 }
323 return static_cast<vtkHomogeneousTransform*>(t);
324 }
326
328
337 vtkHomogeneousTransform* GetInput() { return this->Input; }
339
347 int GetInverseFlag() { return this->Concatenation->GetInverseFlag(); }
348
350
353 void Push()
354 {
355 if (this->Stack == nullptr)
356 {
358 }
359 this->Stack->Push(&this->Concatenation);
360 this->Modified();
361 }
363
365
369 void Pop()
370 {
371 if (this->Stack == nullptr)
372 {
373 return;
374 }
375 this->Stack->Pop(&this->Concatenation);
376 this->Modified();
377 }
379
385
394 int CircuitCheck(vtkAbstractTransform* transform) override;
395
400
401protected:
404
406 void InternalUpdate() override;
407
411
412private:
414 void operator=(const vtkPerspectiveTransform&) = delete;
415};
416
417#endif
superclass for all geometric transformations
vtkAbstractTransform * GetInverse()
Get the inverse of this transform.
superclass for homogeneous transformations
a simple class to control print indentation
Definition: vtkIndent.h:40
represent and manipulate 4x4 transformation matrices
Definition: vtkMatrix4x4.h:42
double Element[4][4]
The internal data is public for historical reasons. Do not use!
Definition: vtkMatrix4x4.h:45
virtual void Modified()
Update the modification time for this object.
describes a 4x4 matrix transformation
void Perspective(double angle, double aspect, double znear, double zfar)
Create a perspective projection matrix by specifying the view angle (this angle is in the y direction...
vtkMTimeType GetMTime() override
Override GetMTime to account for input and concatenation.
void PreMultiply()
Sets the internal state of the transform to PreMultiply.
int CircuitCheck(vtkAbstractTransform *transform) override
Check for self-reference.
void Scale(const float s[3])
Create a scale matrix (i.e.
void SetInput(vtkHomogeneousTransform *input)
Set the input for this transformation.
static vtkPerspectiveTransform * New()
void Frustum(double xmin, double xmax, double ymin, double ymax, double znear, double zfar)
Create an perspective projection matrix and concatenate it by the current transformation.
void Scale(double x, double y, double z)
Create a scale matrix (i.e.
void SetMatrix(vtkMatrix4x4 *matrix)
Set the current matrix directly.
void RotateWXYZ(double angle, double x, double y, double z)
Create a rotation matrix and concatenate it with the current transformation according to PreMultiply ...
void Concatenate(vtkMatrix4x4 *matrix)
Concatenates the matrix with the current transformation according to PreMultiply or PostMultiply sema...
void Stereo(double angle, double focaldistance)
Create a stereo shear matrix and concatenate it with the current transformation.
void Ortho(double xmin, double xmax, double ymin, double ymax, double znear, double zfar)
Create an orthogonal projection matrix and concatenate it by the current transformation.
void Translate(const float x[3])
Create a translation matrix and concatenate it with the current transformation according to PreMultip...
void PostMultiply()
Sets the internal state of the transform to PostMultiply.
void RotateZ(double angle)
Create a rotation matrix about the X, Y, or Z axis and concatenate it with the current transformation...
vtkTransformConcatenationStack * Stack
int GetNumberOfConcatenatedTransforms()
Get the total number of transformations that are linked into this one via Concatenate() operations or...
void Identity()
Set this transformation to the identity transformation.
void Pop()
Deletes the transformation on the top of the stack and sets the top to the next transformation on the...
void Translate(double x, double y, double z)
Create a translation matrix and concatenate it with the current transformation according to PreMultip...
void Inverse() override
Invert the transformation.
void RotateX(double angle)
Create a rotation matrix about the X, Y, or Z axis and concatenate it with the current transformation...
void RotateY(double angle)
Create a rotation matrix about the X, Y, or Z axis and concatenate it with the current transformation...
void AdjustViewport(double oldXMin, double oldXMax, double oldYMin, double oldYMax, double newXMin, double newXMax, double newYMin, double newYMax)
Perform an adjustment to the viewport coordinates.
void Concatenate(const double elements[16])
Concatenates the matrix with the current transformation according to PreMultiply or PostMultiply sema...
void Scale(const double s[3])
Create a scale matrix (i.e.
vtkHomogeneousTransform * GetInput()
Set the input for this transformation.
void Push()
Pushes the current transformation onto the transformation stack.
vtkAbstractTransform * MakeTransform() override
Make a new transform of the same type – you are responsible for deleting the transform when you are d...
void SetupCamera(double p0, double p1, double p2, double fp0, double fp1, double fp2, double vup0, double vup1, double vup2)
void Translate(const double x[3])
Create a translation matrix and concatenate it with the current transformation according to PreMultip...
void SetupCamera(const double position[3], const double focalpoint[3], const double viewup[3])
Set a view transformation matrix for the camera (this matrix does not contain any perspective) and co...
void InternalDeepCopy(vtkAbstractTransform *t) override
Perform any subclass-specific DeepCopy.
vtkHomogeneousTransform * GetConcatenatedTransform(int i)
Get one of the concatenated transformations as a vtkAbstractTransform.
~vtkPerspectiveTransform() override
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
int GetInverseFlag()
Get the inverse flag of the transformation.
void RotateWXYZ(double angle, const double axis[3])
Create a rotation matrix and concatenate it with the current transformation according to PreMultiply ...
void Concatenate(vtkHomogeneousTransform *transform)
Concatenate the specified transform with the current transformation according to PreMultiply or PostM...
void Shear(double dxdz, double dydz, double zplane)
Create a shear transformation about a plane at distance z from the camera.
void AdjustZBuffer(double oldNearZ, double oldFarZ, double newNearZ, double newFarZ)
Perform an adjustment to the Z-Buffer range that the near and far clipping planes map to.
void InternalUpdate() override
Perform any subclass-specific Update.
void RotateWXYZ(double angle, const float axis[3])
Create a rotation matrix and concatenate it with the current transformation according to PreMultiply ...
vtkHomogeneousTransform * Input
vtkTransformConcatenation * Concatenation
void SetMatrix(const double elements[16])
Set the current matrix directly.
static vtkTransformConcatenationStack * New()
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:287