a virtual camera for 3D rendering More...

#include <vtkCamera.h>

Inheritance diagram for vtkCamera:

Collaboration diagram for vtkCamera:

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.

vtkCamera *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	OrthogonalizeViewUp ()
	Recompute the ViewUp vector to force it to be perpendicular to camera->focalpoint vector.

void	SetDistance (double)
	Move the focal point so that it is the specified distance from the camera position.

void	Dolly (double value)
	Divide the camera's distance from the focal point by the given dolly value.

void	Roll (double angle)
	Rotate the camera about the direction of projection.

void	Azimuth (double angle)
	Rotate the camera about the view up vector centered at the focal point.

void	Yaw (double angle)
	Rotate the focal point about the view up vector, using the camera's position as the center of rotation.

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.

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.

void	Zoom (double factor)
	In perspective mode, decrease the view angle by the specified factor.

void	SetObliqueAngles (double alpha, double beta)
	Get/Set the oblique viewing angles.

void	ApplyTransform (vtkTransform *t)
	Apply a transform to the camera.

void	GetEyePlaneNormal (double normal[3])
	Get normal vector from eye to screen rotated by EyeTransformMatrix.

virtual vtkMatrix4x4 *	GetModelViewTransformMatrix ()
	Return the model view matrix of model view transform.

virtual vtkTransform *	GetModelViewTransformObject ()
	Return the model view transform.

virtual vtkMatrix4x4 *	GetViewTransformMatrix ()
	For backward compatibility.

virtual vtkTransform *	GetViewTransformObject ()
	For backward compatibility.

virtual vtkMatrix4x4 *	GetProjectionTransformMatrix (double aspect, double nearz, double farz)
	Return the projection transform matrix, which converts from camera coordinates to viewport coordinates.

virtual vtkPerspectiveTransform *	GetProjectionTransformObject (double aspect, double nearz, double farz)
	Return the projection transform matrix, which converts from camera coordinates to viewport coordinates.

virtual vtkMatrix4x4 *	GetCompositeProjectionTransformMatrix (double aspect, double nearz, double farz)
	Return the concatenation of the ViewTransform and the ProjectionTransform.

virtual vtkMatrix4x4 *	GetProjectionTransformMatrix (vtkRenderer *ren)
	Return the projection transform matrix, which converts from camera coordinates to viewport coordinates.

virtual void	Render (vtkRenderer *)
	This method causes the camera to set up whatever is required for viewing the scene.

vtkMTimeType	GetViewingRaysMTime ()
	Return the MTime that concerns recomputing the view rays of the camera.

void	ViewingRaysModified ()
	Mark that something has changed which requires the view rays to be recomputed.

virtual void	GetFrustumPlanes (double aspect, double planes[24])
	Get the plane equations that bound the view frustum.

void	ComputeViewPlaneNormal ()
	This method is called automatically whenever necessary, it should never be used outside of vtkCamera.cxx.

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

virtual void	UpdateViewport (vtkRenderer *vtkNotUsed(ren))
	Update the viewport.

void	ShallowCopy (vtkCamera *source)
	Copy the properties of ‘source’ into ‘this’.

void	DeepCopy (vtkCamera *source)
	Copy the properties of ‘source’ into ‘this’.


void	SetPosition (double x, double y, double z)
	Set/Get the position of the camera in world coordinates.

void	SetPosition (const double a[3])
	Set/Get the position of the camera in world coordinates.

virtual double *	GetPosition ()
	Set/Get the position of the camera in world coordinates.

virtual void	GetPosition (double &, double &, double &)
	Set/Get the position of the camera in world coordinates.

virtual void	GetPosition (double[3])
	Set/Get the position of the camera in world coordinates.


void	SetFocalPoint (double x, double y, double z)
	Set/Get the focal of the camera in world coordinates.

void	SetFocalPoint (const double a[3])
	Set/Get the focal of the camera in world coordinates.

virtual double *	GetFocalPoint ()
	Set/Get the focal of the camera in world coordinates.

virtual void	GetFocalPoint (double &, double &, double &)
	Set/Get the focal of the camera in world coordinates.

virtual void	GetFocalPoint (double[3])
	Set/Get the focal of the camera in world coordinates.


void	SetViewUp (double vx, double vy, double vz)
	Set/Get the view up direction for the camera.

void	SetViewUp (const double a[3])
	Set/Get the view up direction for the camera.

