VTK  9.3.20231209
vtkCamera.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (c) Ken Martin, Will Schroeder, Bill Lorensen
2 // SPDX-License-Identifier: BSD-3-Clause
132 #ifndef vtkCamera_h
133 #define vtkCamera_h
134 
135 #include "vtkObject.h"
136 #include "vtkRect.h" // for ivar
137 #include "vtkRenderingCoreModule.h" // For export macro
138 
139 VTK_ABI_NAMESPACE_BEGIN
141 class vtkInformation;
142 class vtkMatrix4x4;
144 class vtkRenderer;
145 class vtkTransform;
146 class vtkCallbackCommand;
147 class vtkCameraCallbackCommand;
148 
149 class VTKRENDERINGCORE_EXPORT vtkCamera : public vtkObject
150 {
151 public:
152  vtkTypeMacro(vtkCamera, vtkObject);
153  void PrintSelf(ostream& os, vtkIndent indent) override;
154 
160  static vtkCamera* New();
161 
163 
167  void SetPosition(double x, double y, double z);
168  void SetPosition(const double a[3]) { this->SetPosition(a[0], a[1], a[2]); }
169  vtkGetVector3Macro(Position, double);
171 
173 
177  void SetFocalPoint(double x, double y, double z);
178  void SetFocalPoint(const double a[3]) { this->SetFocalPoint(a[0], a[1], a[2]); }
179  vtkGetVector3Macro(FocalPoint, double);
181 
183 
187  void SetViewUp(double vx, double vy, double vz);
188  void SetViewUp(const double a[3]) { this->SetViewUp(a[0], a[1], a[2]); }
189  vtkGetVector3Macro(ViewUp, double);
191 
198 
203  void SetDistance(double);
204 
206 
210  vtkGetMacro(Distance, double);
212 
214 
219  vtkGetVector3Macro(DirectionOfProjection, double);
221 
228  void Dolly(double value);
229 
231 
234  void SetRoll(double angle);
235  double GetRoll();
237 
242  void Roll(double angle);
243 
250  void Azimuth(double angle);
251 
259  void Yaw(double angle);
260 
267  void Elevation(double angle);
268 
274  void Pitch(double angle);
275 
277 
284  vtkGetMacro(ParallelProjection, vtkTypeBool);
285  vtkBooleanMacro(ParallelProjection, vtkTypeBool);
287 
289 
300  vtkGetMacro(UseHorizontalViewAngle, vtkTypeBool);
301  vtkBooleanMacro(UseHorizontalViewAngle, vtkTypeBool);
303 
305 
316  void SetViewAngle(double angle);
317  vtkGetMacro(ViewAngle, double);
319 
321 
330  void SetParallelScale(double scale);
331  vtkGetMacro(ParallelScale, double);
333 
341  void Zoom(double factor);
342 
344 
357  void SetClippingRange(double dNear, double dFar);
358  void SetClippingRange(const double a[2]) { this->SetClippingRange(a[0], a[1]); }
359  vtkGetVector2Macro(ClippingRange, double);
361 
363 
370  void SetThickness(double);
371  vtkGetMacro(Thickness, double);
373 
375 
384  void SetWindowCenter(double x, double y);
385  vtkGetVector2Macro(WindowCenter, double);
387 
401  void SetObliqueAngles(double alpha, double beta);
402 
409 
411 
416  vtkGetVector3Macro(ViewPlaneNormal, double);
418 
420 
428  void SetViewShear(double dxdz, double dydz, double center);
429  void SetViewShear(double d[3]);
430  vtkGetVector3Macro(ViewShear, double);
432 
434 
438  vtkSetMacro(EyeAngle, double);
439  vtkGetMacro(EyeAngle, double);
441 
443 
449  vtkSetMacro(FocalDisk, double);
450  vtkGetMacro(FocalDisk, double);
452 
454 
462  vtkSetMacro(FocalDistance, double);
463  vtkGetMacro(FocalDistance, double);
465 
467 
476  vtkSetMacro(UseOffAxisProjection, vtkTypeBool);
477  vtkGetMacro(UseOffAxisProjection, vtkTypeBool);
478  vtkBooleanMacro(UseOffAxisProjection, vtkTypeBool);
480 
482 
488 
490 
495  vtkSetVector3Macro(ScreenBottomLeft, double);
496  vtkGetVector3Macro(ScreenBottomLeft, double);
498 
500 
505  vtkSetVector3Macro(ScreenBottomRight, double);
506  vtkGetVector3Macro(ScreenBottomRight, double);
508 
510 
515  vtkSetVector3Macro(ScreenTopRight, double);
516  vtkGetVector3Macro(ScreenTopRight, double);
518 
520 
525  vtkSetMacro(EyeSeparation, double);
526  vtkGetMacro(EyeSeparation, double);
528 
530 
536  void SetEyePosition(double eyePosition[3]);
537  void GetEyePosition(double eyePosition[3]);
539 
544  void GetEyePlaneNormal(double normal[3]);
545 
547 
554  void SetEyeTransformMatrix(const double elements[16]);
555  vtkGetObjectMacro(EyeTransformMatrix, vtkMatrix4x4);
557 
559 
565  void SetModelTransformMatrix(const double elements[16]);
566  vtkGetObjectMacro(ModelTransformMatrix, vtkMatrix4x4);
568 
573 
578 
587 
598 
606  vtkGetObjectMacro(ExplicitProjectionTransformMatrix, vtkMatrix4x4);
614  vtkSetMacro(UseExplicitProjectionTransformMatrix, bool);
615  vtkGetMacro(UseExplicitProjectionTransformMatrix, bool);
616  vtkBooleanMacro(UseExplicitProjectionTransformMatrix, bool);
624  vtkSetMacro(ExplicitAspectRatio, double);
625  vtkGetMacro(ExplicitAspectRatio, double);
634  vtkSetMacro(UseExplicitAspectRatio, bool);
635  vtkGetMacro(UseExplicitAspectRatio, bool);
636  vtkBooleanMacro(UseExplicitAspectRatio, bool);
649  virtual vtkMatrix4x4* GetProjectionTransformMatrix(double aspect, double nearz, double farz);
650 
662  double aspect, double nearz, double farz);
663 
676  double aspect, double nearz, double farz);
677 
686 
688 
694  vtkGetObjectMacro(UserViewTransform, vtkHomogeneousTransform);
696 
698 
704  vtkGetObjectMacro(UserTransform, vtkHomogeneousTransform);
706 
712  virtual void Render(vtkRenderer*) {}
713 
718 
724 
735  virtual void GetFrustumPlanes(double aspect, double planes[24]);
736 
738 
748  virtual void UpdateIdealShiftScale(double aspect);
749  vtkGetVector3Macro(FocalPointShift, double);
750  vtkGetMacro(FocalPointScale, double);
751  vtkGetVector3Macro(NearPlaneShift, double);
752  vtkGetMacro(NearPlaneScale, double);
753  vtkSetMacro(ShiftScaleThreshold, double);
754  vtkGetMacro(ShiftScaleThreshold, double);
756 
758 
762  double* GetOrientationWXYZ() VTK_SIZEHINT(4);
764 
769  void ComputeViewPlaneNormal();
770 
776  vtkMatrix4x4* GetCameraLightTransformMatrix();
777 
781  virtual void UpdateViewport(vtkRenderer* vtkNotUsed(ren)) {}
782 
784 
787  vtkGetMacro(Stereo, int);
789 
791 
794  vtkSetMacro(LeftEye, int);
795  vtkGetMacro(LeftEye, int);
797 
805 
813 
815 
820  vtkSetMacro(FreezeFocalPoint, bool);
821  vtkGetMacro(FreezeFocalPoint, bool);
823 
825 
828  vtkSetMacro(UseScissor, bool);
829  vtkGetMacro(UseScissor, bool);
831 
833 
836  void SetScissorRect(vtkRecti scissorRect);
837  void GetScissorRect(vtkRecti& scissorRect);
839 
841 
844  vtkGetObjectMacro(Information, vtkInformation);
847 
848 protected:
850  ~vtkCamera() override;
851 
853 
857  virtual void ComputeViewTransform();
859 
863  virtual void ComputeProjectionTransform(double aspect, double nearz, double farz);
864 
868  void ComputeCompositeProjectionTransform(double aspect, double nearz, double farz);
869 
871 
877 
882 
887 
895 
896  double WindowCenter[2];
897  double ObliqueAngles[2];
898  double FocalPoint[3];
899  double Position[3];
900  double ViewUp[3];
901  double ViewAngle;
902  double ClippingRange[2];
903  double EyeAngle;
906  int Stereo;
907  int LeftEye;
908  double Thickness;
909  double Distance;
910  double DirectionOfProjection[3];
911  double ViewPlaneNormal[3];
912  double ViewShear[3];
914 
916 
917  double ScreenBottomLeft[3];
918  double ScreenBottomRight[3];
919  double ScreenTopRight[3];
920  double ScreenCenter[3];
921 
924 
927 
929 
932 
935 
938 
943 
945 
946  double FocalDisk;
948 
949  double FocalPointShift[3];
951  double NearPlaneShift[3];
954 
955  vtkCameraCallbackCommand* UserViewTransformCallbackCommand;
956  friend class vtkCameraCallbackCommand;
957 
958  // ViewingRaysMtime keeps track of camera modifications which will
959  // change the calculation of viewing rays for the camera before it is
960  // transformed to the camera's location and orientation.
964 
966 
967  // Arbitrary extra information associated with this camera.
969 
970 private:
971  vtkCamera(const vtkCamera&) = delete;
972  void operator=(const vtkCamera&) = delete;
973 };
974 
975 VTK_ABI_NAMESPACE_END
976 #endif
supports function callbacks
a virtual camera for 3D rendering
Definition: vtkCamera.h:150
bool UseExplicitProjectionTransformMatrix
Definition: vtkCamera.h:934
void ComputeOffAxisProjectionFrustum()
Compute and use frustum using offaxis method.
vtkInformation * Information
Definition: vtkCamera.h:968
virtual void SetInformation(vtkInformation *)
Set/Get the information object associated with this camera.
vtkMatrix4x4 * EyeTransformMatrix
Definition: vtkCamera.h:925
void Roll(double angle)
Rotate the camera about the direction of projection.
vtkTypeBool ParallelProjection
Definition: vtkCamera.h:904
void ApplyTransform(vtkTransform *t)
Apply a transform to the camera.
void SetModelTransformMatrix(vtkMatrix4x4 *matrix)
Set/Get model transformation matrix.
double GetRoll()
Set the roll angle of the camera about the direction of projection.
vtkPerspectiveTransform * Transform
Definition: vtkCamera.h:941
void ComputeCameraLightTransform()
void SetViewUp(const double a[3])
Set/Get the view up direction for the camera.
Definition: vtkCamera.h:188
vtkTransform * ViewTransform
Definition: vtkCamera.h:939
double FocalDistance
Definition: vtkCamera.h:947
void SetUserTransform(vtkHomogeneousTransform *transform)
In addition to the instance variables such as position and orientation, you can add an additional tra...
virtual void ComputeViewTransform()
These methods should only be used within vtkCamera.cxx.
double FocalPointScale
Definition: vtkCamera.h:950
bool FreezeFocalPoint
Definition: vtkCamera.h:962
void SetEyePosition(double eyePosition[3])
Set/Get the eye position (center point between two eyes).
void SetPosition(const double a[3])
Set/Get the position of the camera in world coordinates.
Definition: vtkCamera.h:168
virtual vtkMatrix4x4 * GetViewTransformMatrix()
For backward compatibility.
void Yaw(double angle)
Rotate the focal point about the view up vector, using the camera's position as the center of rotatio...
void SetRoll(double angle)
Set the roll angle of the camera about the direction of projection.
void PartialCopy(vtkCamera *source)
Copy the ivars.
void Elevation(double angle)
Rotate the camera about the cross product of the negative of the direction of projection and the view...
double EyeAngle
Definition: vtkCamera.h:903
void Azimuth(double angle)
Rotate the camera about the view up vector centered at the focal point.
vtkHomogeneousTransform * UserTransform
Definition: vtkCamera.h:930
void DeepCopy(vtkCamera *source)
Copy the properties of ‘source’ into ‘this’.
virtual vtkMatrix4x4 * GetProjectionTransformMatrix(double aspect, double nearz, double farz)
Return the projection transform matrix, which converts from camera coordinates to viewport coordinate...
void Pitch(double angle)
Rotate the focal point about the cross product of the view up vector and the direction of projection,...
vtkTypeBool UseOffAxisProjection
Definition: vtkCamera.h:915
vtkMatrix4x4 * ExplicitProjectionTransformMatrix
Definition: vtkCamera.h:933
void SetObliqueAngles(double alpha, double beta)
Get/Set the oblique viewing angles.
double NearPlaneScale
Definition: vtkCamera.h:952
void SetParallelProjection(vtkTypeBool flag)
Set/Get the value of the ParallelProjection instance variable.
void ComputeModelViewMatrix()
Compute model view matrix for the camera.
int LeftEye
Definition: vtkCamera.h:907
double EyeSeparation
Definition: vtkCamera.h:923
virtual void GetFrustumPlanes(double aspect, double planes[24])
Get the plane equations that bound the view frustum.
void Zoom(double factor)
In perspective mode, decrease the view angle by the specified factor.
void SetPosition(double x, double y, double z)
Set/Get the position of the camera in world coordinates.
void SetViewUp(double vx, double vy, double vz)
Set/Get the view up direction for the camera.
vtkMatrix4x4 * ProjectionPlaneOrientationMatrix
Definition: vtkCamera.h:926
double * GetOrientation()
Get the orientation of the camera.
vtkMatrix4x4 * ModelTransformMatrix
Definition: vtkCamera.h:928
void ShallowCopy(vtkCamera *source)
Copy the properties of ‘source’ into ‘this’.
static vtkCamera * New()
Construct camera instance with its focal point at the origin, and position=(0,0,1).
double FocalDisk
Definition: vtkCamera.h:946
double Distance
Definition: vtkCamera.h:909
bool UseExplicitAspectRatio
Definition: vtkCamera.h:937
void SetModelTransformMatrix(const double elements[16])
Set/Get model transformation matrix.
void SetClippingRange(double dNear, double dFar)
Set/Get the location of the near and far clipping planes along the direction of projection.
void SetThickness(double)
Set the distance between clipping planes.
void GetScissorRect(vtkRecti &scissorRect)
Set/Get the vtkRect value of the scissor.
virtual void Render(vtkRenderer *)
This method causes the camera to set up whatever is required for viewing the scene.
Definition: vtkCamera.h:712
void ViewingRaysModified()
Mark that something has changed which requires the view rays to be recomputed.
void SetFocalPoint(const double a[3])
Set/Get the focal of the camera in world coordinates.
Definition: vtkCamera.h:178
void SetEyeTransformMatrix(vtkMatrix4x4 *matrix)
Set/Get eye transformation matrix.
void GetEyePosition(double eyePosition[3])
Set/Get the eye position (center point between two eyes).
void SetDistance(double)
Move the focal point so that it is the specified distance from the camera position.
virtual vtkTransform * GetModelViewTransformObject()
Return the model view transform.
void SetWindowCenter(double x, double y)
Set/Get the center of the window in viewport coordinates.
void SetEyeTransformMatrix(const double elements[16])
Set/Get eye transformation matrix.
double Thickness
Definition: vtkCamera.h:908
void SetScissorRect(vtkRecti scissorRect)
Set/Get the vtkRect value of the scissor.
virtual vtkMatrix4x4 * GetProjectionTransformMatrix(vtkRenderer *ren)
Return the projection transform matrix, which converts from camera coordinates to viewport coordinate...
void ComputeCompositeProjectionTransform(double aspect, double nearz, double farz)
These methods should only be used within vtkCamera.cxx.
vtkRecti ScissorRect
Definition: vtkCamera.h:965
virtual vtkMatrix4x4 * GetModelViewTransformMatrix()
Return the model view matrix of model view transform.
vtkTransform * CameraLightTransform
Definition: vtkCamera.h:942
bool UseScissor
Definition: vtkCamera.h:963
void SetViewAngle(double angle)
Set/Get the camera view angle, which is the angular height of the camera view measured in degrees.
void GetEyePlaneNormal(double normal[3])
Get normal vector from eye to screen rotated by EyeTransformMatrix.
vtkTypeBool UseHorizontalViewAngle
Definition: vtkCamera.h:913
void OrthogonalizeViewUp()
Recompute the ViewUp vector to force it to be perpendicular to camera->focalpoint vector.
void Dolly(double value)
Divide the camera's distance from the focal point by the given dolly value.
virtual void SetExplicitProjectionTransformMatrix(vtkMatrix4x4 *)
Set/get an explicit 4x4 projection matrix to use, rather than computing one from other state variable...
vtkMTimeType GetViewingRaysMTime()
Return the MTime that concerns recomputing the view rays of the camera.
void SetFocalPoint(double x, double y, double z)
Set/Get the focal of the camera in world coordinates.
void SetUseHorizontalViewAngle(vtkTypeBool flag)
Set/Get the value of the UseHorizontalViewAngle instance variable.
int Stereo
Definition: vtkCamera.h:906
virtual vtkMatrix4x4 * GetCompositeProjectionTransformMatrix(double aspect, double nearz, double farz)
Return the concatenation of the ViewTransform and the ProjectionTransform.
~vtkCamera() override
void PrintSelf(ostream &os, vtkIndent indent) override
Methods invoked by print to print information about the object including superclasses.
void SetParallelScale(double scale)
Set/Get the scaling used for a parallel projection, i.e.
double ViewAngle
Definition: vtkCamera.h:901
void SetViewShear(double d[3])
Set/get the shear transform of the viewing frustum.
double ParallelScale
Definition: vtkCamera.h:905
void ComputeScreenOrientationMatrix()
Given screen screen top, bottom left and top right calculate screen orientation.
vtkHomogeneousTransform * UserViewTransform
Definition: vtkCamera.h:931
vtkPerspectiveTransform * ProjectionTransform
Definition: vtkCamera.h:940
vtkCameraCallbackCommand * UserViewTransformCallbackCommand
Definition: vtkCamera.h:955
double ShiftScaleThreshold
Definition: vtkCamera.h:953
virtual void ComputeProjectionTransform(double aspect, double nearz, double farz)
These methods should only be used within vtkCamera.cxx.
void SetUserViewTransform(vtkHomogeneousTransform *transform)
In addition to the instance variables such as position and orientation, you can add an additional tra...
void ComputeDistance()
These methods should only be used within vtkCamera.cxx.
double GetOffAxisClippingAdjustment()
Get adjustment to clipping thickness, computed by camera based on the physical size of the screen and...
virtual vtkTransform * GetViewTransformObject()
For backward compatibility.
void SetViewShear(double dxdz, double dydz, double center)
Set/get the shear transform of the viewing frustum.
virtual void UpdateIdealShiftScale(double aspect)
The following methods are used to support view dependent methods for normalizing data (typically poin...
virtual vtkPerspectiveTransform * GetProjectionTransformObject(double aspect, double nearz, double farz)
Return the projection transform matrix, which converts from camera coordinates to viewport coordinate...
vtkTransform * ModelViewTransform
Definition: vtkCamera.h:944
double OffAxisClippingAdjustment
Definition: vtkCamera.h:922
void SetClippingRange(const double a[2])
Set/Get the location of the near and far clipping planes along the direction of projection.
Definition: vtkCamera.h:358
vtkTimeStamp ViewingRaysMTime
Definition: vtkCamera.h:961
double ExplicitAspectRatio
Definition: vtkCamera.h:936
superclass for homogeneous transformations
a simple class to control print indentation
Definition: vtkIndent.h:108
Store vtkAlgorithm input/output information.
represent and manipulate 4x4 transformation matrices
Definition: vtkMatrix4x4.h:140
abstract base class for most VTK objects
Definition: vtkObject.h:161
describes a 4x4 matrix transformation
abstract specification for renderers
Definition: vtkRenderer.h:171
record modification and/or execution time
Definition: vtkTimeStamp.h:44
describes linear transformations via a 4x4 matrix
Definition: vtkTransform.h:159
@ value
Definition: vtkX3D.h:220
@ scale
Definition: vtkX3D.h:229
@ center
Definition: vtkX3D.h:230
@ alpha
Definition: vtkX3D.h:250
int vtkTypeBool
Definition: vtkABI.h:64
boost::graph_traits< vtkGraph * >::vertex_descriptor source(boost::graph_traits< vtkGraph * >::edge_descriptor e, vtkGraph *)
vtkTypeUInt32 vtkMTimeType
Definition: vtkType.h:270
#define VTK_SIZEHINT(...)