vtkVRCamera Class Reference

VR camera. More...

#include <vtkVRCamera.h>

Inheritance diagram for vtkVRCamera:

Collaboration diagram for vtkVRCamera:

Classes
class	Pose

Public Types
typedef vtkOpenGLCamera	Superclass
Public Types inherited from vtkOpenGLCamera
typedef vtkCamera	Superclass
Public Types inherited from vtkCamera
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.
vtkVRCamera *	NewInstance () const
virtual void	GetPhysicalToProjectionMatrix (vtkMatrix4x4 *&physicalToProjectionMatrix)=0
	Provides a matrix to go from physical coordinates to projection coordinates for the eye currently being rendered.
void	SetPoseFromCamera (Pose *pose, vtkVRRenderWindow *win)
void	ApplyPoseToCamera (Pose *pose, vtkVRRenderWindow *win)
void	SetCameraFromWorldToDeviceMatrix (vtkMatrix4x4 *mat, double distance)
void	SetCameraFromDeviceToWorldMatrix (vtkMatrix4x4 *mat, double distance)
virtual void	SetTrackHMD (bool)
	When enabled the camera will track the HMD position.
virtual bool	GetTrackHMD ()
	When enabled the camera will track the HMD position.
Public Member Functions inherited from vtkOpenGLCamera
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.
vtkOpenGLCamera *	NewInstance () const
void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.
void	Render (vtkRenderer *ren) override
	Implement base class method.
void	UpdateViewport (vtkRenderer *ren) override
virtual void	GetKeyMatrices (vtkRenderer *ren, vtkMatrix4x4 *&WCVCMatrix, vtkMatrix3x3 *&normalMatrix, vtkMatrix4x4 *&VCDCMatrix, vtkMatrix4x4 *&WCDCMatrix)
Public Member Functions inherited from vtkCamera
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 vtkVRCamera *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkOpenGLCamera
static vtkOpenGLCamera *	New ()
static vtkTypeBool	IsTypeOf (const char *type)
static vtkOpenGLCamera *	SafeDownCast (vtkObjectBase *o)
Static Public Member Functions inherited from vtkCamera
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
	vtkVRCamera ()
	~vtkVRCamera () override
Protected Member Functions inherited from vtkOpenGLCamera
virtual vtkObjectBase *	NewInstanceInternal () const
	vtkOpenGLCamera ()
	~vtkOpenGLCamera () override
Protected Member Functions inherited from vtkCamera
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
vtkNew< vtkMatrix4x4 >	TempMatrix4x4
bool	TrackHMD = true
Protected Attributes inherited from vtkOpenGLCamera
vtkMatrix4x4 *	WCDCMatrix
vtkMatrix4x4 *	WCVCMatrix
vtkMatrix3x3 *	NormalMatrix
vtkMatrix4x4 *	VCDCMatrix
vtkTimeStamp	KeyMatrixTime
vtkRenderer *	LastRenderer
Protected Attributes inherited from vtkCamera
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

Additional Inherited Members
Static Protected Member Functions inherited from vtkObjectBase
static vtkMallocingFunction	GetCurrentMallocFunction ()
static vtkReallocingFunction	GetCurrentReallocFunction ()
static vtkFreeingFunction	GetCurrentFreeFunction ()
static vtkFreeingFunction	GetAlternateFreeFunction ()

Detailed Description

VR camera.

vtkVRCamera is a concrete implementation of the abstract class vtkCamera. vtkVRCamera interfaces to the VR rendering library.

Definition at line 22 of file vtkVRCamera.h.

Member Typedef Documentation

Superclass

typedef vtkOpenGLCamera vtkVRCamera::Superclass

Definition at line 25 of file vtkVRCamera.h.

Constructor & Destructor Documentation

vtkVRCamera()

vtkVRCamera::vtkVRCamera ( )

protected

~vtkVRCamera()

vtkVRCamera::~vtkVRCamera ( )

overrideprotected

Member Function Documentation

IsTypeOf()

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

static

IsA()

virtual vtkTypeBool vtkVRCamera::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 vtkOpenGLCamera.

Reimplemented in vtkOpenVRCamera, vtkOpenXRCamera, and vtkVRHMDCamera.

SafeDownCast()

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

static

NewInstanceInternal()

virtual vtkObjectBase * vtkVRCamera::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkOpenGLCamera.

Reimplemented in vtkOpenVRCamera, vtkOpenXRCamera, and vtkVRHMDCamera.

NewInstance()

vtkVRCamera * vtkVRCamera::NewInstance

(

)

const

GetPhysicalToProjectionMatrix()

virtual void vtkVRCamera::GetPhysicalToProjectionMatrix ( vtkMatrix4x4 *&  physicalToProjectionMatrix )

pure virtual

Provides a matrix to go from physical coordinates to projection coordinates for the eye currently being rendered.

Just e.g. LeftEyeToProjection * PhysicalToLeftEye

Implemented in vtkVRHMDCamera.

SetPoseFromCamera()

void vtkVRCamera::SetPoseFromCamera	(	Pose *	pose,
		vtkVRRenderWindow *	win
	)

ApplyPoseToCamera()

void vtkVRCamera::ApplyPoseToCamera	(	Pose *	pose,
		vtkVRRenderWindow *	win
	)

SetCameraFromWorldToDeviceMatrix()

void vtkVRCamera::SetCameraFromWorldToDeviceMatrix	(	vtkMatrix4x4 *	mat,
		double	distance
	)

SetCameraFromDeviceToWorldMatrix()

void vtkVRCamera::SetCameraFromDeviceToWorldMatrix	(	vtkMatrix4x4 *	mat,
		double	distance
	)

SetTrackHMD()

virtual void vtkVRCamera::SetTrackHMD ( bool  )

virtual

When enabled the camera will track the HMD position.

On is the default.

See also

vtkOpenVRRenderWindow::UpdateHMDMatrixPose, vtkOpenXRRenderWindow::UpdateHMDMatrixPose

GetTrackHMD()

virtual bool vtkVRCamera::GetTrackHMD ( )

virtual

When enabled the camera will track the HMD position.

On is the default.

See also

vtkOpenVRRenderWindow::UpdateHMDMatrixPose, vtkOpenXRRenderWindow::UpdateHMDMatrixPose

Member Data Documentation

TempMatrix4x4

vtkNew<vtkMatrix4x4> vtkVRCamera::TempMatrix4x4

protected

Definition at line 89 of file vtkVRCamera.h.

TrackHMD

bool vtkVRCamera::TrackHMD = true

protected

Definition at line 90 of file vtkVRCamera.h.

---

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

• Rendering/VR/vtkVRCamera.h