virtual double *	GetViewUp ()
	Set/Get the view up direction for the camera.

virtual void	GetViewUp (double &, double &, double &)
	Set/Get the view up direction for the camera.

virtual void	GetViewUp (double[3])
	Set/Get the view up direction for the camera.


virtual double	GetDistance ()
	Return the distance from the camera position to the focal point.


virtual double *	GetDirectionOfProjection ()
	Get the vector in the direction from the camera position to the focal point.

virtual void	GetDirectionOfProjection (double &, double &, double &)
	Get the vector in the direction from the camera position to the focal point.

virtual void	GetDirectionOfProjection (double[3])
	Get the vector in the direction from the camera position to the focal point.


void	SetRoll (double angle)
	Set the roll angle of the camera about the direction of projection.

double	GetRoll ()
	Set the roll angle of the camera about the direction of projection.


void	SetParallelProjection (vtkTypeBool flag)
	Set/Get the value of the ParallelProjection instance variable.

virtual vtkTypeBool	GetParallelProjection ()
	Set/Get the value of the ParallelProjection instance variable.

virtual void	ParallelProjectionOn ()
	Set/Get the value of the ParallelProjection instance variable.

virtual void	ParallelProjectionOff ()
	Set/Get the value of the ParallelProjection instance variable.


void	SetUseHorizontalViewAngle (vtkTypeBool flag)
	Set/Get the value of the UseHorizontalViewAngle instance variable.

virtual vtkTypeBool	GetUseHorizontalViewAngle ()
	Set/Get the value of the UseHorizontalViewAngle instance variable.

virtual void	UseHorizontalViewAngleOn ()
	Set/Get the value of the UseHorizontalViewAngle instance variable.

virtual void	UseHorizontalViewAngleOff ()
	Set/Get the value of the UseHorizontalViewAngle instance variable.


void	SetViewAngle (double angle)
	Set/Get the camera view angle, which is the angular height of the camera view measured in degrees.

virtual double	GetViewAngle ()
	Set/Get the camera view angle, which is the angular height of the camera view measured in degrees.


void	SetParallelScale (double scale)
	Set/Get the scaling used for a parallel projection, i.e.

virtual double	GetParallelScale ()
	Set/Get the scaling used for a parallel projection, i.e.


void	SetClippingRange (double dNear, double dFar)
	Set/Get the location of the near and far clipping planes along the direction of projection.

void	SetClippingRange (const double a[2])
	Set/Get the location of the near and far clipping planes along the direction of projection.

virtual double *	GetClippingRange ()
	Set/Get the location of the near and far clipping planes along the direction of projection.

virtual void	GetClippingRange (double &, double &)
	Set/Get the location of the near and far clipping planes along the direction of projection.

virtual void	GetClippingRange (double[2])
	Set/Get the location of the near and far clipping planes along the direction of projection.


void	SetThickness (double)
	Set the distance between clipping planes.

virtual double	GetThickness ()
	Set the distance between clipping planes.


void	SetWindowCenter (double x, double y)
	Set/Get the center of the window in viewport coordinates.

virtual double *	GetWindowCenter ()
	Set/Get the center of the window in viewport coordinates.

virtual void	GetWindowCenter (double &, double &)
	Set/Get the center of the window in viewport coordinates.

virtual void	GetWindowCenter (double[2])
	Set/Get the center of the window in viewport coordinates.


virtual double *	GetViewPlaneNormal ()
	Get the ViewPlaneNormal.

virtual void	GetViewPlaneNormal (double &, double &, double &)
	Get the ViewPlaneNormal.

virtual void	GetViewPlaneNormal (double[3])
	Get the ViewPlaneNormal.


void	SetViewShear (double dxdz, double dydz, double center)
	Set/get the shear transform of the viewing frustum.

void	SetViewShear (double d[3])
	Set/get the shear transform of the viewing frustum.

virtual double *	GetViewShear ()
	Set/get the shear transform of the viewing frustum.

virtual void	GetViewShear (double &, double &, double &)
	Set/get the shear transform of the viewing frustum.

virtual void	GetViewShear (double[3])
	Set/get the shear transform of the viewing frustum.


virtual void	SetEyeAngle (double)
	Set/Get the separation between eyes (in degrees).

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


virtual void	SetFocalDisk (double)
	Set the size of the cameras lens in world coordinates.

