VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
vtkCamera Class Reference

a virtual camera for 3D rendering More...

#include <vtkCamera.h>

Inheritance diagram for vtkCamera:
[legend]
Collaboration diagram for vtkCamera:
[legend]

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...
 
vtkCameraNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
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...
 
void Dolly (double value)
 Divide the camera's distance from the focal point by the given dolly value. More...
 
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 Zoom (double factor)
 In perspective mode, decrease the view angle by the specified factor. More...
 
void SetObliqueAngles (double alpha, double beta)
 Get/Set the oblique viewing angles. More...
 
void ApplyTransform (vtkTransform *t)
 Apply a transform to the camera. More...
 
void GetEyePlaneNormal (double normal[3])
 Get normal vector from eye to screen rotated by EyeTransformMatrix. More...
 
void SetEyeTransformMatrix (const double elements[16])
 Set the eye transform matrix. More...
 
void SetModelTransformMatrix (const double elements[16])
 Set model transformation matrix. More...
 
virtual vtkMatrix4x4GetModelViewTransformMatrix ()
 Return the model view matrix of model view transform. More...
 
virtual vtkTransformGetModelViewTransformObject ()
 Return the model view transform. More...
 
virtual vtkMatrix4x4GetViewTransformMatrix ()
 For backward compatibility. More...
 
virtual vtkTransformGetViewTransformObject ()
 For backward compatibility. More...
 
virtual vtkMatrix4x4GetProjectionTransformMatrix (double aspect, double nearz, double farz)
 Return the projection transform matrix, which converts from camera coordinates to viewport coordinates. More...
 
virtual vtkPerspectiveTransformGetProjectionTransformObject (double aspect, double nearz, double farz)
 Return the projection transform matrix, which converts from camera coordinates to viewport coordinates. More...
 
virtual vtkMatrix4x4GetCompositeProjectionTransformMatrix (double aspect, double nearz, double farz)
 Return the concatenation of the ViewTransform and the ProjectionTransform. More...
 
virtual vtkMatrix4x4GetProjectionTransformMatrix (vtkRenderer *ren)
 Return the projection transform matrix, which converts from camera coordinates to viewport coordinates. More...
 
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...
 
void ComputeViewPlaneNormal ()
 This method is called automatically whenever necessary, it should never be used outside of vtkCamera.cxx. More...
 
vtkMatrix4x4GetCameraLightTransformMatrix ()
 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...
 
void ShallowCopy (vtkCamera *source)
 Copy the properties of `source' into `this'. More...
 
void DeepCopy (vtkCamera *source)
 Copy the properties of `source' into `this'. 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])
 Set/Get the position of the camera in world coordinates. More...
 
virtual doubleGetPosition ()
 Set/Get the position of the camera in world coordinates. More...
 
virtual void GetPosition (double &, double &, double &)
 Set/Get the position of the camera in world coordinates. More...
 
virtual void GetPosition (double[3])
 Set/Get the position of the camera in world coordinates. More...
 
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])
 Set/Get the focal of the camera in world coordinates. More...
 
virtual doubleGetFocalPoint ()
 Set/Get the focal of the camera in world coordinates. More...
 
virtual void GetFocalPoint (double &, double &, double &)
 Set/Get the focal of the camera in world coordinates. More...
 
virtual void GetFocalPoint (double[3])
 Set/Get the focal of the camera in world coordinates. More...
 
void SetViewUp (double vx, double vy, double vz)
 Set/Get the view up direction for the camera. More...
 
void SetViewUp (const double a[3])
 Set/Get the view up direction for the camera. More...
 
virtual doubleGetViewUp ()
 Set/Get the view up direction for the camera. More...
 
virtual void GetViewUp (double &, double &, double &)
 Set/Get the view up direction for the camera. More...
 
virtual void GetViewUp (double[3])
 Set/Get the view up direction for the camera. More...
 
virtual double GetDistance ()
 Return the distance from the camera position to the focal point. More...
 
virtual doubleGetDirectionOfProjection ()
 Get the vector in the direction from the camera position to the focal point. More...
 
virtual void GetDirectionOfProjection (double &, double &, double &)
 Get the vector in the direction from the camera position to the focal point. More...
 
virtual void GetDirectionOfProjection (double[3])
 Get the vector in the direction from the camera position to the focal point. More...
 
void SetRoll (double angle)
 Set the roll angle of the camera about the direction of projection. More...
 
double GetRoll ()
 Set the roll angle of the camera about the direction of projection. More...
 
void SetParallelProjection (vtkTypeBool flag)
 Set/Get the value of the ParallelProjection instance variable. More...
 
virtual vtkTypeBool GetParallelProjection ()
 Set/Get the value of the ParallelProjection instance variable. More...
 
