VTK
9.0.20210122
|
a virtual camera for 3D rendering More...
#include <vtkCamera.h>
Public Types | |
typedef vtkObject | Superclass |
Public Member Functions | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
vtkCamera * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
void | SetPosition (double x, double y, double z) |
Set/Get the position of the camera in world coordinates. More... | |
void | SetPosition (const double a[3]) |
virtual double * | GetPosition () |
virtual void | GetPosition (double &, double &, double &) |
virtual void | GetPosition (double[3]) |
void | SetFocalPoint (double x, double y, double z) |
Set/Get the focal of the camera in world coordinates. More... | |
void | SetFocalPoint (const double a[3]) |
virtual double * | GetFocalPoint () |
virtual void | GetFocalPoint (double &, double &, double &) |
virtual void | GetFocalPoint (double[3]) |
void | SetViewUp (double vx, double vy, double vz) |
Set/Get the view up direction for the camera. More... | |
void | SetViewUp (const double a[3]) |
virtual double * | GetViewUp () |
virtual void | GetViewUp (double &, double &, double &) |
virtual void | GetViewUp (double[3]) |
void | OrthogonalizeViewUp () |
Recompute the ViewUp vector to force it to be perpendicular to camera->focalpoint vector. More... | |
void | SetDistance (double) |
Move the focal point so that it is the specified distance from the camera position. More... | |
virtual double | GetDistance () |
Return the distance from the camera position to the focal point. More... | |
virtual double * | GetDirectionOfProjection () |
Get the vector in the direction from the camera position to the focal point. More... | |
virtual void | GetDirectionOfProjection (double &, double &, double &) |
virtual void | GetDirectionOfProjection (double[3]) |
void | Dolly (double value) |
Divide the camera's distance from the focal point by the given dolly value. More... | |
void | SetRoll (double angle) |
Set the roll angle of the camera about the direction of projection. More... | |
double | GetRoll () |
void | Roll (double angle) |
Rotate the camera about the direction of projection. More... | |
void | Azimuth (double angle) |
Rotate the camera about the view up vector centered at the focal point. More... | |
void | Yaw (double angle) |
Rotate the focal point about the view up vector, using the camera's position as the center of rotation. More... | |
void | Elevation (double angle) |
Rotate the camera about the cross product of the negative of the direction of projection and the view up vector, using the focal point as the center of rotation. More... | |
void | Pitch (double angle) |
Rotate the focal point about the cross product of the view up vector and the direction of projection, using the camera's position as the center of rotation. More... | |
void | SetParallelProjection (vtkTypeBool flag) |
Set/Get the value of the ParallelProjection instance variable. More... | |
virtual vtkTypeBool | GetParallelProjection () |
virtual void | ParallelProjectionOn () |
virtual void | ParallelProjectionOff () |
void | SetUseHorizontalViewAngle (vtkTypeBool flag) |
Set/Get the value of the UseHorizontalViewAngle instance variable. More... | |
virtual vtkTypeBool | GetUseHorizontalViewAngle () |
virtual void | UseHorizontalViewAngleOn () |
virtual void | UseHorizontalViewAngleOff () |
void | SetViewAngle (double angle) |
Set/Get the camera view angle, which is the angular height of the camera view measured in degrees. More... | |
virtual double | GetViewAngle () |
void | SetParallelScale (double scale) |
Set/Get the scaling used for a parallel projection, i.e. More... | |
virtual double | GetParallelScale () |
void | Zoom (double factor) |
In perspective mode, decrease the view angle by the specified factor. More... | |
void | SetClippingRange (double dNear, double dFar) |
Set/Get the location of the near and far clipping planes along the direction of projection. More... | |
void | SetClippingRange (const double a[2]) |
virtual double * | GetClippingRange () |
virtual void | GetClippingRange (double &, double &) |
virtual void | GetClippingRange (double[2]) |
void | SetThickness (double) |
Set the distance between clipping planes. More... | |
virtual double | GetThickness () |
void | SetWindowCenter (double x, double y) |
Set/Get the center of the window in viewport coordinates. More... | |
virtual double * | GetWindowCenter () |
virtual void | GetWindowCenter (double &, double &) |
virtual void | GetWindowCenter (double[2]) |
void | SetObliqueAngles (double alpha, double beta) |
Get/Set the oblique viewing angles. More... | |
void | ApplyTransform (vtkTransform *t) |
Apply a transform to the camera. More... | |
virtual double * | GetViewPlaneNormal () |
Get the ViewPlaneNormal. More... | |
virtual void | GetViewPlaneNormal (double &, double &, double &) |
virtual void | GetViewPlaneNormal (double[3]) |
void | SetViewShear (double dxdz, double dydz, double center) |
Set/get the shear transform of the viewing frustum. More... | |
void | SetViewShear (double d[3]) |
virtual double * | GetViewShear () |
virtual void | GetViewShear (double &, double &, double &) |
virtual void | GetViewShear (double[3]) |
virtual void | SetEyeAngle (double) |
Set/Get the separation between eyes (in degrees). More... | |
virtual double | GetEyeAngle () |
virtual void | SetFocalDisk (double) |
Set the size of the cameras lens in world coordinates. More... | |
virtual double | GetFocalDisk () |
virtual void | SetFocalDistance (double) |
Sets the distance at which rendering is in focus. More... | |
virtual double | GetFocalDistance () |
virtual void | SetUseOffAxisProjection (vtkTypeBool) |
Set/Get use offaxis frustum. More... | |
virtual vtkTypeBool | GetUseOffAxisProjection () |
virtual void | UseOffAxisProjectionOn () |
virtual void | UseOffAxisProjectionOff () |
virtual void | SetScreenBottomLeft (double, double, double) |
Set/Get top left corner point of the screen. More... | |
virtual void | SetScreenBottomLeft (double[3]) |
virtual double * | GetScreenBottomLeft () |
virtual void | GetScreenBottomLeft (double &, double &, double &) |
virtual void | GetScreenBottomLeft (double[3]) |
virtual void | SetScreenBottomRight (double, double, double) |
Set/Get bottom left corner point of the screen. More... | |
virtual void | SetScreenBottomRight (double[3]) |
virtual double * | GetScreenBottomRight () |
virtual void | GetScreenBottomRight (double &, double &, double &) |
virtual void | GetScreenBottomRight (double[3]) |
virtual void | SetScreenTopRight (double, double, double) |
Set/Get top right corner point of the screen. More... | |
virtual void | SetScreenTopRight (double[3]) |
virtual double * | GetScreenTopRight () |
virtual void | GetScreenTopRight (double &, double &, double &) |
virtual void | GetScreenTopRight (double[3]) |
virtual void | SetEyeSeparation (double) |
Set/Get distance between the eyes. More... | |
virtual double | GetEyeSeparation () |
void | SetEyePosition (double eyePosition[3]) |
Set/Get the eye position (center point between two eyes). More... | |
void | GetEyePosition (double eyePosition[3]) |
void | GetEyePlaneNormal (double normal[3]) |
Get normal vector from eye to screen rotated by EyeTransformMatrix. More... | |
void | SetEyeTransformMatrix (vtkMatrix4x4 *matrix) |
Set/Get eye transformation matrix. More... | |
virtual vtkMatrix4x4 * | GetEyeTransformMatrix () |
void | SetEyeTransformMatrix (const double elements[16]) |
Set the eye transform matrix. More... | |
void | SetModelTransformMatrix (vtkMatrix4x4 *matrix) |
Set/Get model transformation matrix. More... | |
virtual vtkMatrix4x4 * | GetModelTransformMatrix () |
void | SetModelTransformMatrix (const double elements[16]) |
Set model transformation matrix. More... | |
virtual vtkMatrix4x4 * | GetModelViewTransformMatrix () |
Return the model view matrix of model view transform. More... | |
virtual vtkTransform * | GetModelViewTransformObject () |
Return the model view transform. More... | |
virtual vtkMatrix4x4 * | GetViewTransformMatrix () |
For backward compatibility. More... | |
virtual vtkTransform * | GetViewTransformObject () |
For backward compatibility. More... | |
virtual vtkMatrix4x4 * | GetProjectionTransformMatrix (double aspect, double nearz, double farz) |
Return the projection transform matrix, which converts from camera coordinates to viewport coordinates. More... | |
virtual vtkPerspectiveTransform * | GetProjectionTransformObject (double aspect, double nearz, double farz) |
Return the projection transform matrix, which converts from camera coordinates to viewport coordinates. More... | |
virtual vtkMatrix4x4 * | GetCompositeProjectionTransformMatrix (double aspect, double nearz, double farz) |
Return the concatenation of the ViewTransform and the ProjectionTransform. More... | |
virtual vtkMatrix4x4 * | GetProjectionTransformMatrix (vtkRenderer *ren) |
Return the projection transform matrix, which converts from camera coordinates to viewport coordinates. More... | |
void | SetUserViewTransform (vtkHomogeneousTransform *transform) |
In addition to the instance variables such as position and orientation, you can add an additional transformation for your own use. More... | |
virtual vtkHomogeneousTransform * | GetUserViewTransform () |
void | SetUserTransform (vtkHomogeneousTransform *transform) |
In addition to the instance variables such as position and orientation, you can add an additional transformation for your own use. More... | |
virtual vtkHomogeneousTransform * | GetUserTransform () |
virtual void | Render (vtkRenderer *) |
This method causes the camera to set up whatever is required for viewing the scene. More... | |
vtkMTimeType | GetViewingRaysMTime () |
Return the MTime that concerns recomputing the view rays of the camera. More... | |
void | ViewingRaysModified () |
Mark that something has changed which requires the view rays to be recomputed. More... | |
virtual void | GetFrustumPlanes (double aspect, double planes[24]) |
Get the plane equations that bound the view frustum. More... | |
virtual void | UpdateIdealShiftScale (double aspect) |
The following methods are used to support view dependent methods for normalizing data (typically point coordinates). More... | |
virtual double * | GetFocalPointShift () |
virtual void | GetFocalPointShift (double &, double &, double &) |
virtual void | GetFocalPointShift (double[3]) |
virtual double | GetFocalPointScale () |
virtual double * | GetNearPlaneShift () |
virtual void | GetNearPlaneShift (double &, double &, double &) |
virtual void | GetNearPlaneShift (double[3]) |
virtual double | GetNearPlaneScale () |
virtual void | SetShiftScaleThreshold (double) |
virtual double | GetShiftScaleThreshold () |
double * | GetOrientation () |
Get the orientation of the camera. More... | |
double * | GetOrientationWXYZ () |
void | ComputeViewPlaneNormal () |
This method is called automatically whenever necessary, it should never be used outside of vtkCamera.cxx. More... | |
vtkMatrix4x4 * | GetCameraLightTransformMatrix () |
Returns a transformation matrix for a coordinate frame attached to the camera, where the camera is located at (0, 0, 1) looking at the focal point at (0, 0, 0), with up being (0, 1, 0). More... | |
virtual void | UpdateViewport (vtkRenderer *vtkNotUsed(ren)) |
Update the viewport. More... | |
virtual int | GetStereo () |
Get the stereo setting. More... | |
virtual void | SetLeftEye (int) |
Set the Left Eye setting. More... | |
virtual int | GetLeftEye () |
void | ShallowCopy (vtkCamera *source) |
Copy the properties of ‘source’ into ‘this’. More... | |
void | DeepCopy (vtkCamera *source) |
Copy the properties of ‘source’ into ‘this’. More... | |
virtual void | SetFreezeFocalPoint (bool) |
Set/Get the value of the FreezeDolly instance variable. More... | |
virtual bool | GetFreezeFocalPoint () |
virtual void | SetUseScissor (bool) |
Enable/Disable the scissor. More... | |
virtual bool | GetUseScissor () |
void | SetScissorRect (vtkRecti scissorRect) |
Set/Get the vtkRect value of the scissor. More... | |
void | GetScissorRect (vtkRecti &scissorRect) |
virtual vtkInformation * | GetInformation () |
Set/Get the information object associated with this camera. More... | |
virtual void | SetInformation (vtkInformation *) |
virtual void | SetExplicitProjectionTransformMatrix (vtkMatrix4x4 *) |
Set/get an explicit 4x4 projection matrix to use, rather than computing one from other state variables. More... | |
virtual vtkMatrix4x4 * | GetExplicitProjectionTransformMatrix () |
Set/get an explicit 4x4 projection matrix to use, rather than computing one from other state variables. More... | |
virtual void | SetUseExplicitProjectionTransformMatrix (bool) |
If true, the ExplicitProjectionTransformMatrix is used for the projection transformation, rather than computing a transform from internal state. More... | |
virtual bool | GetUseExplicitProjectionTransformMatrix () |
If true, the ExplicitProjectionTransformMatrix is used for the projection transformation, rather than computing a transform from internal state. More... | |
virtual void | UseExplicitProjectionTransformMatrixOn () |
If true, the ExplicitProjectionTransformMatrix is used for the projection transformation, rather than computing a transform from internal state. More... | |
virtual void | UseExplicitProjectionTransformMatrixOff () |
If true, the ExplicitProjectionTransformMatrix is used for the projection transformation, rather than computing a transform from internal state. More... | |
virtual void | SetExplicitAspectRatio (double) |
Set/get an explicit aspect to use, rather than computing it from the renderer. More... | |
virtual double | GetExplicitAspectRatio () |
Set/get an explicit aspect to use, rather than computing it from the renderer. More... | |
virtual void | SetUseExplicitAspectRatio (bool) |
If true, the ExplicitAspect is used for the projection transformation, rather than computing it from the renderer. More... | |
virtual bool | GetUseExplicitAspectRatio () |
If true, the ExplicitAspect is used for the projection transformation, rather than computing it from the renderer. More... | |
virtual void | UseExplicitAspectRatioOn () |
If true, the ExplicitAspect is used for the projection transformation, rather than computing it from the renderer. More... | |
virtual void | UseExplicitAspectRatioOff () |
If true, the ExplicitAspect is used for the projection transformation, rather than computing it from the renderer. More... | |
![]() | |
vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
virtual void | DebugOn () |
Turn debugging output on. More... | |
virtual void | DebugOff () |
Turn debugging output off. More... | |
bool | GetDebug () |
Get the value of the debug flag. More... | |
void | SetDebug (bool debugFlag) |
Set the value of the debug flag. More... | |
virtual void | Modified () |
Update the modification time for this object. More... | |
virtual vtkMTimeType | GetMTime () |
Return this object's modified time. More... | |
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
vtkCommand * | GetCommand (unsigned long tag) |
void | RemoveObserver (vtkCommand *) |
void | RemoveObservers (unsigned long event, vtkCommand *) |
void | RemoveObservers (const char *event, vtkCommand *) |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
void | RemoveObserver (unsigned long tag) |
void | RemoveObservers (unsigned long event) |
void | RemoveObservers (const char *event) |
void | RemoveAllObservers () |
vtkTypeBool | HasObserver (unsigned long event) |
vtkTypeBool | HasObserver (const char *event) |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More... | |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
Allow user to set the AbortFlagOn() with the return value of the callback method. More... | |
int | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. More... | |
int | InvokeEvent (const char *event, void *callData) |
int | InvokeEvent (unsigned long event) |
int | InvokeEvent (const char *event) |
![]() | |
const char * | GetClassName () const |
Return the class name as a string. More... | |
virtual vtkIdType | GetNumberOfGenerationsFromBase (const char *name) |
Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More... | |
virtual void | Delete () |
Delete a VTK object. More... | |
virtual void | FastDelete () |
Delete a reference to this object. More... | |
void | InitializeObjectBase () |
void | Print (ostream &os) |
Print an object to an ostream. More... | |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
virtual void | Register (vtkObjectBase *o) |
Increase the reference count (mark as used by another object). More... | |
virtual void | UnRegister (vtkObjectBase *o) |
Decrease the reference count (release by another object). More... | |
int | GetReferenceCount () |
Return the current reference count of this object. More... | |
void | SetReferenceCount (int) |
Sets the reference count. More... | |
bool | GetIsInMemkind () const |
A local state flag that remembers whether this object lives in the normal or extended memory space. More... | |
Static Public Member Functions | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkCamera * | SafeDownCast (vtkObjectBase *o) |
static vtkCamera * | New () |
Construct camera instance with its focal point at the origin, and position=(0,0,1). More... | |
![]() | |
static vtkObject * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
static void | BreakOnError () |
This method is called when vtkErrorMacro executes. More... | |
static void | SetGlobalWarningDisplay (int val) |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
static void | GlobalWarningDisplayOn () |
static void | GlobalWarningDisplayOff () |
static int | GetGlobalWarningDisplay () |
![]() | |
static vtkTypeBool | IsTypeOf (const char *name) |
Return 1 if this class type is the same type of (or a subclass of) the named class. More... | |
static vtkIdType | GetNumberOfGenerationsFromBaseType (const char *name) |
Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More... | |
static vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
static void | SetMemkindDirectory (const char *directoryname) |
The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More... | |
static bool | GetUsingMemkind () |
A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More... | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkCamera () | |
~vtkCamera () override | |
void | ComputeDistance () |
These methods should only be used within vtkCamera.cxx. More... | |
virtual void | ComputeViewTransform () |
virtual void | ComputeProjectionTransform (double aspect, double nearz, double farz) |
These methods should only be used within vtkCamera.cxx. More... | |
void | ComputeCompositeProjectionTransform (double aspect, double nearz, double farz) |
These methods should only be used within vtkCamera.cxx. More... | |
void | ComputeCameraLightTransform () |
void | ComputeWorldToScreenMatrix () |
Given screen screen top, bottom left and top right calculate screen rotation. More... | |
void | ComputeOffAxisProjectionFrustum () |
Compute and use frustum using offaxis method. More... | |
void | ComputeModelViewMatrix () |
Compute model view matrix for the camera. More... | |
void | PartialCopy (vtkCamera *source) |
Copy the ivars. More... | |
![]() | |
vtkObject () | |
~vtkObject () override | |
void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
These methods allow a command to exclusively grab all events. More... | |
void | InternalReleaseFocus () |
![]() | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Friends | |
class | vtkCameraCallbackCommand |
Additional Inherited Members | |
![]() | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
a virtual camera for 3D rendering
vtkCamera is a virtual camera for 3D rendering. It provides methods to position and orient the view point and focal point. Convenience methods for moving about the focal point also are provided. More complex methods allow the manipulation of the computer graphics model including view up vector, clipping planes, and camera perspective.
Definition at line 45 of file vtkCamera.h.
typedef vtkObject vtkCamera::Superclass |
Definition at line 48 of file vtkCamera.h.
|
protected |
|
overrideprotected |
|
static |
|
virtual |
Return 1 if this class is the same type of (or a subclass of) the named class.
Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.
Reimplemented from vtkObjectBase.
Reimplemented in vtkOpenVRCamera, vtkOpenGLCamera, and vtkExternalOpenGLCamera.
|
static |
|
protectedvirtual |
Reimplemented in vtkOpenVRCamera, vtkOpenGLCamera, and vtkExternalOpenGLCamera.
vtkCamera* vtkCamera::NewInstance | ( | ) | const |
|
overridevirtual |
Methods invoked by print to print information about the object including superclasses.
Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.
Reimplemented from vtkObject.
Reimplemented in vtkOpenVRCamera, vtkOpenGLCamera, and vtkExternalOpenGLCamera.
|
static |
Construct camera instance with its focal point at the origin, and position=(0,0,1).
The view up is along the y-axis, view angle is 30 degrees, and the clipping range is (.1,1000).
void vtkCamera::SetPosition | ( | double | x, |
double | y, | ||
double | z | ||
) |
Set/Get the position of the camera in world coordinates.
The default position is (0,0,1).
|
inline |
Definition at line 64 of file vtkCamera.h.
|
virtual |
|
virtual |
|
virtual |
void vtkCamera::SetFocalPoint | ( | double | x, |
double | y, | ||
double | z | ||
) |
Set/Get the focal of the camera in world coordinates.
The default focal point is the origin.
|
inline |
Definition at line 74 of file vtkCamera.h.
|
virtual |
|
virtual |
|
virtual |
void vtkCamera::SetViewUp | ( | double | vx, |
double | vy, | ||
double | vz | ||
) |
Set/Get the view up direction for the camera.
The default is (0,1,0).
|
inline |
Definition at line 84 of file vtkCamera.h.
|
virtual |
|
virtual |
|
virtual |
void vtkCamera::OrthogonalizeViewUp | ( | ) |
Recompute the ViewUp vector to force it to be perpendicular to camera->focalpoint vector.
Unless you are going to use Yaw or Azimuth on the camera, there is no need to do this.
void vtkCamera::SetDistance | ( | double | ) |
Move the focal point so that it is the specified distance from the camera position.
This distance must be positive.
|
virtual |
Return the distance from the camera position to the focal point.
This distance is positive.
|
virtual |
Get the vector in the direction from the camera position to the focal point.
This is usually the opposite of the ViewPlaneNormal, the vector perpendicular to the screen, unless the view is oblique.
|
virtual |
|
virtual |
void vtkCamera::Dolly | ( | double | value | ) |
Divide the camera's distance from the focal point by the given dolly value.
Use a value greater than one to dolly-in toward the focal point, and use a value less than one to dolly-out away from the focal point.
void vtkCamera::SetRoll | ( | double | angle | ) |
Set the roll angle of the camera about the direction of projection.
double vtkCamera::GetRoll | ( | ) |
void vtkCamera::Roll | ( | double | angle | ) |
Rotate the camera about the direction of projection.
This will spin the camera about its axis.
void vtkCamera::Azimuth | ( | double | angle | ) |
Rotate the camera about the view up vector centered at the focal point.
Note that the view up vector is whatever was set via SetViewUp, and is not necessarily perpendicular to the direction of projection. The result is a horizontal rotation of the camera.
void vtkCamera::Yaw | ( | double | angle | ) |
Rotate the focal point about the view up vector, using the camera's position as the center of rotation.
Note that the view up vector is whatever was set via SetViewUp, and is not necessarily perpendicular to the direction of projection. The result is a horizontal rotation of the scene.
void vtkCamera::Elevation | ( | double | angle | ) |
Rotate the camera about the cross product of the negative of the direction of projection and the view up vector, using the focal point as the center of rotation.
The result is a vertical rotation of the scene.
void vtkCamera::Pitch | ( | double | angle | ) |
Rotate the focal point about the cross product of the view up vector and the direction of projection, using the camera's position as the center of rotation.
The result is a vertical rotation of the camera.
void vtkCamera::SetParallelProjection | ( | vtkTypeBool | flag | ) |
Set/Get the value of the ParallelProjection instance variable.
This determines if the camera should do a perspective or parallel projection.
|
virtual |
|
virtual |
|
virtual |
void vtkCamera::SetUseHorizontalViewAngle | ( | vtkTypeBool | flag | ) |
Set/Get the value of the UseHorizontalViewAngle instance variable.
If set, the camera's view angle represents a horizontal view angle, rather than the default vertical view angle. This is useful if the application uses a display device which whose specs indicate a particular horizontal view angle, or if the application varies the window height but wants to keep the perspective transform unchanges.
|
virtual |
|
virtual |
|
virtual |
void vtkCamera::SetViewAngle | ( | double | angle | ) |
Set/Get the camera view angle, which is the angular height of the camera view measured in degrees.
The default angle is 30 degrees. This method has no effect in parallel projection mode. The formula for setting the angle up for perfect perspective viewing is: angle = 2*atan((h/2)/d) where h is the height of the RenderWindow (measured by holding a ruler up to your screen) and d is the distance from your eyes to the screen.
|
virtual |
void vtkCamera::SetParallelScale | ( | double | scale | ) |
Set/Get the scaling used for a parallel projection, i.e.
the height of the viewport in world-coordinate distances. The default is 1. Note that the "scale" parameter works as an "inverse scale" — larger numbers produce smaller images. This method has no effect in perspective projection mode.
|
virtual |
void vtkCamera::Zoom | ( | double | factor | ) |
In perspective mode, decrease the view angle by the specified factor.
In parallel mode, decrease the parallel scale by the specified factor. A value greater than 1 is a zoom-in, a value less than 1 is a zoom-out.
void vtkCamera::SetClippingRange | ( | double | dNear, |
double | dFar | ||
) |
Set/Get the location of the near and far clipping planes along the direction of projection.
Both of these values must be positive. How the clipping planes are set can have a large impact on how well z-buffering works. In particular the front clipping plane can make a very big difference. Setting it to 0.01 when it really could be 1.0 can have a big impact on your z-buffer resolution farther away. The default clipping range is (0.1,1000). Clipping distance is measured in world coordinate unless a scale factor exists in camera's ModelTransformMatrix.
|
inline |
Definition at line 254 of file vtkCamera.h.
|
virtual |
|
virtual |
|
virtual |
void vtkCamera::SetThickness | ( | double | ) |
Set the distance between clipping planes.
This method adjusts the far clipping plane to be set a distance 'thickness' beyond the near clipping plane.
|
virtual |
void vtkCamera::SetWindowCenter | ( | double | x, |
double | y | ||
) |
Set/Get the center of the window in viewport coordinates.
The viewport coordinate range is ([-1,+1],[-1,+1]). This method is for if you have one window which consists of several viewports, or if you have several screens which you want to act together as one large screen.
|
virtual |
|
virtual |
|
virtual |
void vtkCamera::SetObliqueAngles | ( | double | alpha, |
double | beta | ||
) |
Get/Set the oblique viewing angles.
The first angle, alpha, is the angle (measured from the horizontal) that rays along the direction of projection will follow once projected onto the 2D screen. The second angle, beta, is the angle between the view plane and the direction of projection. This creates a shear transform x' = x + dz*cos(alpha)/tan(beta), y' = dz*sin(alpha)/tan(beta) where dz is the distance of the point from the focal plane. The angles are (45,90) by default. Oblique projections commonly use (30,63.435).
void vtkCamera::ApplyTransform | ( | vtkTransform * | t | ) |
Apply a transform to the camera.
The camera position, focal-point, and view-up are re-calculated using the transform's matrix to multiply the old points by the new transform.
|
virtual |
Get the ViewPlaneNormal.
This vector will point opposite to the direction of projection, unless you have created a sheared output view using SetViewShear/SetObliqueAngles.
|
virtual |
|
virtual |
void vtkCamera::SetViewShear | ( | double | dxdz, |
double | dydz, | ||
double | center | ||
) |
Set/get the shear transform of the viewing frustum.
Parameters are dx/dz, dy/dz, and center. center is a factor that describes where to shear around. The distance dshear from the camera where no shear occurs is given by (dshear = center * FocalDistance).
void vtkCamera::SetViewShear | ( | double | d[3] | ) |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Set/Get the separation between eyes (in degrees).
This is used when generating stereo images.
|
virtual |
|
virtual |
Set the size of the cameras lens in world coordinates.
This is only used when the renderer is doing focal depth rendering. When that is being done the size of the focal disk will effect how significant the depth effects will be.
|
virtual |
|
virtual |
Sets the distance at which rendering is in focus.
This is currently only used by the ray tracing renderers. 0 (default) disables ray traced depth of field. Not to be confused with FocalPoint that is the camera target and is centered on screen. Using a separate focal distance property enables out-of-focus areas anywhere on screen.
|
virtual |
|
virtual |
Set/Get use offaxis frustum.
OffAxis frustum is used for off-axis frustum calculations specifically for stereo rendering. For reference see "High Resolution Virtual Reality", in Proc. SIGGRAPH '92, Computer Graphics, pages 195-202, 1992.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Set/Get top left corner point of the screen.
This will be used only for offaxis frustum calculation. Default is (-1.0, -1.0, -1.0).
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Set/Get bottom left corner point of the screen.
This will be used only for offaxis frustum calculation. Default is (1.0, -1.0, -1.0).
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Set/Get top right corner point of the screen.
This will be used only for offaxis frustum calculation. Default is (1.0, 1.0, -1.0).
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Set/Get distance between the eyes.
This will be used only for offaxis frustum calculation. Default is 0.06.
|
virtual |
void vtkCamera::SetEyePosition | ( | double | eyePosition[3] | ) |
Set/Get the eye position (center point between two eyes).
This is a convenience function that sets the translation component of EyeTransformMatrix. This will be used only for offaxis frustum calculation.
void vtkCamera::GetEyePosition | ( | double | eyePosition[3] | ) |
void vtkCamera::GetEyePlaneNormal | ( | double | normal[3] | ) |
Get normal vector from eye to screen rotated by EyeTransformMatrix.
This will be used only for offaxis frustum calculation.
void vtkCamera::SetEyeTransformMatrix | ( | vtkMatrix4x4 * | matrix | ) |
Set/Get eye transformation matrix.
This is the transformation matrix for the point between eyes. This will be used only for offaxis frustum calculation. Default is identity.
|
virtual |
void vtkCamera::SetEyeTransformMatrix | ( | const double | elements[16] | ) |
Set the eye transform matrix.
This is the transformation matrix for the point between eyes. This will be used only for offaxis frustum calculation. Default is identity.
void vtkCamera::SetModelTransformMatrix | ( | vtkMatrix4x4 * | matrix | ) |
Set/Get model transformation matrix.
This matrix could be used for model related transformations such as scale, shear, rotations and translations.
|
virtual |
void vtkCamera::SetModelTransformMatrix | ( | const double | elements[16] | ) |
Set model transformation matrix.
This matrix could be used for model related transformations such as scale, shear, rotations and translations.
|
virtual |
Return the model view matrix of model view transform.
|
virtual |
Return the model view transform.
|
virtual |
For backward compatibility.
Use GetModelViewTransformMatrix() now. Return the matrix of the view transform. The ViewTransform depends on only three ivars: the Position, the FocalPoint, and the ViewUp vector. All the other methods are there simply for the sake of the users' convenience.
|
virtual |
For backward compatibility.
Use GetModelViewTransformObject() now. Return the view transform. If the camera's ModelTransformMatrix is identity then the ViewTransform depends on only three ivars: the Position, the FocalPoint, and the ViewUp vector. All the other methods are there simply for the sake of the users' convenience.
|
virtual |
Set/get an explicit 4x4 projection matrix to use, rather than computing one from other state variables.
Only used when UseExplicitProjectionTransformMatrix is true.
|
virtual |
Set/get an explicit 4x4 projection matrix to use, rather than computing one from other state variables.
Only used when UseExplicitProjectionTransformMatrix is true.
|
virtual |
If true, the ExplicitProjectionTransformMatrix is used for the projection transformation, rather than computing a transform from internal state.
|
virtual |
If true, the ExplicitProjectionTransformMatrix is used for the projection transformation, rather than computing a transform from internal state.
|
virtual |
If true, the ExplicitProjectionTransformMatrix is used for the projection transformation, rather than computing a transform from internal state.
|
virtual |
If true, the ExplicitProjectionTransformMatrix is used for the projection transformation, rather than computing a transform from internal state.
|
virtual |
Set/get an explicit aspect to use, rather than computing it from the renderer.
Only used when UseExplicitAspect is true.
|
virtual |
Set/get an explicit aspect to use, rather than computing it from the renderer.
Only used when UseExplicitAspect is true.
|
virtual |
If true, the ExplicitAspect is used for the projection transformation, rather than computing it from the renderer.
Default is false.
|
virtual |
If true, the ExplicitAspect is used for the projection transformation, rather than computing it from the renderer.
Default is false.
|
virtual |
If true, the ExplicitAspect is used for the projection transformation, rather than computing it from the renderer.
Default is false.
|
virtual |
If true, the ExplicitAspect is used for the projection transformation, rather than computing it from the renderer.
Default is false.
|
virtual |
Return the projection transform matrix, which converts from camera coordinates to viewport coordinates.
The 'aspect' is the width/height for the viewport, and the nearz and farz are the Z-buffer values that map to the near and far clipping planes. The viewport coordinates of a point located inside the frustum are in the range ([-1,+1],[-1,+1],[nearz,farz]). aspect is ignored if UseExplicitAspectRatio is true.
|
virtual |
Return the projection transform matrix, which converts from camera coordinates to viewport coordinates.
The 'aspect' is the width/height for the viewport, and the nearz and farz are the Z-buffer values that map to the near and far clipping planes. The viewport coordinates of a point located inside the frustum are in the range ([-1,+1],[-1,+1],[nearz,farz]). aspect is ignored if UseExplicitAspectRatio is true.
|
virtual |
Return the concatenation of the ViewTransform and the ProjectionTransform.
This transform will convert world coordinates to viewport coordinates. The 'aspect' is the width/height for the viewport, and the nearz and farz are the Z-buffer values that map to the near and far clipping planes. The viewport coordinates of a point located inside the frustum are in the range ([-1,+1],[-1,+1],[nearz,farz]). aspect is ignored if UseExplicitAspectRatio is true.
|
virtual |
Return the projection transform matrix, which converts from camera coordinates to viewport coordinates.
This method computes the aspect, nearz and farz, then calls the more specific signature of GetCompositeProjectionTransformMatrix
void vtkCamera::SetUserViewTransform | ( | vtkHomogeneousTransform * | transform | ) |
In addition to the instance variables such as position and orientation, you can add an additional transformation for your own use.
This transformation is concatenated to the camera's ViewTransform
|
virtual |
void vtkCamera::SetUserTransform | ( | vtkHomogeneousTransform * | transform | ) |
In addition to the instance variables such as position and orientation, you can add an additional transformation for your own use.
This transformation is concatenated to the camera's ProjectionTransform
|
virtual |
|
inlinevirtual |
This method causes the camera to set up whatever is required for viewing the scene.
This is actually handled by an subclass of vtkCamera, which is created through New()
Reimplemented in vtkOpenGLCamera, and vtkOpenVRCamera.
Definition at line 613 of file vtkCamera.h.
vtkMTimeType vtkCamera::GetViewingRaysMTime | ( | ) |
Return the MTime that concerns recomputing the view rays of the camera.
void vtkCamera::ViewingRaysModified | ( | ) |
Mark that something has changed which requires the view rays to be recomputed.
|
virtual |
Get the plane equations that bound the view frustum.
The plane normals point inward. The planes array contains six plane equations of the form (Ax+By+Cz+D=0), the first four values are (A,B,C,D) which repeats for each of the planes. The planes are given in the following order: -x,+x,-y,+y,-z,+z. Warning: it means left,right,bottom,top,far,near (NOT near,far) The aspect of the viewport is needed to correctly compute the planes. aspect is ignored if UseExplicitAspectRatio is true.
|
virtual |
The following methods are used to support view dependent methods for normalizing data (typically point coordinates).
When dealing with data that can exceed floating point resolution sometimes is it best to normalize that data based on the current camera view such that what is seen will be in the sweet spot for floating point resolution. Input datasets may be double precision but the rendering engine is currently single precision which also can lead to these issues. See vtkOpenGLVertexBufferObject for related information.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
|
virtual |
double* vtkCamera::GetOrientation | ( | ) |
Get the orientation of the camera.
double* vtkCamera::GetOrientationWXYZ | ( | ) |
void vtkCamera::ComputeViewPlaneNormal | ( | ) |
This method is called automatically whenever necessary, it should never be used outside of vtkCamera.cxx.
vtkMatrix4x4* vtkCamera::GetCameraLightTransformMatrix | ( | ) |
Returns a transformation matrix for a coordinate frame attached to the camera, where the camera is located at (0, 0, 1) looking at the focal point at (0, 0, 0), with up being (0, 1, 0).
|
inlinevirtual |
Update the viewport.
Definition at line 682 of file vtkCamera.h.
|
virtual |
Get the stereo setting.
|
virtual |
Set the Left Eye setting.
|
virtual |
void vtkCamera::ShallowCopy | ( | vtkCamera * | source | ) |
Copy the properties of ‘source’ into ‘this’.
Copy pointers of matrices.
void vtkCamera::DeepCopy | ( | vtkCamera * | source | ) |
Copy the properties of ‘source’ into ‘this’.
Copy the contents of the matrices.
|
virtual |
Set/Get the value of the FreezeDolly instance variable.
This determines if the camera should move the focal point with the camera position. HACK!!!
|
virtual |
|
virtual |
Enable/Disable the scissor.
|
virtual |
void vtkCamera::GetScissorRect | ( | vtkRecti & | scissorRect | ) |
|
virtual |
Set/Get the information object associated with this camera.
|
virtual |
|
protected |
These methods should only be used within vtkCamera.cxx.
|
protectedvirtual |
Reimplemented in vtkExternalOpenGLCamera.
|
protectedvirtual |
These methods should only be used within vtkCamera.cxx.
|
protected |
These methods should only be used within vtkCamera.cxx.
|
protected |
|
protected |
Given screen screen top, bottom left and top right calculate screen rotation.
|
protected |
Compute and use frustum using offaxis method.
|
protected |
Compute model view matrix for the camera.
|
protected |
Copy the ivars.
Do nothing for the matrices. Called by ShallowCopy() and DeepCopy()
|
friend |
Definition at line 857 of file vtkCamera.h.
|
protected |
Definition at line 797 of file vtkCamera.h.
|
protected |
Definition at line 798 of file vtkCamera.h.
|
protected |
Definition at line 799 of file vtkCamera.h.
|
protected |
Definition at line 800 of file vtkCamera.h.
|
protected |
Definition at line 801 of file vtkCamera.h.
|
protected |
Definition at line 802 of file vtkCamera.h.
|
protected |
Definition at line 803 of file vtkCamera.h.
|
protected |
Definition at line 804 of file vtkCamera.h.
|
protected |
Definition at line 805 of file vtkCamera.h.
|
protected |
Definition at line 806 of file vtkCamera.h.
|
protected |
Definition at line 807 of file vtkCamera.h.
|
protected |
Definition at line 808 of file vtkCamera.h.
|
protected |
Definition at line 809 of file vtkCamera.h.
|
protected |
Definition at line 810 of file vtkCamera.h.
|
protected |
Definition at line 811 of file vtkCamera.h.
|
protected |
Definition at line 812 of file vtkCamera.h.
|
protected |
Definition at line 813 of file vtkCamera.h.
|
protected |
Definition at line 814 of file vtkCamera.h.
|
protected |
Definition at line 816 of file vtkCamera.h.
|
protected |
Definition at line 818 of file vtkCamera.h.
|
protected |
Definition at line 819 of file vtkCamera.h.
|
protected |
Definition at line 820 of file vtkCamera.h.
|
protected |
Definition at line 822 of file vtkCamera.h.
|
protected |
Definition at line 824 of file vtkCamera.h.
|
protected |
Definition at line 825 of file vtkCamera.h.
|
protected |
Definition at line 827 of file vtkCamera.h.
|
protected |
Definition at line 829 of file vtkCamera.h.
|
protected |
Definition at line 831 of file vtkCamera.h.
|
protected |
Definition at line 832 of file vtkCamera.h.
|
protected |
Definition at line 834 of file vtkCamera.h.
|
protected |
Definition at line 835 of file vtkCamera.h.
|
protected |
Definition at line 837 of file vtkCamera.h.
|
protected |
Definition at line 838 of file vtkCamera.h.
|
protected |
Definition at line 840 of file vtkCamera.h.
|
protected |
Definition at line 841 of file vtkCamera.h.
|
protected |
Definition at line 842 of file vtkCamera.h.
|
protected |
Definition at line 843 of file vtkCamera.h.
|
protected |
Definition at line 845 of file vtkCamera.h.
|
protected |
Definition at line 847 of file vtkCamera.h.
|
protected |
Definition at line 848 of file vtkCamera.h.
|
protected |
Definition at line 850 of file vtkCamera.h.
|
protected |
Definition at line 851 of file vtkCamera.h.
|
protected |
Definition at line 852 of file vtkCamera.h.
|
protected |
Definition at line 853 of file vtkCamera.h.
|
protected |
Definition at line 854 of file vtkCamera.h.
|
protected |
Definition at line 856 of file vtkCamera.h.
|
protected |
Definition at line 862 of file vtkCamera.h.
|
protected |
Definition at line 863 of file vtkCamera.h.
|
protected |
Definition at line 864 of file vtkCamera.h.
|
protected |
Definition at line 866 of file vtkCamera.h.
|
protected |
Definition at line 869 of file vtkCamera.h.