virtual double	GetFocalDisk ()
	Set the size of the cameras lens in world coordinates.


virtual void	SetFocalDistance (double)
	Sets the distance at which rendering is in focus.

virtual double	GetFocalDistance ()
	Sets the distance at which rendering is in focus.


virtual void	SetUseOffAxisProjection (vtkTypeBool)
	Set/Get use offaxis frustum.

virtual vtkTypeBool	GetUseOffAxisProjection ()
	Set/Get use offaxis frustum.

virtual void	UseOffAxisProjectionOn ()
	Set/Get use offaxis frustum.

virtual void	UseOffAxisProjectionOff ()
	Set/Get use offaxis frustum.


double	GetOffAxisClippingAdjustment ()
	Get adjustment to clipping thickness, computed by camera based on the physical size of the screen and the direction to the tracked head/eye.


virtual void	SetScreenBottomLeft (double, double, double)
	Set/Get top left corner point of the screen.

virtual void	SetScreenBottomLeft (double[3])
	Set/Get top left corner point of the screen.

virtual double *	GetScreenBottomLeft ()
	Set/Get top left corner point of the screen.

virtual void	GetScreenBottomLeft (double &, double &, double &)
	Set/Get top left corner point of the screen.

virtual void	GetScreenBottomLeft (double[3])
	Set/Get top left corner point of the screen.


virtual void	SetScreenBottomRight (double, double, double)
	Set/Get bottom left corner point of the screen.

virtual void	SetScreenBottomRight (double[3])
	Set/Get bottom left corner point of the screen.

virtual double *	GetScreenBottomRight ()
	Set/Get bottom left corner point of the screen.

virtual void	GetScreenBottomRight (double &, double &, double &)
	Set/Get bottom left corner point of the screen.

virtual void	GetScreenBottomRight (double[3])
	Set/Get bottom left corner point of the screen.


virtual void	SetScreenTopRight (double, double, double)
	Set/Get top right corner point of the screen.

virtual void	SetScreenTopRight (double[3])
	Set/Get top right corner point of the screen.

virtual double *	GetScreenTopRight ()
	Set/Get top right corner point of the screen.

virtual void	GetScreenTopRight (double &, double &, double &)
	Set/Get top right corner point of the screen.

virtual void	GetScreenTopRight (double[3])
	Set/Get top right corner point of the screen.


virtual void	SetEyeSeparation (double)
	Set/Get distance between the eyes.

virtual double	GetEyeSeparation ()
	Set/Get distance between the eyes.


void	SetEyePosition (double eyePosition[3])
	Set/Get the eye position (center point between two eyes).

void	GetEyePosition (double eyePosition[3])
	Set/Get the eye position (center point between two eyes).


void	GetStereoEyePosition (double eyePosition[3])
	Using the LeftEye property to determine whether left or right eye is being requested, this method computes and returns the position of the requested eye, taking head orientation and eye separation into account.


void	SetEyeTransformMatrix (vtkMatrix4x4 *matrix)
	Set/Get eye transformation matrix.

void	SetEyeTransformMatrix (const double elements[16])
	Set/Get eye transformation matrix.

virtual vtkMatrix4x4 *	GetEyeTransformMatrix ()
	Set/Get eye transformation matrix.


void	SetModelTransformMatrix (vtkMatrix4x4 *matrix)
	Set/Get model transformation matrix.

void	SetModelTransformMatrix (const double elements[16])
	Set/Get model transformation matrix.

virtual vtkMatrix4x4 *	GetModelTransformMatrix ()
	Set/Get model transformation matrix.


virtual void	SetExplicitProjectionTransformMatrix (vtkMatrix4x4 *)
	Set/get an explicit 4x4 projection matrix to use, rather than computing one from other state variables.

virtual vtkMatrix4x4 *	GetExplicitProjectionTransformMatrix ()
	Set/get an explicit 4x4 projection matrix to use, rather than computing one from other state variables.


virtual void	SetUseExplicitProjectionTransformMatrix (bool)
	If true, the ExplicitProjectionTransformMatrix is used for the projection transformation, rather than computing a transform from internal state.

virtual bool	GetUseExplicitProjectionTransformMatrix ()
	If true, the ExplicitProjectionTransformMatrix is used for the projection transformation, rather than computing a transform from internal state.