virtual void ParallelProjectionOn ()
 Set/Get the value of the ParallelProjection instance variable. More...
 
virtual void ParallelProjectionOff ()
 Set/Get the value of the ParallelProjection instance variable. More...
 
void SetUseHorizontalViewAngle (vtkTypeBool flag)
 Set/Get the value of the UseHorizontalViewAngle instance variable. More...
 
virtual vtkTypeBool GetUseHorizontalViewAngle ()
 Set/Get the value of the UseHorizontalViewAngle instance variable. More...
 
virtual void UseHorizontalViewAngleOn ()
 Set/Get the value of the UseHorizontalViewAngle instance variable. More...
 
virtual void UseHorizontalViewAngleOff ()
 Set/Get the value of the UseHorizontalViewAngle instance variable. More...
 
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 ()
 Set/Get the camera view angle, which is the angular height of the camera view measured in degrees. More...
 
void SetParallelScale (double scale)
 Set/Get the scaling used for a parallel projection, i.e. More...
 
virtual double GetParallelScale ()
 Set/Get the scaling used for a parallel projection, i.e. 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])
 Set/Get the location of the near and far clipping planes along the direction of projection. More...
 
virtual doubleGetClippingRange ()
 Set/Get the location of the near and far clipping planes along the direction of projection. More...
 
virtual void GetClippingRange (double &, double &)
 Set/Get the location of the near and far clipping planes along the direction of projection. More...
 
virtual void GetClippingRange (double[2])
 Set/Get the location of the near and far clipping planes along the direction of projection. More...
 
void SetThickness (double)
 Set the distance between clipping planes. More...
 
virtual double GetThickness ()
 Set the distance between clipping planes. More...
 
void SetWindowCenter (double x, double y)
 Set/Get the center of the window in viewport coordinates. More...
 
virtual doubleGetWindowCenter ()
 Set/Get the center of the window in viewport coordinates. More...
 
virtual void GetWindowCenter (double &, double &)
 Set/Get the center of the window in viewport coordinates. More...
 
virtual void GetWindowCenter (double[2])
 Set/Get the center of the window in viewport coordinates. More...
 
virtual doubleGetViewPlaneNormal ()
 Get the ViewPlaneNormal. More...
 
virtual void GetViewPlaneNormal (double &, double &, double &)
 Get the ViewPlaneNormal. More...
 
virtual void GetViewPlaneNormal (double[3])
 Get the ViewPlaneNormal. More...
 
void SetViewShear (double dxdz, double dydz, double center)
 Set/get the shear transform of the viewing frustum. More...
 
void SetViewShear (double d[3])
 Set/get the shear transform of the viewing frustum. More...
 
virtual doubleGetViewShear ()
 Set/get the shear transform of the viewing frustum. More...
 
virtual void GetViewShear (double &, double &, double &)
 Set/get the shear transform of the viewing frustum. More...
 
virtual void GetViewShear (double[3])
 Set/get the shear transform of the viewing frustum. More...
 
virtual void SetEyeAngle (double)
 Set/Get the separation between eyes (in degrees). More...
 
virtual double GetEyeAngle ()
 Set/Get the separation between eyes (in degrees). More...
 
virtual void SetFocalDisk (double)
 Set the size of the cameras lens in world coordinates. More...
 
virtual double GetFocalDisk ()
 Set the size of the cameras lens in world coordinates. More...
 
virtual void SetUseOffAxisProjection (vtkTypeBool)
 Set/Get use offaxis frustum. More...
 
virtual vtkTypeBool GetUseOffAxisProjection ()
 Set/Get use offaxis frustum. More...
 
virtual void UseOffAxisProjectionOn ()
 Set/Get use offaxis frustum. More...
 
virtual void UseOffAxisProjectionOff ()
 Set/Get use offaxis frustum. More...
 
virtual void SetScreenBottomLeft (double, double, double)
 Set/Get top left corner point of the screen. More...
 
virtual void SetScreenBottomLeft (double[3])
 Set/Get top left corner point of the screen. More...
 
virtual doubleGetScreenBottomLeft ()
 Set/Get top left corner point of the screen. More...
 
virtual void GetScreenBottomLeft (double &, double &, double &)
 Set/Get top left corner point of the screen. More...
 
virtual void GetScreenBottomLeft (double[3])
 Set/Get top left corner point of the screen. More...
 
virtual void SetScreenBottomRight (double, double, double)
 Set/Get bottom left corner point of the screen. More...
 
virtual void SetScreenBottomRight (double[3])
 Set/Get bottom left corner point of the screen. More...
 
virtual doubleGetScreenBottomRight ()
 Set/Get bottom left corner point of the screen. More...
 
