describes a 4x4 matrix transformation More...

#include <vtkPerspectiveTransform.h>

Inheritance diagram for vtkPerspectiveTransform:

Collaboration diagram for vtkPerspectiveTransform:

Public Types
typedef vtkHomogeneousTransform	Superclass

Public Types inherited from vtkHomogeneousTransform
typedef vtkAbstractTransform	Superclass

Public Types inherited from vtkAbstractTransform
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.

vtkPerspectiveTransform *	NewInstance () const

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

void	Identity ()
	Set this transformation to the identity transformation.

void	Inverse () override
	Invert the transformation.

void	AdjustViewport (double oldXMin, double oldXMax, double oldYMin, double oldYMax, double newXMin, double newXMax, double newYMin, double newYMax)
	Perform an adjustment to the viewport coordinates.

void	AdjustZBuffer (double oldNearZ, double oldFarZ, double newNearZ, double newFarZ)
	Perform an adjustment to the Z-Buffer range that the near and far clipping planes map to.

void	Ortho (double xmin, double xmax, double ymin, double ymax, double znear, double zfar)
	Create an orthogonal projection matrix and concatenate it by the current transformation.

void	Frustum (double xmin, double xmax, double ymin, double ymax, double znear, double zfar)
	Create an perspective projection matrix and concatenate it by the current transformation.

void	Perspective (double angle, double aspect, double znear, double zfar)
	Create a perspective projection matrix by specifying the view angle (this angle is in the y direction), the aspect ratio, and the near and far clipping range.

void	Shear (double dxdz, double dydz, double zplane)
	Create a shear transformation about a plane at distance z from the camera.

void	Stereo (double angle, double focaldistance)
	Create a stereo shear matrix and concatenate it with the current transformation.

void	SetupCamera (const double position[3], const double focalpoint[3], const double viewup[3])
	Set a view transformation matrix for the camera (this matrix does not contain any perspective) and concatenate it with the current transformation.

void	SetupCamera (double p0, double p1, double p2, double fp0, double fp1, double fp2, double vup0, double vup1, double vup2)

void	Concatenate (vtkHomogeneousTransform *transform)
	Concatenate the specified transform with the current transformation according to PreMultiply or PostMultiply semantics.

void	PreMultiply ()
	Sets the internal state of the transform to PreMultiply.

void	PostMultiply ()
	Sets the internal state of the transform to PostMultiply.

int	GetNumberOfConcatenatedTransforms ()
	Get the total number of transformations that are linked into this one via Concatenate() operations or via SetInput().

vtkTypeBool	GetInverseFlag ()
	Get the inverse flag of the transformation.

vtkAbstractTransform *	MakeTransform () override
	Make a new transform of the same type – you are responsible for deleting the transform when you are done with it.

int	CircuitCheck (vtkAbstractTransform *transform) override
	Check for self-reference.

vtkMTimeType	GetMTime () override
	Override GetMTime to account for input and concatenation.


void	Translate (double x, double y, double z)
	Create a translation matrix and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics.

void	Translate (const double x[3])
	Create a translation matrix and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics.

void	Translate (const float x[3])
	Create a translation matrix and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics.


void	RotateWXYZ (double angle, double x, double y, double z)
	Create a rotation matrix and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics.

void	RotateWXYZ (double angle, const double axis[3])
	Create a rotation matrix and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics.

void	RotateWXYZ (double angle, const float axis[3])
	Create a rotation matrix and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics.


void	RotateX (double angle)
	Create a rotation matrix about the X, Y, or Z axis and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics.

void	RotateY (double angle)
	Create a rotation matrix about the X, Y, or Z axis and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics.

void	RotateZ (double angle)
	Create a rotation matrix about the X, Y, or Z axis and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics.