virtual void	UseExplicitProjectionTransformMatrixOn ()
	If true, the ExplicitProjectionTransformMatrix is used for the projection transformation, rather than computing a transform from internal state.

virtual void	UseExplicitProjectionTransformMatrixOff ()
	If true, the ExplicitProjectionTransformMatrix is used for the projection transformation, rather than computing a transform from internal state.


virtual void	SetExplicitAspectRatio (double)
	Set/get an explicit aspect to use, rather than computing it from the renderer.

virtual double	GetExplicitAspectRatio ()
	Set/get an explicit aspect to use, rather than computing it from the renderer.


virtual void	SetUseExplicitAspectRatio (bool)
	If true, the ExplicitAspect is used for the projection transformation, rather than computing it from the renderer.

virtual bool	GetUseExplicitAspectRatio ()
	If true, the ExplicitAspect is used for the projection transformation, rather than computing it from the renderer.

virtual void	UseExplicitAspectRatioOn ()
	If true, the ExplicitAspect is used for the projection transformation, rather than computing it from the renderer.

virtual void	UseExplicitAspectRatioOff ()
	If true, the ExplicitAspect is used for the projection transformation, rather than computing it from the renderer.


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.

virtual vtkHomogeneousTransform *	GetUserViewTransform ()
	In addition to the instance variables such as position and orientation, you can add an additional transformation for your own use.


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.

virtual vtkHomogeneousTransform *	GetUserTransform ()
	In addition to the instance variables such as position and orientation, you can add an additional transformation for your own use.


virtual void	UpdateIdealShiftScale (double aspect)
	The following methods are used to support view dependent methods for normalizing data (typically point coordinates).

virtual double *	GetFocalPointShift ()
	The following methods are used to support view dependent methods for normalizing data (typically point coordinates).

virtual void	GetFocalPointShift (double &, double &, double &)
	The following methods are used to support view dependent methods for normalizing data (typically point coordinates).

virtual void	GetFocalPointShift (double[3])
	The following methods are used to support view dependent methods for normalizing data (typically point coordinates).

virtual double	GetFocalPointScale ()
	The following methods are used to support view dependent methods for normalizing data (typically point coordinates).

virtual double *	GetNearPlaneShift ()
	The following methods are used to support view dependent methods for normalizing data (typically point coordinates).

virtual void	GetNearPlaneShift (double &, double &, double &)
	The following methods are used to support view dependent methods for normalizing data (typically point coordinates).

virtual void	GetNearPlaneShift (double[3])
	The following methods are used to support view dependent methods for normalizing data (typically point coordinates).

virtual double	GetNearPlaneScale ()
	The following methods are used to support view dependent methods for normalizing data (typically point coordinates).

virtual void	SetShiftScaleThreshold (double)
	The following methods are used to support view dependent methods for normalizing data (typically point coordinates).

virtual double	GetShiftScaleThreshold ()
	The following methods are used to support view dependent methods for normalizing data (typically point coordinates).


double *	GetOrientation ()
	Get the orientation of the camera.

double *	GetOrientationWXYZ ()
	Get the orientation of the camera.


virtual int	GetStereo ()
	Get the stereo setting.


virtual void	SetLeftEye (int)
	Set the Left Eye setting.

virtual int	GetLeftEye ()
	Set the Left Eye setting.


virtual void	SetFreezeFocalPoint (bool)
	Set/Get the value of the FreezeDolly instance variable.

virtual bool	GetFreezeFocalPoint ()
	Set/Get the value of the FreezeDolly instance variable.


virtual void	SetUseScissor (bool)
	Enable/Disable the scissor.

virtual bool	GetUseScissor ()
	Enable/Disable the scissor.


void	SetScissorRect (vtkRecti scissorRect)
	Set/Get the vtkRect value of the scissor.

void	GetScissorRect (vtkRecti &scissorRect)
	Set/Get the vtkRect value of the scissor.


virtual vtkInformation *	GetInformation ()
	Set/Get the information object associated with this camera.

virtual void	SetInformation (vtkInformation *)
	Set/Get the information object associated with this camera.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

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)

vtkTypeBool	InvokeEvent (unsigned long event)

vtkTypeBool	InvokeEvent (const char *event)

std::string	GetObjectDescription () const override
	The object description printed in messages and PrintSelf output.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

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.

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.

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.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

virtual std::string	GetObjectDescription () const
	The object description printed in messages and PrintSelf output.