virtual void GetScreenBottomRight (double &, double &, double &)
 Set/Get bottom left corner point of the screen. More...
 
virtual void GetScreenBottomRight (double[3])
 Set/Get bottom left corner point of the screen. More...
 
virtual void SetScreenTopRight (double, double, double)
 Set/Get top right corner point of the screen. More...
 
virtual void SetScreenTopRight (double[3])
 Set/Get top right corner point of the screen. More...
 
virtual doubleGetScreenTopRight ()
 Set/Get top right corner point of the screen. More...
 
virtual void GetScreenTopRight (double &, double &, double &)
 Set/Get top right corner point of the screen. More...
 
virtual void GetScreenTopRight (double[3])
 Set/Get top right corner point of the screen. More...
 
virtual void SetEyeSeparation (double)
 Set/Get distance between the eyes. More...
 
virtual double GetEyeSeparation ()
 Set/Get distance between the eyes. More...
 
void SetEyePosition (double eyePosition[3])
 Set/Get the eye position (center point between two eyes). More...
 
void GetEyePosition (double eyePosition[3])
 Set/Get the eye position (center point between two eyes). More...
 
void SetEyeTransformMatrix (vtkMatrix4x4 *matrix)
 Set/Get eye transformation matrix. More...
 
virtual vtkMatrix4x4GetEyeTransformMatrix ()
 Set/Get eye transformation matrix. More...
 
void SetModelTransformMatrix (vtkMatrix4x4 *matrix)
 Set/Get model transformation matrix. More...
 
virtual vtkMatrix4x4GetModelTransformMatrix ()
 Set/Get model transformation matrix. More...
 
virtual void SetExplicitProjectionTransformMatrix (vtkMatrix4x4 *)
 Set/get an explicit 4x4 projection matrix to use, rather than computing one from other state variables. More...
 
virtual vtkMatrix4x4GetExplicitProjectionTransformMatrix ()
 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...
 
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 vtkHomogeneousTransformGetUserViewTransform ()
 In addition to the instance variables such as position and orientation, you can add an additional transformation for your own use. More...
 
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 vtkHomogeneousTransformGetUserTransform ()
 In addition to the instance variables such as position and orientation, you can add an additional transformation for your own use. More...
 
doubleGetOrientation ()
 Get the orientation of the camera. More...
 
doubleGetOrientationWXYZ ()
 Get the orientation of the camera. More...
 
virtual void SetLeftEye (int)
 Set the Left Eye setting. More...
 
virtual int GetLeftEye ()
 Set the Left Eye setting. More...
 
virtual void SetFreezeFocalPoint (bool)
 Set/Get the value of the FreezeDolly instance variable. More...
 
virtual bool GetFreezeFocalPoint ()
 Set/Get the value of the FreezeDolly instance variable. More...
 
virtual void SetUseScissor (bool)
 Enable/Disable the scissor. More...
 
virtual bool GetUseScissor ()
 Enable/Disable the scissor. More...
 
void SetScissorRect (vtkRecti scissorRect)
 Set/Get the vtkRect value of the scissor. More...
 
void GetScissorRect (vtkRecti &scissorRect)
 Set/Get the vtkRect value of the scissor. More...
 
virtual vtkInformationGetInformation ()
 Set/Get the information object associated with this camera. More...
 
virtual void SetInformation (vtkInformation *)
 Set/Get the information object associated with this camera. More...
 
- Public Member Functions inherited from vtkObject
 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...
 
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)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
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)
 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, 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)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. 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 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...
 
void PrintRevisions (ostream &)
 Legacy. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkCameraSafeDownCast (vtkObjectBase *o)
 
static vtkCameraNew ()
 Construct camera instance with its focal point at the origin, and position=(0,0,1). More...
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static int GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkCamera ()
 
 ~vtkCamera () override
 
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...
 
void ComputeDistance ()
 These methods should only be used within vtkCamera.cxx. More...
 
virtual void ComputeViewTransform ()
 These methods should only be used within vtkCamera.cxx. More...
 
- Protected Member Functions inherited from vtkObject
 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

double WindowCenter [2]
 
double ObliqueAngles [2]
 
double FocalPoint [3]
 
double Position [3]
 
double ViewUp [3]
 
double ViewAngle
 
double ClippingRange [2]
 
double EyeAngle
 
vtkTypeBool ParallelProjection
 
double ParallelScale
 
int Stereo
 
int LeftEye
 
double Thickness
 
double Distance
 
double DirectionOfProjection [3]
 
double ViewPlaneNormal [3]
 
double ViewShear [3]
 
vtkTypeBool UseHorizontalViewAngle
 