void	Scale (double x, double y, double z)
	Create a scale matrix (i.e.

void	Scale (const double s[3])
	Create a scale matrix (i.e.

void	Scale (const float s[3])
	Create a scale matrix (i.e.


void	SetMatrix (vtkMatrix4x4 *matrix)
	Set the current matrix directly.

void	SetMatrix (const double elements[16])
	Set the current matrix directly.


void	Concatenate (vtkMatrix4x4 *matrix)
	Concatenates the matrix with the current transformation according to PreMultiply or PostMultiply semantics.

void	Concatenate (const double elements[16])
	Concatenates the matrix with the current transformation according to PreMultiply or PostMultiply semantics.


vtkHomogeneousTransform *	GetConcatenatedTransform (int i)
	Get one of the concatenated transformations as a vtkAbstractTransform.


void	SetInput (vtkHomogeneousTransform *input)
	Set the input for this transformation.

vtkHomogeneousTransform *	GetInput ()
	Set the input for this transformation.


void	Push ()
	Pushes the current transformation onto the transformation stack.


void	Pop ()
	Deletes the transformation on the top of the stack and sets the top to the next transformation on the stack.

Public Member Functions inherited from vtkHomogeneousTransform
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkHomogeneousTransform *	NewInstance () const

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

void	TransformPoints (vtkPoints inPts, vtkPoints outPts) override
	Apply the transformation to a series of points, and append the results to outPts.

void	TransformPointsNormalsVectors (vtkPoints inPts, vtkPoints outPts, vtkDataArray inNms, vtkDataArray outNms, vtkDataArray inVrs, vtkDataArray outVrs, int nOptionalVectors=0, vtkDataArray inVrsArr=nullptr, vtkDataArray outVrsArr=nullptr) override
	Apply the transformation to a combination of points, normals and vectors.

void	GetMatrix (vtkMatrix4x4 *m)
	Get a copy of the internal transformation matrix.

vtkMatrix4x4 *	GetMatrix ()
	Get a pointer to an internal vtkMatrix4x4 that represents the transformation.

vtkHomogeneousTransform *	GetHomogeneousInverse ()
	Just like GetInverse(), but includes typecast to vtkHomogeneousTransform.

void	InternalTransformPoint (const float in[3], float out[3]) override
	This will calculate the transformation without calling Update.

void	InternalTransformPoint (const double in[3], double out[3]) override
	This will calculate the transformation without calling Update.

void	InternalTransformDerivative (const float in[3], float out[3], float derivative[3][3]) override
	This will calculate the transformation as well as its derivative without calling Update.

void	InternalTransformDerivative (const double in[3], double out[3], double derivative[3][3]) override
	This will calculate the transformation as well as its derivative without calling Update.

Public Member Functions inherited from vtkAbstractTransform
virtual vtkTypeBool	IsA (const char *type)
	Return 1 if this class is the same type of (or a subclass of) the named class.

vtkAbstractTransform *	NewInstance () const

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

void	TransformPoint (const float in[3], float out[3])
	Apply the transformation to a coordinate.

void	TransformPoint (const double in[3], double out[3])
	Apply the transformation to a double-precision coordinate.

double *	TransformPoint (double x, double y, double z)
	Apply the transformation to a double-precision coordinate.

double *	TransformPoint (const double point[3])

double *	TransformNormalAtPoint (const double point[3], const double normal[3])

double *	TransformVectorAtPoint (const double point[3], const double vector[3])

virtual void	TransformPoints (vtkPoints inPts, vtkPoints outPts)
	Apply the transformation to a series of points, and append the results to outPts.

virtual void	TransformPointsNormalsVectors (vtkPoints inPts, vtkPoints outPts, vtkDataArray inNms, vtkDataArray outNms, vtkDataArray inVrs, vtkDataArray outVrs, int nOptionalVectors=0, vtkDataArray inVrsArr=nullptr, vtkDataArray outVrsArr=nullptr)
	Apply the transformation to a combination of points, normals and vectors.

vtkAbstractTransform *	GetInverse ()
	Get the inverse of this transform.

void	SetInverse (vtkAbstractTransform *transform)
	Set a transformation that this transform will be the inverse of.

virtual void	Inverse ()=0
	Invert the transformation.

void	DeepCopy (vtkAbstractTransform *)
	Copy this transform from another of the same type.

void	Update ()
	Update the transform to account for any changes which have been made.

virtual vtkAbstractTransform *	MakeTransform ()=0
	Make another transform of the same type.

virtual int	CircuitCheck (vtkAbstractTransform *transform)
	Check for self-reference.

vtkMTimeType	GetMTime () override
	Override GetMTime necessary because of inverse transforms.

void	Modified () override
	Override Modified to avoid ModifiedEvent during update.

void	UnRegister (vtkObjectBase *O) override
	Needs a special UnRegister() implementation to avoid circular references.

float *	TransformFloatPoint (float x, float y, float z)
	Apply the transformation to an (x,y,z) coordinate.

float *	TransformFloatPoint (const float point[3])
	Apply the transformation to an (x,y,z) coordinate.

double *	TransformDoublePoint (double x, double y, double z)
	Apply the transformation to a double-precision (x,y,z) coordinate.

double *	TransformDoublePoint (const double point[3])
	Apply the transformation to a double-precision (x,y,z) coordinate.

void	TransformNormalAtPoint (const float point[3], const float in[3], float out[3])
	Apply the transformation to a normal at the specified vertex.

void	TransformNormalAtPoint (const double point[3], const double in[3], double out[3])
	Apply the transformation to a normal at the specified vertex.

double *	TransformDoubleNormalAtPoint (const double point[3], const double normal[3])
	Apply the transformation to a double-precision normal at the specified vertex.

float *	TransformFloatNormalAtPoint (const float point[3], const float normal[3])
	Apply the transformation to a single-precision normal at the specified vertex.

void	TransformVectorAtPoint (const float point[3], const float in[3], float out[3])
	Apply the transformation to a vector at the specified vertex.

void	TransformVectorAtPoint (const double point[3], const double in[3], double out[3])
	Apply the transformation to a vector at the specified vertex.

double *	TransformDoubleVectorAtPoint (const double point[3], const double vector[3])
	Apply the transformation to a double-precision vector at the specified vertex.

float *	TransformFloatVectorAtPoint (const float point[3], const float vector[3])
	Apply the transformation to a single-precision vector at the specified vertex.

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 vtkPerspectiveTransform *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkPerspectiveTransform *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkHomogeneousTransform
static vtkTypeBool	IsTypeOf (const char *type)

static vtkHomogeneousTransform *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkAbstractTransform
static vtkTypeBool	IsTypeOf (const char *type)

static vtkAbstractTransform *	SafeDownCast (vtkObjectBase *o)

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

	vtkPerspectiveTransform ()

	~vtkPerspectiveTransform () override

void	InternalDeepCopy (vtkAbstractTransform *t) override
	Perform any subclass-specific DeepCopy.

void	InternalUpdate () override
	Perform any subclass-specific Update.

Protected Member Functions inherited from vtkHomogeneousTransform
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkHomogeneousTransform ()

	~vtkHomogeneousTransform () override

void	InternalDeepCopy (vtkAbstractTransform *transform) override
	Perform any subclass-specific DeepCopy.

Protected Member Functions inherited from vtkAbstractTransform
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkAbstractTransform ()

	~vtkAbstractTransform () override

virtual void	InternalUpdate ()
	Perform any subclass-specific Update.

virtual void	InternalDeepCopy (vtkAbstractTransform *)
	Perform any subclass-specific DeepCopy.

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
vtkHomogeneousTransform *	Input

vtkTransformConcatenation *	Concatenation

vtkTransformConcatenationStack *	Stack

Protected Attributes inherited from vtkHomogeneousTransform
vtkMatrix4x4 *	Matrix

Protected Attributes inherited from vtkAbstractTransform
float	InternalFloatPoint [3]

double	InternalDoublePoint [3]

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

describes a 4x4 matrix transformation

A vtkPerspectiveTransform can be used to describe the full range of homogeneous transformations. It was designed in particular to describe a camera-view of a scene.

The order in which you set up the display coordinates (via AdjustZBuffer() and AdjustViewport()), the projection (via Perspective(), Frustum(), or Ortho()) and the camera view (via SetupCamera()) are important. If the transform is in PreMultiply mode, which is the default, set the Viewport and ZBuffer first, then the projection, and finally the camera view. Once the view is set up, the Translate and Rotate methods can be used to move the camera around in world coordinates. If the Oblique() or Stereo() methods are used, they should be called just before SetupCamera().

In PostMultiply mode, you must perform all transformations in the opposite order. This is necessary, for example, if you already have a perspective transformation set up but must adjust the viewport. Another example is if you have a view transformation, and wish to perform translations and rotations in the camera's coordinate system rather than in world coordinates.

The SetInput and Concatenate methods can be used to create a transformation pipeline with vtkPerspectiveTransform. See vtkTransform for more information on the transformation pipeline.

See also: vtkGeneralTransform vtkTransform vtkMatrix4x4 vtkCamera

Online Examples:

PerspectiveTransform

Tests:: vtkPerspectiveTransform (Tests)

Definition at line 64 of file vtkPerspectiveTransform.h.

Member Typedef Documentation

◆ Superclass

typedef vtkHomogeneousTransform vtkPerspectiveTransform::Superclass

Definition at line 68 of file vtkPerspectiveTransform.h.

Constructor & Destructor Documentation

◆ vtkPerspectiveTransform()

vtkPerspectiveTransform::vtkPerspectiveTransform ( )

protected

◆ ~vtkPerspectiveTransform()

vtkPerspectiveTransform::~vtkPerspectiveTransform ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkPerspectiveTransform * vtkPerspectiveTransform::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkPerspectiveTransform::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 vtkHomogeneousTransform.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkPerspectiveTransform::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkHomogeneousTransform.

◆ NewInstance()

vtkPerspectiveTransform * vtkPerspectiveTransform::NewInstance ( ) const

◆ PrintSelf()

void vtkPerspectiveTransform::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 vtkHomogeneousTransform.

◆ Identity()

void vtkPerspectiveTransform::Identity ( )

inline

Set this transformation to the identity transformation.

If the transform has an Input, then the transformation will be reset so that it is the same as the Input.

Definition at line 76 of file vtkPerspectiveTransform.h.

◆ Inverse()

void vtkPerspectiveTransform::Inverse ( )

inlineoverridevirtual

Invert the transformation.

This will also set a flag so that the transformation will use the inverse of its Input, if an Input has been set.

Implements vtkAbstractTransform.

Definition at line 87 of file vtkPerspectiveTransform.h.

◆ AdjustViewport()

void vtkPerspectiveTransform::AdjustViewport	(	double	oldXMin,
		double	oldXMax,
		double	oldYMin,
		double	oldYMax,
		double	newXMin,
		double	newXMax,
		double	newYMin,
		double	newYMax
	)

Perform an adjustment to the viewport coordinates.

By default Ortho, Frustum, and Perspective provide a window of ([-1,+1],[-1,+1]). In PreMultiply mode, you call this method before calling Ortho, Frustum, or Perspective. In PostMultiply mode you can call it after. Note that if you must apply both AdjustZBuffer and AdjustViewport, it makes no difference which order you apply them in.

◆ AdjustZBuffer()

void vtkPerspectiveTransform::AdjustZBuffer	(	double	oldNearZ,
		double	oldFarZ,
		double	newNearZ,
		double	newFarZ
	)

Perform an adjustment to the Z-Buffer range that the near and far clipping planes map to.

By default Ortho, Frustum, and Perspective map the near clipping plane to -1 and the far clipping plane to +1. In PreMultiply mode, you call this method before calling Ortho, Frustum, or Perspective. In PostMultiply mode you can call it after.

◆ Ortho()

void vtkPerspectiveTransform::Ortho	(	double	xmin,
		double	xmax,
		double	ymin,
		double	ymax,
		double	znear,
		double	zfar
	)

Create an orthogonal projection matrix and concatenate it by the current transformation.

The matrix maps [xmin,xmax], [ymin,ymax], [-znear,-zfar] to [-1,+1], [-1,+1], [+1,-1].

◆ Frustum()

void vtkPerspectiveTransform::Frustum	(	double	xmin,
		double	xmax,
		double	ymin,
		double	ymax,
		double	znear,
		double	zfar
	)

Create an perspective projection matrix and concatenate it by the current transformation.

The matrix maps a frustum with a back plane at -zfar and a front plane at -znear with extent [xmin,xmax],[ymin,ymax] to [-1,+1], [-1,+1], [+1,-1].

◆ Perspective()

void vtkPerspectiveTransform::Perspective	(	double	angle,
		double	aspect,
		double	znear,
		double	zfar
	)

Create a perspective projection matrix by specifying the view angle (this angle is in the y direction), the aspect ratio, and the near and far clipping range.

The projection matrix is concatenated with the current transformation. This method works via Frustum.

◆ Shear()

void vtkPerspectiveTransform::Shear	(	double	dxdz,
		double	dydz,
		double	zplane
	)

Create a shear transformation about a plane at distance z from the camera.

The values dxdz (i.e. dx/dz) and dydz specify the amount of shear in the x and y directions. The 'zplane' specifies the distance from the camera to the plane at which the shear causes zero displacement. Generally you want this plane to be the focal plane. This transformation can be used in combination with Ortho to create an oblique projection. It can also be used in combination with Perspective to provide correct stereo views when the eye is at arbitrary but known positions relative to the center of a flat viewing screen.

◆ Stereo()

void vtkPerspectiveTransform::Stereo	(	double	angle,
		double	focaldistance
	)

Create a stereo shear matrix and concatenate it with the current transformation.

This can be applied in conjunction with either a perspective transformation (via Frustum or Projection) or an orthographic projection. You must specify the distance from the camera plane to the focal plane, and the angle between the distance vector and the eye. The angle should be negative for the left eye, and positive for the right. This method works via Oblique.

◆ SetupCamera() [1/2]

void vtkPerspectiveTransform::SetupCamera	(	const double	position[3],
		const double	focalpoint[3],
		const double	viewup[3]
	)

Set a view transformation matrix for the camera (this matrix does not contain any perspective) and concatenate it with the current transformation.

◆ SetupCamera() [2/2]

void vtkPerspectiveTransform::SetupCamera	(	double	p0,
		double	p1,
		double	p2,
		double	fp0,
		double	fp1,
		double	fp2,
		double	vup0,
		double	vup1,
		double	vup2
	)

◆ Translate() [1/3]

void vtkPerspectiveTransform::Translate	(	double	x,
		double	y,
		double	z
	)

inline

Create a translation matrix and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics.

Definition at line 178 of file vtkPerspectiveTransform.h.

◆ Translate() [2/3]

void vtkPerspectiveTransform::Translate ( const double x[3] )

inline

Create a translation matrix and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics.

Definition at line 179 of file vtkPerspectiveTransform.h.

◆ Translate() [3/3]

void vtkPerspectiveTransform::Translate ( const float x[3] )

inline

Create a translation matrix and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics.

Definition at line 180 of file vtkPerspectiveTransform.h.

◆ RotateWXYZ() [1/3]

void vtkPerspectiveTransform::RotateWXYZ	(	double	angle,
		double	x,
		double	y,
		double	z
	)

inline

Create a rotation matrix and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics.

The angle is in degrees, and (x,y,z) specifies the axis that the rotation will be performed around.

Definition at line 190 of file vtkPerspectiveTransform.h.

◆ RotateWXYZ() [2/3]

void vtkPerspectiveTransform::RotateWXYZ	(	double	angle,
		const double	axis[3]
	)

inline

Create a rotation matrix and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics.

The angle is in degrees, and (x,y,z) specifies the axis that the rotation will be performed around.

Definition at line 194 of file vtkPerspectiveTransform.h.

◆ RotateWXYZ() [3/3]

void vtkPerspectiveTransform::RotateWXYZ	(	double	angle,
		const float	axis[3]
	)

inline

Create a rotation matrix and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics.

The angle is in degrees, and (x,y,z) specifies the axis that the rotation will be performed around.

Definition at line 198 of file vtkPerspectiveTransform.h.

◆ RotateX()

void vtkPerspectiveTransform::RotateX ( double angle )

inline

Create a rotation matrix about the X, Y, or Z axis and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics.

The angle is expressed in degrees.

Definition at line 210 of file vtkPerspectiveTransform.h.

◆ RotateY()

void vtkPerspectiveTransform::RotateY ( double angle )

inline

Create a rotation matrix about the X, Y, or Z axis and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics.

The angle is expressed in degrees.

Definition at line 211 of file vtkPerspectiveTransform.h.

◆ RotateZ()

void vtkPerspectiveTransform::RotateZ ( double angle )

inline

Create a rotation matrix about the X, Y, or Z axis and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics.

The angle is expressed in degrees.

Definition at line 212 of file vtkPerspectiveTransform.h.

◆ Scale() [1/3]

void vtkPerspectiveTransform::Scale	(	double	x,
		double	y,
		double	z
	)

inline

Create a scale matrix (i.e.

set the diagonal elements to x, y, z) and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics.

Definition at line 221 of file vtkPerspectiveTransform.h.

◆ Scale() [2/3]

void vtkPerspectiveTransform::Scale ( const double s[3] )

inline

Create a scale matrix (i.e.

set the diagonal elements to x, y, z) and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics.

Definition at line 222 of file vtkPerspectiveTransform.h.

◆ Scale() [3/3]

void vtkPerspectiveTransform::Scale ( const float s[3] )

inline

Create a scale matrix (i.e.

set the diagonal elements to x, y, z) and concatenate it with the current transformation according to PreMultiply or PostMultiply semantics.

Definition at line 223 of file vtkPerspectiveTransform.h.

◆ SetMatrix() [1/2]

void vtkPerspectiveTransform::SetMatrix ( vtkMatrix4x4 * matrix )

inline

Set the current matrix directly.

This actually calls Identity(), followed by Concatenate(matrix).

Definition at line 231 of file vtkPerspectiveTransform.h.

◆ SetMatrix() [2/2]

void vtkPerspectiveTransform::SetMatrix ( const double elements[16] )

inline

Set the current matrix directly.

This actually calls Identity(), followed by Concatenate(matrix).

Definition at line 232 of file vtkPerspectiveTransform.h.

◆ Concatenate() [1/3]

void vtkPerspectiveTransform::Concatenate ( vtkMatrix4x4 * matrix )

inline

Concatenates the matrix with the current transformation according to PreMultiply or PostMultiply semantics.

Definition at line 244 of file vtkPerspectiveTransform.h.

◆ Concatenate() [2/3]

void vtkPerspectiveTransform::Concatenate ( const double elements[16] )

inline

Concatenates the matrix with the current transformation according to PreMultiply or PostMultiply semantics.

Definition at line 245 of file vtkPerspectiveTransform.h.

◆ Concatenate() [3/3]

void vtkPerspectiveTransform::Concatenate ( vtkHomogeneousTransform * transform )

Concatenate the specified transform with the current transformation according to PreMultiply or PostMultiply semantics.

The concatenation is pipelined, meaning that if any of the transformations are changed, even after Concatenate() is called, those changes will be reflected when you call TransformPoint().

◆ PreMultiply()

void vtkPerspectiveTransform::PreMultiply ( )

inline

Sets the internal state of the transform to PreMultiply.

All subsequent operations will occur before those already represented in the current transformation. In homogeneous matrix notation, M = M*A where M is the current transformation matrix and A is the applied matrix. The default is PreMultiply.

Definition at line 264 of file vtkPerspectiveTransform.h.

◆ PostMultiply()

void vtkPerspectiveTransform::PostMultiply ( )

inline

Sets the internal state of the transform to PostMultiply.

All subsequent operations will occur after those already represented in the current transformation. In homogeneous matrix notation, M = A*M where M is the current transformation matrix and A is the applied matrix. The default is PreMultiply.

Definition at line 281 of file vtkPerspectiveTransform.h.

◆ GetNumberOfConcatenatedTransforms()

int vtkPerspectiveTransform::GetNumberOfConcatenatedTransforms ( )

inline

Get the total number of transformations that are linked into this one via Concatenate() operations or via SetInput().

Definition at line 295 of file vtkPerspectiveTransform.h.

◆ GetConcatenatedTransform()

vtkHomogeneousTransform * vtkPerspectiveTransform::GetConcatenatedTransform ( int i )

inline

Get one of the concatenated transformations as a vtkAbstractTransform.

These transformations are applied, in series, every time the transformation of a coordinate occurs. This method is provided to make it possible to decompose a transformation into its constituents, for example to save a transformation to a file.

Definition at line 308 of file vtkPerspectiveTransform.h.

◆ SetInput()

void vtkPerspectiveTransform::SetInput ( vtkHomogeneousTransform * input )

Set the input for this transformation.

This will be used as the base transformation if it is set. This method allows you to build a transform pipeline: if the input is modified, then this transformation will automatically update accordingly. Note that the InverseFlag, controlled via Inverse(), determines whether this transformation will use the Input or the inverse of the Input.

◆ GetInput()

vtkHomogeneousTransform * vtkPerspectiveTransform::GetInput ( )

inline

Set the input for this transformation.

This will be used as the base transformation if it is set. This method allows you to build a transform pipeline: if the input is modified, then this transformation will automatically update accordingly. Note that the InverseFlag, controlled via Inverse(), determines whether this transformation will use the Input or the inverse of the Input.

Definition at line 345 of file vtkPerspectiveTransform.h.

◆ GetInverseFlag()

vtkTypeBool vtkPerspectiveTransform::GetInverseFlag ( )

inline

Get the inverse flag of the transformation.

This controls whether it is the Input or the inverse of the Input that is used as the base transformation. The InverseFlag is flipped every time Inverse() is called. The InverseFlag is off when a transform is first created.

Definition at line 355 of file vtkPerspectiveTransform.h.

◆ Push()

void vtkPerspectiveTransform::Push ( )

inline

Pushes the current transformation onto the transformation stack.

Definition at line 361 of file vtkPerspectiveTransform.h.

◆ Pop()

void vtkPerspectiveTransform::Pop ( )

inline

Deletes the transformation on the top of the stack and sets the top to the next transformation on the stack.

Definition at line 377 of file vtkPerspectiveTransform.h.

◆ MakeTransform()

vtkAbstractTransform * vtkPerspectiveTransform::MakeTransform ( )

overridevirtual

Make a new transform of the same type – you are responsible for deleting the transform when you are done with it.

Implements vtkAbstractTransform.

◆ CircuitCheck()

int vtkPerspectiveTransform::CircuitCheck ( vtkAbstractTransform * transform )

overridevirtual

Check for self-reference.

Will return true if concatenating with the specified transform, setting it to be our inverse, or setting it to be our input will create a circular reference. CircuitCheck is automatically called by SetInput(), SetInverse(), and Concatenate(vtkXTransform *). Avoid using this function, it is experimental.

Reimplemented from vtkAbstractTransform.

◆ GetMTime()

vtkMTimeType vtkPerspectiveTransform::GetMTime ( )

overridevirtual

Override GetMTime to account for input and concatenation.

Reimplemented from vtkAbstractTransform.

◆ InternalDeepCopy()

void vtkPerspectiveTransform::InternalDeepCopy ( vtkAbstractTransform * )

overrideprotectedvirtual

Perform any subclass-specific DeepCopy.

Reimplemented from vtkHomogeneousTransform.

◆ InternalUpdate()

void vtkPerspectiveTransform::InternalUpdate ( )

overrideprotectedvirtual

Perform any subclass-specific Update.

Reimplemented from vtkAbstractTransform.

Member Data Documentation

◆ Input

vtkHomogeneousTransform* vtkPerspectiveTransform::Input

protected

Definition at line 416 of file vtkPerspectiveTransform.h.

◆ Concatenation

vtkTransformConcatenation* vtkPerspectiveTransform::Concatenation

protected

Definition at line 417 of file vtkPerspectiveTransform.h.

◆ Stack

vtkTransformConcatenationStack* vtkPerspectiveTransform::Stack

protected

Definition at line 418 of file vtkPerspectiveTransform.h.

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

Common/Transforms/vtkPerspectiveTransform.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkPerspectiveTransform()

◆ ~vtkPerspectiveTransform()

Member Function Documentation

◆ New()

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ Identity()

◆ Inverse()

◆ AdjustViewport()

◆ AdjustZBuffer()

◆ Ortho()

◆ Frustum()

◆ Perspective()

◆ Shear()

◆ Stereo()

◆ SetupCamera() [1/2]

◆ SetupCamera() [2/2]

◆ Translate() [1/3]

◆ Translate() [2/3]

◆ Translate() [3/3]

◆ RotateWXYZ() [1/3]

◆ RotateWXYZ() [2/3]

◆ RotateWXYZ() [3/3]

◆ RotateX()

◆ RotateY()

◆ RotateZ()

◆ Scale() [1/3]

◆ Scale() [2/3]

◆ Scale() [3/3]

◆ SetMatrix() [1/2]

◆ SetMatrix() [2/2]

◆ Concatenate() [1/3]

◆ Concatenate() [2/3]

◆ Concatenate() [3/3]

◆ PreMultiply()

◆ PostMultiply()

◆ GetNumberOfConcatenatedTransforms()

◆ GetConcatenatedTransform()

◆ SetInput()

◆ GetInput()

◆ GetInverseFlag()

◆ Push()

◆ Pop()

◆ MakeTransform()

◆ CircuitCheck()

◆ GetMTime()

◆ InternalDeepCopy()

◆ InternalUpdate()

Member Data Documentation

◆ Input

◆ Concatenation

◆ Stack