virtual vtkTypeBool	IsA (const char *name)
	Return 1 if this class is the same type of (or a subclass of) the named class.

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

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

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

Static Public Member Functions inherited from vtkObject
static vtkObject *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

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.

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

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

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.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkCamera ()

	~vtkCamera () override

virtual void	ComputeProjectionTransform (double aspect, double nearz, double farz)
	These methods should only be used within vtkCamera.cxx.

void	ComputeCompositeProjectionTransform (double aspect, double nearz, double farz)
	These methods should only be used within vtkCamera.cxx.

void	ComputeCameraLightTransform ()

void	ComputeScreenOrientationMatrix ()
	Given screen screen top, bottom left and top right calculate screen orientation.

void	ComputeOffAxisProjectionFrustum ()
	Compute and use frustum using offaxis method.

void	ComputeModelViewMatrix ()
	Compute model view matrix for the camera.

void	PartialCopy (vtkCamera *source)
	Copy the ivars.


void	ComputeDistance ()
	These methods should only be used within vtkCamera.cxx.

virtual void	ComputeViewTransform ()
	These methods should only be used within vtkCamera.cxx.

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.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	RegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check)

virtual void	ReportReferences (vtkGarbageCollector *)

virtual void	ObjectFinalize ()

	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	ScreenCenter [3]

double	OffAxisClippingAdjustment

double	EyeSeparation

vtkMatrix4x4 *	EyeTransformMatrix

vtkMatrix4x4 *	ProjectionPlaneOrientationMatrix

vtkMatrix4x4 *	ModelTransformMatrix

vtkHomogeneousTransform *	UserTransform

vtkHomogeneousTransform *	UserViewTransform

vtkMatrix4x4 *	ExplicitProjectionTransformMatrix

bool	UseExplicitProjectionTransformMatrix

double	ExplicitAspectRatio

bool	UseExplicitAspectRatio

vtkTransform *	ViewTransform

vtkPerspectiveTransform *	ProjectionTransform

vtkPerspectiveTransform *	Transform

vtkTransform *	CameraLightTransform

vtkTransform *	ModelViewTransform

double	FocalDisk

double	FocalDistance

double	FocalPointShift [3]

double	FocalPointScale

double	NearPlaneShift [3]

double	NearPlaneScale

double	ShiftScaleThreshold

vtkCameraCallbackCommand *	UserViewTransformCallbackCommand

vtkTimeStamp	ViewingRaysMTime

bool	FreezeFocalPoint

bool	UseScissor

vtkRecti	ScissorRect

vtkInformation *	Information

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

std::string	ObjectName

Protected Attributes inherited from vtkObjectBase
std::atomic< int32_t >	ReferenceCount

vtkWeakPointerBase **	WeakPointers

Friends
class	vtkCameraCallbackCommand

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()

static vtkReallocingFunction	GetCurrentReallocFunction ()

static vtkFreeingFunction	GetCurrentFreeFunction ()

static vtkFreeingFunction	GetAlternateFreeFunction ()

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)

Online Examples:

VRMLImporterDemo

SolidClip

Spring

VisualizeRectilinearGrid

FlatVersusGouraud

RotationsA

AnnotatedCubeActor

BoxClipUnstructuredGrid

MarchingCases

OrientationMarkerWidget

Tests:: vtkCamera (Tests)

Definition at line 150 of file vtkCamera.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkCamera::Superclass

Definition at line 153 of file vtkCamera.h.

Constructor & Destructor Documentation

◆ vtkCamera()

vtkCamera::vtkCamera ( )

protected

◆ ~vtkCamera()

vtkCamera::~vtkCamera ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

static vtkTypeBool vtkCamera::IsTypeOf ( const char * type )

static

◆ IsA()

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 vtkExternalOpenGLCamera, vtkOpenGLCamera, vtkOpenVRCamera, vtkOpenXRCamera, vtkVRCamera, vtkVRHMDCamera, vtkWebGPUCamera, and vtkZSpaceCamera.

◆ SafeDownCast()

static vtkCamera * vtkCamera::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkCamera::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkExternalOpenGLCamera, vtkOpenGLCamera, vtkOpenVRCamera, vtkOpenXRCamera, vtkVRCamera, vtkVRHMDCamera, vtkWebGPUCamera, and vtkZSpaceCamera.

◆ NewInstance()