vtkTypeBool UseOffAxisProjection
 
double ScreenBottomLeft [3]
 
double ScreenBottomRight [3]
 
double ScreenTopRight [3]
 
double EyeSeparation
 
vtkMatrix4x4WorldToScreenMatrix
 
vtkTimeStamp WorldToScreenMatrixMTime
 
vtkMatrix4x4EyeTransformMatrix
 
vtkMatrix4x4ModelTransformMatrix
 
vtkHomogeneousTransformUserTransform
 
vtkHomogeneousTransformUserViewTransform
 
vtkMatrix4x4ExplicitProjectionTransformMatrix
 
bool UseExplicitProjectionTransformMatrix
 
vtkTransformViewTransform
 
vtkPerspectiveTransformProjectionTransform
 
vtkPerspectiveTransformTransform
 
vtkTransformCameraLightTransform
 
vtkTransformModelViewTransform
 
double FocalDisk
 
vtkCameraCallbackCommandUserViewTransformCallbackCommand
 
vtkTimeStamp ViewingRaysMTime
 
bool FreezeFocalPoint
 
bool UseScissor
 
vtkRecti ScissorRect
 
vtkInformationInformation
 
- Protected Attributes inherited from vtkObject
bool Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
vtkAtomicInt32 ReferenceCount
 
vtkWeakPointerBase ** WeakPointers
 

Friends

class vtkCameraCallbackCommand
 

Detailed Description

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.

See also
vtkPerspectiveTransform
Examples:
vtkCamera (Examples)
Tests:
vtkCamera (Tests)

Definition at line 51 of file vtkCamera.h.

Member Typedef Documentation

Definition at line 54 of file vtkCamera.h.

Constructor & Destructor Documentation

vtkCamera::vtkCamera ( )
protected
vtkCamera::~vtkCamera ( )
overrideprotected

Member Function Documentation

static vtkTypeBool vtkCamera::IsTypeOf ( const char *  type)
static
virtual vtkTypeBool vtkCamera::IsA ( const char *  name)
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 vtkCamera* vtkCamera::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkCamera::NewInstanceInternal ( ) const
protectedvirtual
vtkCamera* vtkCamera::NewInstance ( ) const
void vtkCamera::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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 vtkCamera* vtkCamera::New ( )
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).

void vtkCamera::SetPosition ( const double  a[3])
inline

Set/Get the position of the camera in world coordinates.

The default position is (0,0,1).

Definition at line 70 of file vtkCamera.h.

virtual double* vtkCamera::GetPosition ( )
virtual

Set/Get the position of the camera in world coordinates.

The default position is (0,0,1).

virtual void vtkCamera::GetPosition ( double ,
double ,
double  
)
virtual

Set/Get the position of the camera in world coordinates.

The default position is (0,0,1).

virtual void vtkCamera::GetPosition ( double  [3])
virtual

Set/Get the position of the camera in world coordinates.

The default position is (0,0,1).

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.

void vtkCamera::SetFocalPoint ( const double  a[3])
inline

Set/Get the focal of the camera in world coordinates.

The default focal point is the origin.

Definition at line 81 of file vtkCamera.h.

virtual double* vtkCamera::GetFocalPoint ( )
virtual

Set/Get the focal of the camera in world coordinates.

The default focal point is the origin.

virtual void vtkCamera::GetFocalPoint ( double ,
double ,
double  
)
virtual

Set/Get the focal of the camera in world coordinates.

The default focal point is the origin.

virtual void vtkCamera::GetFocalPoint ( double  [3])
virtual

Set/Get the focal of the camera in world coordinates.

The default focal point is the origin.

void vtkCamera::SetViewUp ( double  vx,
double  vy,
double  vz 
)

Set/Get the view up direction for the camera.

The default is (0,1,0).

void vtkCamera::SetViewUp ( const double  a[3])
inline

Set/Get the view up direction for the camera.

The default is (0,1,0).

Definition at line 92 of file vtkCamera.h.

virtual double* vtkCamera::GetViewUp ( )
virtual

Set/Get the view up direction for the camera.

The default is (0,1,0).

virtual void vtkCamera::GetViewUp ( double ,
double ,
double  
)
virtual

Set/Get the view up direction for the camera.

The default is (0,1,0).

virtual void vtkCamera::GetViewUp ( double  [3])
virtual

Set/Get the view up direction for the camera.

The default is (0,1,0).

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 double vtkCamera::GetDistance ( )
virtual

Return the distance from the camera position to the focal point.

This distance is positive.

virtual double* vtkCamera::GetDirectionOfProjection ( )
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 void vtkCamera::GetDirectionOfProjection ( double ,
double ,
double  
)
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 void vtkCamera::GetDirectionOfProjection ( double  [3])
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.

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 ( )

