VTK  9.2.6
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
57#ifndef vtkPerspectiveTransform_h
58#define vtkPerspectiveTransform_h
59
60#include "vtkCommonTransformsModule.h" // For export macro
62
63#include "vtkMatrix4x4.h" // Needed for inline methods
64
65class VTKCOMMONTRANSFORMS_EXPORT vtkPerspectiveTransform : public vtkHomogeneousTransform
66{
67public:
70 void PrintSelf(ostream& os, vtkIndent indent) override;
71
77 void Identity()
78 {
79 this->Concatenation->Identity();
80 this->Modified();
81 }
82
88 void Inverse() override
89 {
90 this->Concatenation->Inverse();
91 this->Modified();
92 }
93
102 void AdjustViewport(double oldXMin, double oldXMax, double oldYMin, double oldYMax,
103 double newXMin, double newXMax, double newYMin, double newYMax);
104
112 void AdjustZBuffer(double oldNearZ, double oldFarZ, double newNearZ, double newFarZ);
113
119 void Ortho(double xmin, double xmax, double ymin, double ymax, double znear, double zfar);
120
127 void Frustum(double xmin, double xmax, double ymin, double ymax, double znear, double zfar);
128
135 void Perspective(double angle, double aspect, double znear, double zfar);
136
150 void Shear(double dxdz, double dydz, double zplane);
151
162 void Stereo(double angle, double focaldistance);
163
169 void SetupCamera(const double position[3], const double focalpoint[3], const double viewup[3]);
170
171 void SetupCamera(double p0, double p1, double p2, double fp0, double fp1, double fp2, double vup0,
172 double vup1, double vup2);
173
175
179 void Translate(double x, double y, double z) { this->Concatenation->Translate(x, y, z); }
180 void Translate(const double x[3]) { this->Translate(x[0], x[1], x[2]); }
181 void Translate(const float x[3]) { this->Translate(x[0], x[1], x[2]); }
183
185
191 void RotateWXYZ(double angle, double x, double y, double z)
192 {
193 this->Concatenation->Rotate(angle, x, y, z);
194 }
195 void RotateWXYZ(double angle, const double axis[3])
196 {
197 this->RotateWXYZ(angle, axis[0], axis[1], axis[2]);
198 }
199 void RotateWXYZ(double angle, const float axis[3])
200 {
201 this->RotateWXYZ(angle, axis[0], axis[1], axis[2]);
202 }
204
206
211 void RotateX(double angle) { this->RotateWXYZ(angle, 1, 0, 0); }
212 void RotateY(double angle) { this->RotateWXYZ(angle, 0, 1, 0); }
213 void RotateZ(double angle) { this->RotateWXYZ(angle, 0, 0, 1); }
215
217
222 void Scale(double x, double y, double z) { this->Concatenation->Scale(x, y, z); }
223 void Scale(const double s[3]) { this->Scale(s[0], s[1], s[2]); }
224 void Scale(const float s[3]) { this->Scale(s[0], s[1], s[2]); }
226
228
232 void SetMatrix(vtkMatrix4x4* matrix) { this->SetMatrix(*matrix->Element); }
233 void SetMatrix(const double elements[16])
234 {
235 this->Identity();
236 this->Concatenate(elements);
237 }
239
241
245 void Concatenate(vtkMatrix4x4* matrix) { this->Concatenate(*matrix->Element); }
246 void Concatenate(const double elements[16]) { this->Concatenation->Concatenate(elements); }
248
257
266 {
267 if (this->Concatenation->GetPreMultiplyFlag())
268 {
269 return;
270 }
271 this->Concatenation->SetPreMultiplyFlag(1);
272 this->Modified();
273 }
274
283 {
284 if (!this->Concatenation->GetPreMultiplyFlag())
285 {
286 return;
287 }
288 this->Concatenation->SetPreMultiplyFlag(0);
289 this->Modified();
290 }
291
297 {
298 return this->Concatenation->GetNumberOfTransforms() + (this->Input == nullptr ? 0 : 1);
299 }
300
302
310 {
312 if (this->Input == nullptr)
313 {
314 t = this->Concatenation->GetTransform(i);
315 }
316 else if (i < this->Concatenation->GetNumberOfPreTransforms())
317 {
318 t = this->Concatenation->GetTransform(i);
319 }
320 else if (i > this->Concatenation->GetNumberOfPreTransforms())
321 {
322 t = this->Concatenation->GetTransform(i - 1);
323 }
324 else if (this->GetInverseFlag())
325 {
326 t = this->Input->GetInverse();
327 }
328 else
329 {
330 t = this->Input;
331 }
332 return static_cast<vtkHomogeneousTransform*>(t);
333 }
335
337
346 vtkHomogeneousTransform* GetInput() { return this->Input; }
348
356 int GetInverseFlag() { return this->Concatenation->GetInverseFlag(); }
357
359
362 void Push()
363 {
364 if (this->Stack == nullptr)
365 {
367 }
368 this->Stack->Push(&this->Concatenation);
369 this->Modified();
370 }
372
374
378 void Pop()
379 {
380 if (this->Stack == nullptr)
381 {
382 return;
383 }
384 this->Stack->Pop(&this->Concatenation);
385 this->Modified();
386 }
388
394
403 int CircuitCheck(vtkAbstractTransform* transform) override;
404
409
410protected:
413
415 void InternalUpdate() override;
416
420
421private:
423 void operator=(const vtkPerspectiveTransform&) = delete;
424};
425
426#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:49
represent and manipulate 4x4 transformation matrices
double Element[4][4]
The internal data is public for historical reasons. Do not use!
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