vtkCamera * vtkCamera::NewInstance ( ) const

◆ PrintSelf()

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

Reimplemented in vtkExternalOpenGLCamera, vtkOpenGLCamera, vtkVRHMDCamera, vtkWebGPUCamera, and vtkZSpaceCamera.

◆ New()

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

◆ SetPosition() [1/2]

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

◆ SetPosition() [2/2]

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 169 of file vtkCamera.h.

◆ GetPosition() [1/3]

virtual double * vtkCamera::GetPosition ( )

virtual

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

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

◆ GetPosition() [2/3]

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

◆ GetPosition() [3/3]

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

virtual

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

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

◆ SetFocalPoint() [1/2]

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.

◆ SetFocalPoint() [2/2]

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 179 of file vtkCamera.h.

◆ GetFocalPoint() [1/3]

virtual double * vtkCamera::GetFocalPoint ( )

virtual

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

The default focal point is the origin.

◆ GetFocalPoint() [2/3]

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.

◆ GetFocalPoint() [3/3]

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

virtual

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

The default focal point is the origin.

◆ SetViewUp() [1/2]

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

Set/Get the view up direction for the camera.

The default is (0,1,0).

◆ SetViewUp() [2/2]

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 189 of file vtkCamera.h.

◆ GetViewUp() [1/3]

virtual double * vtkCamera::GetViewUp ( )

virtual

Set/Get the view up direction for the camera.

The default is (0,1,0).

◆ GetViewUp() [2/3]

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

virtual

Set/Get the view up direction for the camera.

The default is (0,1,0).

◆ GetViewUp() [3/3]

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

virtual

Set/Get the view up direction for the camera.

The default is (0,1,0).

◆ OrthogonalizeViewUp()

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.

◆ SetDistance()

void vtkCamera::SetDistance ( double )

Move the focal point so that it is the specified distance from the camera position.

This distance must be positive.

◆ GetDistance()

virtual double vtkCamera::GetDistance ( )

virtual

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

This distance is positive.

◆ GetDirectionOfProjection() [1/3]

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.

◆ GetDirectionOfProjection() [2/3]

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.

◆ GetDirectionOfProjection() [3/3]

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.

◆ Dolly()

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.

◆ SetRoll()

void vtkCamera::SetRoll ( double angle )

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

◆ GetRoll()

double vtkCamera::GetRoll ( )

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

◆ Roll()

void vtkCamera::Roll ( double angle )

Rotate the camera about the direction of projection.

This will spin the camera about its axis.

◆ Azimuth()

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.

◆ Yaw()

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.

◆ Elevation()

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.

◆ Pitch()

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.

◆ SetParallelProjection()

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.

◆ GetParallelProjection()

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.

◆ ParallelProjectionOn()

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.

◆ ParallelProjectionOff()

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.

◆ SetUseHorizontalViewAngle()

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.

◆ GetUseHorizontalViewAngle()

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.

◆ UseHorizontalViewAngleOn()

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.

◆ UseHorizontalViewAngleOff()

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.

◆ SetViewAngle()

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.

◆ GetViewAngle()

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.

◆ SetParallelScale()

void vtkCamera::SetParallelScale ( double scale )

Set/Get the scaling used for a parallel projection, i.e.

the half of 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.

◆ GetParallelScale()

virtual double vtkCamera::GetParallelScale ( )

virtual

Set/Get the scaling used for a parallel projection, i.e.

the half of 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.

◆ Zoom()

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.

◆ SetClippingRange() [1/2]

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.

◆ SetClippingRange() [2/2]

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 359 of file vtkCamera.h.

◆ GetClippingRange() [1/3]

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.

◆ GetClippingRange() [2/3]

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.

◆ GetClippingRange() [3/3]

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.

◆ SetThickness()

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.

◆ GetThickness()

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.

◆ SetWindowCenter()

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.

◆ GetWindowCenter() [1/3]

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.

◆ GetWindowCenter() [2/3]

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.

◆ GetWindowCenter() [3/3]

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.

◆ SetObliqueAngles()

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.

◆ ApplyTransform()

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.

◆ GetViewPlaneNormal() [1/3]

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.

◆ GetViewPlaneNormal() [2/3]

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.

◆ GetViewPlaneNormal() [3/3]

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.

◆ SetViewShear() [1/2]

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.

◆ SetViewShear() [2/2]

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.