Set the roll angle of the camera about the direction of projection.

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.

Note
This setting is ignored when UseExplicitProjectionTransformMatrix is true.
virtual vtkTypeBool vtkCamera::GetParallelProjection ( )
virtual

Set/Get the value of the ParallelProjection instance variable.

This determines if the camera should do a perspective or parallel projection.

Note
This setting is ignored when UseExplicitProjectionTransformMatrix is true.
virtual void vtkCamera::ParallelProjectionOn ( )
virtual

Set/Get the value of the ParallelProjection instance variable.

This determines if the camera should do a perspective or parallel projection.

Note
This setting is ignored when UseExplicitProjectionTransformMatrix is true.
virtual void vtkCamera::ParallelProjectionOff ( )
virtual

Set/Get the value of the ParallelProjection instance variable.

This determines if the camera should do a perspective or parallel projection.

Note
This setting is ignored when UseExplicitProjectionTransformMatrix is true.
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.

Note
This setting is ignored when UseExplicitProjectionTransformMatrix is true.
virtual vtkTypeBool vtkCamera::GetUseHorizontalViewAngle ( )
virtual

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.

Note
This setting is ignored when UseExplicitProjectionTransformMatrix is true.
virtual void vtkCamera::UseHorizontalViewAngleOn ( )
virtual

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.

Note
This setting is ignored when UseExplicitProjectionTransformMatrix is true.
virtual void vtkCamera::UseHorizontalViewAngleOff ( )
virtual

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.

Note
This setting is ignored when UseExplicitProjectionTransformMatrix is true.
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.

Note
This setting is ignored when UseExplicitProjectionTransformMatrix is true.
virtual double vtkCamera::GetViewAngle ( )
virtual

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.

Note
This setting is ignored when UseExplicitProjectionTransformMatrix is true.
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.

Note
This setting is ignored when UseExplicitProjectionTransformMatrix is true.
virtual double vtkCamera::GetParallelScale ( )
virtual

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.

Note
This setting is ignored when UseExplicitProjectionTransformMatrix is true.
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.

Note
This setting is ignored when UseExplicitProjectionTransformMatrix is true.
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.

Note
This setting is ignored when UseExplicitProjectionTransformMatrix is true.
void vtkCamera::SetClippingRange ( const double  a[2])
inline

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.

Note
This setting is ignored when UseExplicitProjectionTransformMatrix is true.

Definition at line 263 of file vtkCamera.h.

virtual double* vtkCamera::GetClippingRange ( )
virtual

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.

Note
This setting is ignored when UseExplicitProjectionTransformMatrix is true.
virtual void vtkCamera::GetClippingRange ( double ,
double  
)
virtual

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.

Note
This setting is ignored when UseExplicitProjectionTransformMatrix is true.
virtual void vtkCamera::GetClippingRange ( double  [2])
virtual

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.

Note
This setting is ignored when UseExplicitProjectionTransformMatrix is true.
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.

Note
This setting is ignored when UseExplicitProjectionTransformMatrix is true.
virtual double vtkCamera::GetThickness ( )
virtual

Set the distance between clipping planes.

This method adjusts the far clipping plane to be set a distance 'thickness' beyond the near clipping plane.

Note
This setting is ignored when UseExplicitProjectionTransformMatrix is true.
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.

Note
This setting is ignored when UseExplicitProjectionTransformMatrix is true.
virtual double* vtkCamera::GetWindowCenter ( )
virtual

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.

Note
This setting is ignored when UseExplicitProjectionTransformMatrix is true.
virtual void vtkCamera::GetWindowCenter ( double ,
double  
)
virtual

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.

Note
This setting is ignored when UseExplicitProjectionTransformMatrix is true.
virtual void vtkCamera::GetWindowCenter ( double  [2])
virtual

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.

Note
This setting is ignored when UseExplicitProjectionTransformMatrix is true.
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).

Note
This setting is ignored when UseExplicitProjectionTransformMatrix is true.
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 double* vtkCamera::GetViewPlaneNormal ( )
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 void vtkCamera::GetViewPlaneNormal ( double ,
double ,
double  
)
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 void vtkCamera::GetViewPlaneNormal ( double  [3])
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.

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).

Note
This setting is ignored when UseExplicitProjectionTransformMatrix is true.
void vtkCamera::SetViewShear ( double  d[3])

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).

Note
This setting is ignored when UseExplicitProjectionTransformMatrix is true.
virtual double* vtkCamera::GetViewShear ( )
virtual

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).

Note
This setting is ignored when UseExplicitProjectionTransformMatrix is true.
virtual void vtkCamera::GetViewShear ( double ,
double ,
double  
)
virtual

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).

Note
This setting is ignored when UseExplicitProjectionTransformMatrix is true.
virtual void vtkCamera::GetViewShear ( double  [3])
virtual

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).

Note
This setting is ignored when UseExplicitProjectionTransformMatrix is true.
virtual void vtkCamera::SetEyeAngle ( double  )
virtual

Set/Get the separation between eyes (in degrees).

This is used when generating stereo images.

virtual double vtkCamera::GetEyeAngle ( )
virtual

Set/Get the separation between eyes (in degrees).

This is used when generating stereo images.

virtual void vtkCamera::SetFocalDisk ( double  )
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 double vtkCamera::GetFocalDisk ( )
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 void vtkCamera::SetUseOffAxisProjection ( vtkTypeBool  )
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.

Note
This setting is ignored when UseExplicitProjectionTransformMatrix is true.
virtual vtkTypeBool vtkCamera::GetUseOffAxisProjection ( )
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.

Note
This setting is ignored when UseExplicitProjectionTransformMatrix is true.
virtual void vtkCamera::UseOffAxisProjectionOn ( )
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.

Note
This setting is ignored when UseExplicitProjectionTransformMatrix is true.
virtual void vtkCamera::UseOffAxisProjectionOff ( )
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.

Note
This setting is ignored when UseExplicitProjectionTransformMatrix is true.
virtual void vtkCamera::SetScreenBottomLeft ( double  ,
double  ,
double   
)
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 void vtkCamera::SetScreenBottomLeft ( double  [3])
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 double* vtkCamera::GetScreenBottomLeft ( )
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 void vtkCamera::GetScreenBottomLeft ( double ,
double ,
double  
)
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 void vtkCamera::GetScreenBottomLeft ( double  [3])
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 void vtkCamera::SetScreenBottomRight ( double  ,
double  ,
double   
)
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 void vtkCamera::SetScreenBottomRight ( double  [3])
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 double* vtkCamera::GetScreenBottomRight ( )
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 void vtkCamera::GetScreenBottomRight ( double ,
double ,
double  
)
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 void vtkCamera::GetScreenBottomRight ( double  [3])
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 void vtkCamera::SetScreenTopRight ( double  ,
double  ,
double   
)
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 void vtkCamera::SetScreenTopRight ( double  [3])
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 double* vtkCamera::GetScreenTopRight ( )
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 void vtkCamera::GetScreenTopRight ( double ,
double ,
double  
)
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 void vtkCamera::GetScreenTopRight ( double  [3])
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 void vtkCamera::SetEyeSeparation ( double  )
virtual

Set/Get distance between the eyes.

This will be used only for offaxis frustum calculation. Default is 0.06.

virtual double vtkCamera::GetEyeSeparation ( )
virtual

Set/Get distance between the eyes.

This will be used only for offaxis frustum calculation. Default is 0.06.

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])

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::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 vtkMatrix4x4* vtkCamera::GetEyeTransformMatrix ( )
virtual

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.

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 vtkMatrix4x4* vtkCamera::GetModelTransformMatrix ( )
virtual

Set/Get model transformation matrix.

This matrix could be used for model related transformations such as scale, shear, rotations and translations.

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 vtkMatrix4x4* vtkCamera::GetModelViewTransformMatrix ( )
virtual

Return the model view matrix of model view transform.

virtual vtkTransform* vtkCamera::GetModelViewTransformObject ( )
virtual

Return the model view transform.

virtual vtkMatrix4x4* vtkCamera::GetViewTransformMatrix ( )
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 vtkTransform* vtkCamera::GetViewTransformObject ( )
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 void vtkCamera::SetExplicitProjectionTransformMatrix ( vtkMatrix4x4 )
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 vtkMatrix4x4* vtkCamera::GetExplicitProjectionTransformMatrix ( )
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 void vtkCamera::SetUseExplicitProjectionTransformMatrix ( bool  )
virtual

If true, the ExplicitProjectionTransformMatrix is used for the projection transformation, rather than computing a transform from internal state.

virtual bool vtkCamera::GetUseExplicitProjectionTransformMatrix ( )
virtual

If true, the ExplicitProjectionTransformMatrix is used for the projection transformation, rather than computing a transform from internal state.

virtual void vtkCamera::UseExplicitProjectionTransformMatrixOn ( )
virtual

If true, the ExplicitProjectionTransformMatrix is used for the projection transformation, rather than computing a transform from internal state.

virtual void vtkCamera::UseExplicitProjectionTransformMatrixOff ( )
virtual

If true, the ExplicitProjectionTransformMatrix is used for the projection transformation, rather than computing a transform from internal state.