◆ GetViewShear() [1/3]

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.

◆ GetViewShear() [2/3]

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.

◆ GetViewShear() [3/3]

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.

◆ SetEyeAngle()

virtual void vtkCamera::SetEyeAngle ( double )

virtual

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

This is used when generating stereo images.

◆ GetEyeAngle()

virtual double vtkCamera::GetEyeAngle ( )

virtual

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

This is used when generating stereo images.

◆ SetFocalDisk()

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.

◆ GetFocalDisk()

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.

◆ SetFocalDistance()

virtual void vtkCamera::SetFocalDistance ( double )

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.

◆ GetFocalDistance()

virtual double vtkCamera::GetFocalDistance ( )

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.

◆ SetUseOffAxisProjection()

virtual void vtkCamera::SetUseOffAxisProjection ( vtkTypeBool )

virtual

Set/Get use offaxis frustum.

OffAxis frustum is used for off-axis frustum calculations specifically for head-tracking with stereo rendering. For reference see "Generalized Perspective Projection" by Robert Kooima, 2008.

Note: This setting is ignored when UseExplicitProjectionTransformMatrix is true.

◆ GetUseOffAxisProjection()

virtual vtkTypeBool vtkCamera::GetUseOffAxisProjection ( )

virtual

Set/Get use offaxis frustum.

OffAxis frustum is used for off-axis frustum calculations specifically for head-tracking with stereo rendering. For reference see "Generalized Perspective Projection" by Robert Kooima, 2008.

Note: This setting is ignored when UseExplicitProjectionTransformMatrix is true.

◆ UseOffAxisProjectionOn()

virtual void vtkCamera::UseOffAxisProjectionOn ( )

virtual

Set/Get use offaxis frustum.

OffAxis frustum is used for off-axis frustum calculations specifically for head-tracking with stereo rendering. For reference see "Generalized Perspective Projection" by Robert Kooima, 2008.

Note: This setting is ignored when UseExplicitProjectionTransformMatrix is true.

◆ UseOffAxisProjectionOff()

virtual void vtkCamera::UseOffAxisProjectionOff ( )

virtual

Set/Get use offaxis frustum.

OffAxis frustum is used for off-axis frustum calculations specifically for head-tracking with stereo rendering. For reference see "Generalized Perspective Projection" by Robert Kooima, 2008.

Note: This setting is ignored when UseExplicitProjectionTransformMatrix is true.

◆ GetOffAxisClippingAdjustment()

double vtkCamera::GetOffAxisClippingAdjustment ( )

Get adjustment to clipping thickness, computed by camera based on the physical size of the screen and the direction to the tracked head/eye.

◆ SetScreenBottomLeft() [1/2]

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

◆ SetScreenBottomLeft() [2/2]

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

◆ GetScreenBottomLeft() [1/3]

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

◆ GetScreenBottomLeft() [2/3]

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

◆ GetScreenBottomLeft() [3/3]

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

◆ SetScreenBottomRight() [1/2]

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

◆ SetScreenBottomRight() [2/2]

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

◆ GetScreenBottomRight() [1/3]

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

◆ GetScreenBottomRight() [2/3]

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

◆ GetScreenBottomRight() [3/3]

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

◆ SetScreenTopRight() [1/2]

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

◆ SetScreenTopRight() [2/2]

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

◆ GetScreenTopRight() [1/3]

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

◆ GetScreenTopRight() [2/3]

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

◆ GetScreenTopRight() [3/3]

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

◆ SetEyeSeparation()

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.

◆ GetEyeSeparation()

virtual double vtkCamera::GetEyeSeparation ( )

virtual

Set/Get distance between the eyes.

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

◆ SetEyePosition()

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.

◆ GetEyePosition()

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.

◆ GetStereoEyePosition()

void vtkCamera::GetStereoEyePosition ( double eyePosition[3] )

Using the LeftEye property to determine whether left or right eye is being requested, this method computes and returns the position of the requested eye, taking head orientation and eye separation into account.

The eyePosition parameter is output only, all elements are overwritten.

◆ GetEyePlaneNormal()

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.

◆ SetEyeTransformMatrix() [1/2]

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.

◆ SetEyeTransformMatrix() [2/2]

void vtkCamera::SetEyeTransformMatrix ( const double elements[16] )

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.

◆ GetEyeTransformMatrix()

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.