virtual vtkMatrix4x4* vtkCamera::GetProjectionTransformMatrix ( double  aspect,
double  nearz,
double  farz 
)
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]).

See also
ExplicitProjectionTransformMatrix
virtual vtkPerspectiveTransform* vtkCamera::GetProjectionTransformObject ( double  aspect,
double  nearz,
double  farz 
)
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]).

See also
ExplicitProjectionTransformMatrix
virtual vtkMatrix4x4* vtkCamera::GetCompositeProjectionTransformMatrix ( double  aspect,
double  nearz,
double  farz 
)
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]).

See also
ExplicitProjectionTransformMatrix
virtual vtkMatrix4x4* vtkCamera::GetProjectionTransformMatrix ( vtkRenderer ren)
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

See also
ExplicitProjectionTransformMatrix
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 vtkHomogeneousTransform* vtkCamera::GetUserViewTransform ( )
virtual

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

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 vtkHomogeneousTransform* vtkCamera::GetUserTransform ( )
virtual

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 void vtkCamera::Render ( vtkRenderer )
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 vtkOpenVRCamera, vtkOpenGLCamera, and vtkExternalOpenGLCamera.

Definition at line 591 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 void vtkCamera::GetFrustumPlanes ( double  aspect,
double  planes[24] 
)
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

double* vtkCamera::GetOrientation ( )

Get the orientation of the camera.

double* vtkCamera::GetOrientationWXYZ ( )

Get the orientation of the camera.

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).

virtual void vtkCamera::UpdateViewport ( vtkRenderer vtkNotUsedren)
inlinevirtual

Update the viewport.

Definition at line 639 of file vtkCamera.h.

virtual void vtkCamera::SetLeftEye ( int  )
virtual

Set the Left Eye setting.

virtual int vtkCamera::GetLeftEye ( )
virtual

Set the Left Eye setting.

void vtkCamera::ShallowCopy ( vtkCamera source)

Copy the properties of `source' into `this'.

Copy pointers of matrices.

Precondition
source_exists!=0
not_this: source!=this
void vtkCamera::DeepCopy ( vtkCamera source)

Copy the properties of `source' into `this'.

Copy the contents of the matrices.

Precondition
source_exists!=0
not_this: source!=this
virtual void vtkCamera::SetFreezeFocalPoint ( bool  )
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 bool vtkCamera::GetFreezeFocalPoint ( )
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 void vtkCamera::SetUseScissor ( bool  )
virtual

Enable/Disable the scissor.

virtual bool vtkCamera::GetUseScissor ( )
virtual

Enable/Disable the scissor.

void vtkCamera::SetScissorRect ( vtkRecti  scissorRect)

Set/Get the vtkRect value of the scissor.

void vtkCamera::GetScissorRect ( vtkRecti scissorRect)

Set/Get the vtkRect value of the scissor.

virtual vtkInformation* vtkCamera::GetInformation ( )
virtual

Set/Get the information object associated with this camera.

virtual void vtkCamera::SetInformation ( vtkInformation )
virtual

Set/Get the information object associated with this camera.

void vtkCamera::ComputeDistance ( )
protected

These methods should only be used within vtkCamera.cxx.

virtual void vtkCamera::ComputeViewTransform ( )
protectedvirtual

These methods should only be used within vtkCamera.cxx.

Reimplemented in vtkExternalOpenGLCamera.

virtual void vtkCamera::ComputeProjectionTransform ( double  aspect,
double  nearz,
double  farz 
)
protectedvirtual

These methods should only be used within vtkCamera.cxx.

void vtkCamera::ComputeCompositeProjectionTransform ( double  aspect,
double  nearz,
double  farz 
)
protected

These methods should only be used within vtkCamera.cxx.

void vtkCamera::ComputeCameraLightTransform ( )
protected
void vtkCamera::ComputeWorldToScreenMatrix ( )
protected

Given screen screen top, bottom left and top right calculate screen rotation.

void vtkCamera::ComputeOffAxisProjectionFrustum ( )
protected

Compute and use frustum using offaxis method.

void vtkCamera::ComputeModelViewMatrix ( )
protected

Compute model view matrix for the camera.

void vtkCamera::PartialCopy ( vtkCamera source)
protected

Copy the ivars.

Do nothing for the matrices. Called by ShallowCopy() and DeepCopy()

Precondition
source_exists!=0
not_this: source!=this

Friends And Related Function Documentation

friend class vtkCameraCallbackCommand
friend

Definition at line 802 of file vtkCamera.h.

Member Data Documentation

double vtkCamera::WindowCenter[2]
protected

Definition at line 752 of file vtkCamera.h.

double vtkCamera::ObliqueAngles[2]
protected