◆ SetModelTransformMatrix() [1/2]

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.

◆ SetModelTransformMatrix() [2/2]

void vtkCamera::SetModelTransformMatrix ( const double elements[16] )

Set/Get model transformation matrix.

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

◆ GetModelTransformMatrix()

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.

◆ GetModelViewTransformMatrix()

virtual vtkMatrix4x4 * vtkCamera::GetModelViewTransformMatrix ( )

virtual

Return the model view matrix of model view transform.

Reimplemented in vtkZSpaceCamera.

◆ GetModelViewTransformObject()

virtual vtkTransform * vtkCamera::GetModelViewTransformObject ( )

virtual

Return the model view transform.

◆ GetViewTransformMatrix()

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.

◆ GetViewTransformObject()

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.

◆ SetExplicitProjectionTransformMatrix()

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.

◆ GetExplicitProjectionTransformMatrix()

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.

◆ SetUseExplicitProjectionTransformMatrix()

virtual void vtkCamera::SetUseExplicitProjectionTransformMatrix ( bool )

virtual

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

◆ GetUseExplicitProjectionTransformMatrix()

virtual bool vtkCamera::GetUseExplicitProjectionTransformMatrix ( )

virtual

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

◆ UseExplicitProjectionTransformMatrixOn()

virtual void vtkCamera::UseExplicitProjectionTransformMatrixOn ( )

virtual

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

◆ UseExplicitProjectionTransformMatrixOff()

virtual void vtkCamera::UseExplicitProjectionTransformMatrixOff ( )

virtual

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

◆ SetExplicitAspectRatio()

virtual void vtkCamera::SetExplicitAspectRatio ( double )

virtual

Set/get an explicit aspect to use, rather than computing it from the renderer.

Only used when UseExplicitAspect is true.

◆ GetExplicitAspectRatio()

virtual double vtkCamera::GetExplicitAspectRatio ( )

virtual

Set/get an explicit aspect to use, rather than computing it from the renderer.

Only used when UseExplicitAspect is true.

◆ SetUseExplicitAspectRatio()

virtual void vtkCamera::SetUseExplicitAspectRatio ( bool )

virtual

If true, the ExplicitAspect is used for the projection transformation, rather than computing it from the renderer.

Default is false.

◆ GetUseExplicitAspectRatio()

virtual bool vtkCamera::GetUseExplicitAspectRatio ( )

virtual

If true, the ExplicitAspect is used for the projection transformation, rather than computing it from the renderer.

Default is false.

◆ UseExplicitAspectRatioOn()

virtual void vtkCamera::UseExplicitAspectRatioOn ( )

virtual

If true, the ExplicitAspect is used for the projection transformation, rather than computing it from the renderer.

Default is false.

◆ UseExplicitAspectRatioOff()

virtual void vtkCamera::UseExplicitAspectRatioOff ( )

virtual

If true, the ExplicitAspect is used for the projection transformation, rather than computing it from the renderer.

Default is false.

◆ GetProjectionTransformMatrix() [1/2]

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]). aspect is ignored if UseExplicitAspectRatio is true.

See also: ExplicitProjectionTransformMatrix

Reimplemented in vtkZSpaceCamera.

◆ GetProjectionTransformObject()

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]). aspect is ignored if UseExplicitAspectRatio is true.

See also: ExplicitProjectionTransformMatrix

◆ GetCompositeProjectionTransformMatrix()

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]). aspect is ignored if UseExplicitAspectRatio is true.

See also: ExplicitProjectionTransformMatrix

◆ GetProjectionTransformMatrix() [2/2]

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

◆ SetUserViewTransform()

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

◆ GetUserViewTransform()

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

◆ SetUserTransform()

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

◆ GetUserTransform()

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

◆ Render()

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 vtkOpenGLCamera, vtkOpenVRCamera, vtkOpenXRCamera, vtkVRHMDCamera, and vtkWebGPUCamera.

Definition at line 725 of file vtkCamera.h.

◆ GetViewingRaysMTime()

vtkMTimeType vtkCamera::GetViewingRaysMTime ( )

Return the MTime that concerns recomputing the view rays of the camera.

◆ ViewingRaysModified()

void vtkCamera::ViewingRaysModified ( )

Mark that something has changed which requires the view rays to be recomputed.

◆ GetFrustumPlanes()

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. aspect is ignored if UseExplicitAspectRatio is true.