Definition at line 753 of file vtkCamera.h.

double vtkCamera::FocalPoint[3]
protected

Definition at line 754 of file vtkCamera.h.

double vtkCamera::Position[3]
protected

Definition at line 755 of file vtkCamera.h.

double vtkCamera::ViewUp[3]
protected

Definition at line 756 of file vtkCamera.h.

double vtkCamera::ViewAngle
protected

Definition at line 757 of file vtkCamera.h.

double vtkCamera::ClippingRange[2]
protected

Definition at line 758 of file vtkCamera.h.

double vtkCamera::EyeAngle
protected

Definition at line 759 of file vtkCamera.h.

vtkTypeBool vtkCamera::ParallelProjection
protected

Definition at line 760 of file vtkCamera.h.

double vtkCamera::ParallelScale
protected

Definition at line 761 of file vtkCamera.h.

int vtkCamera::Stereo
protected

Definition at line 762 of file vtkCamera.h.

int vtkCamera::LeftEye
protected

Definition at line 763 of file vtkCamera.h.

double vtkCamera::Thickness
protected

Definition at line 764 of file vtkCamera.h.

double vtkCamera::Distance
protected

Definition at line 765 of file vtkCamera.h.

double vtkCamera::DirectionOfProjection[3]
protected

Definition at line 766 of file vtkCamera.h.

double vtkCamera::ViewPlaneNormal[3]
protected

Definition at line 767 of file vtkCamera.h.

double vtkCamera::ViewShear[3]
protected

Definition at line 768 of file vtkCamera.h.

vtkTypeBool vtkCamera::UseHorizontalViewAngle
protected

Definition at line 769 of file vtkCamera.h.

vtkTypeBool vtkCamera::UseOffAxisProjection
protected

Definition at line 771 of file vtkCamera.h.

double vtkCamera::ScreenBottomLeft[3]
protected

Definition at line 773 of file vtkCamera.h.

double vtkCamera::ScreenBottomRight[3]
protected

Definition at line 774 of file vtkCamera.h.

double vtkCamera::ScreenTopRight[3]
protected

Definition at line 775 of file vtkCamera.h.

double vtkCamera::EyeSeparation
protected

Definition at line 777 of file vtkCamera.h.

vtkMatrix4x4* vtkCamera::WorldToScreenMatrix
protected

Definition at line 779 of file vtkCamera.h.

vtkTimeStamp vtkCamera::WorldToScreenMatrixMTime
protected

Definition at line 780 of file vtkCamera.h.

vtkMatrix4x4* vtkCamera::EyeTransformMatrix
protected

Definition at line 782 of file vtkCamera.h.

vtkMatrix4x4* vtkCamera::ModelTransformMatrix
protected

Definition at line 784 of file vtkCamera.h.

vtkHomogeneousTransform* vtkCamera::UserTransform
protected

Definition at line 786 of file vtkCamera.h.

vtkHomogeneousTransform* vtkCamera::UserViewTransform
protected

Definition at line 787 of file vtkCamera.h.

vtkMatrix4x4* vtkCamera::ExplicitProjectionTransformMatrix
protected

Definition at line 789 of file vtkCamera.h.

bool vtkCamera::UseExplicitProjectionTransformMatrix
protected

Definition at line 790 of file vtkCamera.h.

vtkTransform* vtkCamera::ViewTransform
protected

Definition at line 792 of file vtkCamera.h.

vtkPerspectiveTransform* vtkCamera::ProjectionTransform
protected

Definition at line 793 of file vtkCamera.h.

vtkPerspectiveTransform* vtkCamera::Transform
protected

Definition at line 794 of file vtkCamera.h.

vtkTransform* vtkCamera::CameraLightTransform
protected

Definition at line 795 of file vtkCamera.h.

vtkTransform* vtkCamera::ModelViewTransform
protected

Definition at line 797 of file vtkCamera.h.

double vtkCamera::FocalDisk
protected

Definition at line 799 of file vtkCamera.h.

vtkCameraCallbackCommand* vtkCamera::UserViewTransformCallbackCommand
protected

Definition at line 801 of file vtkCamera.h.

vtkTimeStamp vtkCamera::ViewingRaysMTime
protected

Definition at line 807 of file vtkCamera.h.

bool vtkCamera::FreezeFocalPoint
protected

Definition at line 808 of file vtkCamera.h.

bool vtkCamera::UseScissor
protected

Definition at line 809 of file vtkCamera.h.

vtkRecti vtkCamera::ScissorRect
protected

Definition at line 811 of file vtkCamera.h.

vtkInformation* vtkCamera::Information
protected

Definition at line 814 of file vtkCamera.h.


The documentation for this class was generated from the following file: