abstract specification for Viewports More...

#include <vtkViewport.h>

Inheritance diagram for vtkViewport:

Collaboration diagram for vtkViewport:

Public Types
typedef vtkObject	Superclass

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

vtkViewport *	NewInstance () const

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

void	AddViewProp (vtkProp *)
	Add a prop to the list of props. More...

vtkPropCollection *	GetViewProps ()
	Return any props in this viewport. More...

int	HasViewProp (vtkProp *)
	Query if a prop is in the list of props. More...

void	RemoveViewProp (vtkProp *)
	Remove a prop from the list of props. More...

void	RemoveAllViewProps (void)
	Remove all props from the list of props. More...

void	AddActor2D (vtkProp *p)
	Add/Remove different types of props to the renderer. More...

void	RemoveActor2D (vtkProp *p)

vtkActor2DCollection *	GetActors2D ()

virtual void	SetBackground (double, double, double)
	Set/Get the background color of the rendering screen using an rgb color specification. More...

virtual void	SetBackground (double[3])

virtual double *	GetBackground ()

virtual void	GetBackground (double &, double &, double &)

virtual void	GetBackground (double[3])

virtual void	SetBackground2 (double, double, double)
	Set/Get the second background color of the rendering screen for gradient backgrounds using an rgb color specification. More...

virtual void	SetBackground2 (double[3])

virtual double *	GetBackground2 ()

virtual void	GetBackground2 (double &, double &, double &)

virtual void	GetBackground2 (double[3])

virtual void	SetBackgroundAlpha (double)
	Set/Get the alpha value used to fill the background with. More...

virtual double	GetBackgroundAlpha ()

virtual void	SetGradientBackground (bool)
	Set/Get whether this viewport should have a gradient background using the Background (bottom) and Background2 (top) colors. More...

virtual bool	GetGradientBackground ()

virtual void	GradientBackgroundOn ()

virtual void	GradientBackgroundOff ()

virtual void	SetAspect (double, double)
	Set the aspect ratio of the rendered image. More...

void	SetAspect (double[2])

virtual double *	GetAspect ()

virtual void	GetAspect (double data[2])

virtual void	ComputeAspect ()

virtual void	SetPixelAspect (double, double)
	Set the aspect ratio of a pixel in the rendered image. More...

void	SetPixelAspect (double[2])

virtual double *	GetPixelAspect ()

virtual void	GetPixelAspect (double data[2])

virtual void	SetViewport (double, double, double, double)
	Specify the viewport for the Viewport to draw in the rendering window. More...

virtual void	SetViewport (double[4])

virtual double *	GetViewport ()

virtual void	GetViewport (double data[4])

virtual void	SetDisplayPoint (double, double, double)
	Set/get a point location in display (or screen) coordinates. More...

virtual void	SetDisplayPoint (double[3])

virtual double *	GetDisplayPoint ()

virtual void	GetDisplayPoint (double data[3])

virtual void	SetViewPoint (double, double, double)
	Specify a point location in view coordinates. More...

virtual void	SetViewPoint (double[3])

virtual double *	GetViewPoint ()

virtual void	GetViewPoint (double data[3])

virtual void	SetWorldPoint (double, double, double, double)
	Specify a point location in world coordinates. More...

virtual void	SetWorldPoint (double[4])

virtual double *	GetWorldPoint ()

virtual void	GetWorldPoint (double data[4])

virtual double *	GetCenter ()
	Return the center of this viewport in display coordinates. More...

virtual int	IsInViewport (int x, int y)
	Is a given display point in this Viewport's viewport. More...

virtual vtkWindow *	GetVTKWindow ()=0
	Return the vtkWindow that owns this vtkViewport. More...

virtual void	DisplayToView ()
	Convert display coordinates to view coordinates. More...

virtual void	ViewToDisplay ()
	Convert view coordinates to display coordinates. More...

virtual void	WorldToView ()
	Convert world point coordinates to view coordinates. More...

virtual void	ViewToWorld ()
	Convert view point coordinates to world coordinates. More...

void	DisplayToWorld ()
	Convert display (or screen) coordinates to world coordinates. More...

void	WorldToDisplay ()
	Convert world point coordinates to display (or screen) coordinates. More...

virtual void	LocalDisplayToDisplay (double &x, double &y)
	These methods map from one coordinate system to another. More...

virtual void	DisplayToNormalizedDisplay (double &u, double &v)

virtual void	NormalizedDisplayToViewport (double &x, double &y)

virtual void	ViewportToNormalizedViewport (double &u, double &v)

virtual void	NormalizedViewportToView (double &x, double &y, double &z)

virtual void	ViewToPose (double &, double &, double &)

virtual void	PoseToWorld (double &, double &, double &)

virtual void	DisplayToLocalDisplay (double &x, double &y)

virtual void	NormalizedDisplayToDisplay (double &u, double &v)

virtual void	ViewportToNormalizedDisplay (double &x, double &y)

virtual void	NormalizedViewportToViewport (double &u, double &v)

virtual void	ViewToNormalizedViewport (double &x, double &y, double &z)

virtual void	PoseToView (double &, double &, double &)

virtual void	WorldToPose (double &, double &, double &)

virtual void	ViewToWorld (double &, double &, double &)

virtual void	WorldToView (double &, double &, double &)

virtual int *	GetSize ()
	Get the size and origin of the viewport in display coordinates. More...

virtual int *	GetOrigin ()

void	GetTiledSize (int width, int height)

virtual void	GetTiledSizeAndOrigin (int width, int height, int lowerLeftX, int lowerLeftY)

virtual vtkAssemblyPath *	PickProp (double selectionX, double selectionY)=0
	Return the Prop that has the highest z value at the given x, y position in the viewport. More...

virtual vtkAssemblyPath *	PickProp (double selectionX1, double selectionY1, double selectionX2, double selectionY2)=0
	Return the Prop that has the highest z value at the given x1, y1 and x2,y2 positions in the viewport. More...

vtkAssemblyPath *	PickPropFrom (double selectionX, double selectionY, vtkPropCollection *)
	Same as PickProp with two arguments, but selects from the given collection of Props instead of the Renderers props. More...

vtkAssemblyPath *	PickPropFrom (double selectionX1, double selectionY1, double selectionX2, double selectionY2, vtkPropCollection *)
	Same as PickProp with four arguments, but selects from the given collection of Props instead of the Renderers props. More...

double	GetPickX () const
	Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY). More...

double	GetPickY () const

double	GetPickWidth () const

double	GetPickHeight () const

double	GetPickX1 () const

double	GetPickY1 () const

double	GetPickX2 () const

double	GetPickY2 () const

virtual vtkPropCollection *	GetPickResultProps ()

virtual double	GetPickedZ ()
	Return the Z value for the last picked Prop. More...

virtual void	SetEnvironmentalBG (double, double, double)
	Set/Get the constant environmental color using an rgb color specification. More...

virtual void	SetEnvironmentalBG (double[3])

virtual double *	GetEnvironmentalBG ()

virtual void	GetEnvironmentalBG (double &, double &, double &)

virtual void	GetEnvironmentalBG (double[3])

virtual void	SetEnvironmentalBG2 (double, double, double)
	Set/Get the second environmental gradient color using an rgb color specification. More...

virtual void	SetEnvironmentalBG2 (double[3])

virtual double *	GetEnvironmentalBG2 ()

virtual void	GetEnvironmentalBG2 (double &, double &, double &)

virtual void	GetEnvironmentalBG2 (double[3])

virtual void	SetGradientEnvironmentalBG (bool)
	Set/Get whether this viewport should enable the gradient environment using the EnvironmentalBG (bottom) and EnvironmentalBG2 (top) colors. More...

virtual bool	GetGradientEnvironmentalBG ()

virtual void	GradientEnvironmentalBGOn ()

virtual void	GradientEnvironmentalBGOff ()

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

virtual void	DebugOn ()
	Turn debugging output on. More...

virtual void	DebugOff ()
	Turn debugging output off. More...

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

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

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

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

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

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)

vtkCommand *	GetCommand (unsigned long tag)

void	RemoveObserver (vtkCommand *)

void	RemoveObservers (unsigned long event, vtkCommand *)

void	RemoveObservers (const char event, vtkCommand )

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)

vtkTypeBool	HasObserver (const char event, vtkCommand )

void	RemoveObserver (unsigned long tag)

void	RemoveObservers (unsigned long event)

void	RemoveObservers (const char *event)

void	RemoveAllObservers ()

vtkTypeBool	HasObserver (unsigned long event)

vtkTypeBool	HasObserver (const char *event)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
	Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, void(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)

template<class U , class T >
unsigned long	AddObserver (unsigned long event, U observer, bool(T::callback)(vtkObject , unsigned long, void *), float priority=0.0f)
	Allow user to set the AbortFlagOn() with the return value of the callback method. More...

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

int	InvokeEvent (const char event, void callData)

int	InvokeEvent (unsigned long event)

int	InvokeEvent (const char *event)

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

virtual vtkIdType	GetNumberOfGenerationsFromBase (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

virtual void	Delete ()
	Delete a VTK object. More...

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

void	InitializeObjectBase ()

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

virtual void	PrintHeader (ostream &os, vtkIndent indent)

virtual void	PrintTrailer (ostream &os, vtkIndent indent)

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

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

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

void	SetReferenceCount (int)
	Sets the reference count. More...

void	PrintRevisions (ostream &)
	Legacy. More...

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

static vtkViewport *	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. More...

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

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

static void	GlobalWarningDisplayOn ()

static void	GlobalWarningDisplayOff ()

static int	GetGlobalWarningDisplay ()

Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool	IsTypeOf (const char *name)
	Return 1 if this class type is the same type of (or a subclass of) the named class. More...

static vtkIdType	GetNumberOfGenerationsFromBaseType (const char *name)
	Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More...

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

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkViewport ()

	~vtkViewport () override

Protected Member Functions inherited from vtkObject
	vtkObject ()

	~vtkObject () override

void	RegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override

void	InternalGrabFocus (vtkCommand mouseEvents, vtkCommand keypressEvents=nullptr)
	These methods allow a command to exclusively grab all events. More...

void	InternalReleaseFocus ()

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	CollectRevisions (ostream &)

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
vtkAssemblyPath *	PickedProp

vtkPropCollection *	PickFromProps

vtkPropCollection *	PickResultProps

double	PickX1

double	PickY1

double	PickX2

double	PickY2

double	PickedZ

vtkPropCollection *	Props

vtkActor2DCollection *	Actors2D

vtkWindow *	VTKWindow

double	Background [3]

double	Background2 [3]

double	BackgroundAlpha

double	Viewport [4]

double	Aspect [2]

double	PixelAspect [2]

double	Center [2]

bool	GradientBackground

double	EnvironmentalBG [3]

double	EnvironmentalBG2 [3]

bool	GradientEnvironmentalBG

int	Size [2]

int	Origin [2]

double	DisplayPoint [3]

double	ViewPoint [3]

double	WorldPoint [4]

Protected Attributes inherited from vtkObject
bool	Debug

vtkTimeStamp	MTime

vtkSubjectHelper *	SubjectHelper

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

vtkWeakPointerBase **	WeakPointers

Detailed Description

abstract specification for Viewports

vtkViewport provides an abstract specification for Viewports. A Viewport is an object that controls the rendering process for objects. Rendering is the process of converting geometry, a specification for lights, and a camera view into an image. vtkViewport also performs coordinate transformation between world coordinates, view coordinates (the computer graphics rendering coordinate system), and display coordinates (the actual screen coordinates on the display device). Certain advanced rendering features such as two-sided lighting can also be controlled.

See also: vtkWindow vtkRenderer

Definition at line 44 of file vtkViewport.h.

Member Typedef Documentation

◆ Superclass

typedef vtkObject vtkViewport::Superclass

Definition at line 47 of file vtkViewport.h.

Constructor & Destructor Documentation

◆ vtkViewport()

vtkViewport::vtkViewport ( )

protected

◆ ~vtkViewport()

vtkViewport::~vtkViewport ( )

overrideprotected

Member Function Documentation

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkViewport::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 vtkRenderer, vtkOpenGLRenderer, vtkExternalOpenGLRenderer, and vtkOpenVRRenderer.

◆ SafeDownCast()

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

static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkViewport::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented in vtkRenderer, vtkOpenGLRenderer, vtkExternalOpenGLRenderer, and vtkOpenVRRenderer.

◆ NewInstance()

vtkViewport* vtkViewport::NewInstance ( ) const

◆ PrintSelf()

void vtkViewport::PrintSelf	(	ostream &	os,
		vtkIndent	indent
	)

overridevirtual

Methods invoked by print to print information about the object including superclasses.

Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from vtkObject.

Reimplemented in vtkOpenGLRenderer, vtkExternalOpenGLRenderer, and vtkOpenVRRenderer.

◆ AddViewProp()

void vtkViewport::AddViewProp ( vtkProp * )

Add a prop to the list of props.

Does nothing if the prop is already present. Prop is the superclass of all actors, volumes, 2D actors, composite props etc.

◆ GetViewProps()

vtkPropCollection* vtkViewport::GetViewProps ( )

inline

Return any props in this viewport.

Definition at line 60 of file vtkViewport.h.

◆ HasViewProp()

int vtkViewport::HasViewProp ( vtkProp * )

Query if a prop is in the list of props.

◆ RemoveViewProp()

void vtkViewport::RemoveViewProp ( vtkProp * )

Remove a prop from the list of props.

Does nothing if the prop is not already present.

◆ RemoveAllViewProps()

void vtkViewport::RemoveAllViewProps ( void )

Remove all props from the list of props.

◆ AddActor2D()

void vtkViewport::AddActor2D ( vtkProp * p )

Add/Remove different types of props to the renderer.

These methods are all synonyms to AddViewProp and RemoveViewProp. They are here for convenience and backwards compatibility.

◆ RemoveActor2D()

void vtkViewport::RemoveActor2D ( vtkProp * p )

◆ GetActors2D()

vtkActor2DCollection* vtkViewport::GetActors2D ( )

◆ SetBackground() [1/2]

virtual void vtkViewport::SetBackground	(	double	,
		double	,
		double
	)

virtual

Set/Get the background color of the rendering screen using an rgb color specification.

◆ SetBackground() [2/2]

virtual void vtkViewport::SetBackground ( double [3] )

virtual

◆ GetBackground() [1/3]

virtual double* vtkViewport::GetBackground ( )

virtual

◆ GetBackground() [2/3]

virtual void vtkViewport::GetBackground	(	double &	,
		double &	,
		double &
	)

virtual

◆ GetBackground() [3/3]

virtual void vtkViewport::GetBackground ( double [3] )

virtual

◆ SetBackground2() [1/2]

virtual void vtkViewport::SetBackground2	(	double	,
		double	,
		double
	)

virtual

Set/Get the second background color of the rendering screen for gradient backgrounds using an rgb color specification.

◆ SetBackground2() [2/2]

virtual void vtkViewport::SetBackground2 ( double [3] )

virtual

◆ GetBackground2() [1/3]

virtual double* vtkViewport::GetBackground2 ( )

virtual

◆ GetBackground2() [2/3]

virtual void vtkViewport::GetBackground2	(	double &	,
		double &	,
		double &
	)

virtual

◆ GetBackground2() [3/3]

virtual void vtkViewport::GetBackground2 ( double [3] )

virtual

◆ SetBackgroundAlpha()

virtual void vtkViewport::SetBackgroundAlpha ( double )

virtual

Set/Get the alpha value used to fill the background with.

By default, this is set to 0.0.

◆ GetBackgroundAlpha()

virtual double vtkViewport::GetBackgroundAlpha ( )

virtual

◆ SetGradientBackground()

virtual void vtkViewport::SetGradientBackground ( bool )

virtual

Set/Get whether this viewport should have a gradient background using the Background (bottom) and Background2 (top) colors.

Default is off.

◆ GetGradientBackground()

virtual bool vtkViewport::GetGradientBackground ( )

virtual

◆ GradientBackgroundOn()

virtual void vtkViewport::GradientBackgroundOn ( )

virtual

◆ GradientBackgroundOff()

virtual void vtkViewport::GradientBackgroundOff ( )

virtual

◆ SetAspect() [1/2]

virtual void vtkViewport::SetAspect	(	double	,
		double
	)

virtual

Set the aspect ratio of the rendered image.

This is computed automatically and should not be set by the user.

◆ SetAspect() [2/2]

void vtkViewport::SetAspect ( double [2] )

◆ GetAspect() [1/2]

virtual double* vtkViewport::GetAspect ( )

virtual

◆ GetAspect() [2/2]

virtual void vtkViewport::GetAspect ( double data[2] )

virtual

◆ ComputeAspect()

virtual void vtkViewport::ComputeAspect ( )

virtual

◆ SetPixelAspect() [1/2]

virtual void vtkViewport::SetPixelAspect	(	double	,
		double
	)

virtual

Set the aspect ratio of a pixel in the rendered image.

This factor permits the image to rendered anisotropically (i.e., stretched in one direction or the other).

◆ SetPixelAspect() [2/2]

void vtkViewport::SetPixelAspect ( double [2] )

◆ GetPixelAspect() [1/2]

virtual double* vtkViewport::GetPixelAspect ( )

virtual

◆ GetPixelAspect() [2/2]

virtual void vtkViewport::GetPixelAspect ( double data[2] )

virtual

◆ SetViewport() [1/2]

virtual void vtkViewport::SetViewport	(	double	,
		double	,
		double	,
		double
	)

virtual

Specify the viewport for the Viewport to draw in the rendering window.

Coordinates are expressed as (xmin,ymin,xmax,ymax), where each coordinate is 0 <= coordinate <= 1.0.

◆ SetViewport() [2/2]

virtual void vtkViewport::SetViewport ( double [4] )

virtual

◆ GetViewport() [1/2]

virtual double* vtkViewport::GetViewport ( )

virtual

◆ GetViewport() [2/2]

virtual void vtkViewport::GetViewport ( double data[4] )

virtual

◆ SetDisplayPoint() [1/2]

virtual void vtkViewport::SetDisplayPoint	(	double	,
		double	,
		double
	)

virtual

Set/get a point location in display (or screen) coordinates.

The lower left corner of the window is the origin and y increases as you go up the screen.

◆ SetDisplayPoint() [2/2]

virtual void vtkViewport::SetDisplayPoint ( double [3] )

virtual

◆ GetDisplayPoint() [1/2]

virtual double* vtkViewport::GetDisplayPoint ( )

virtual

◆ GetDisplayPoint() [2/2]

virtual void vtkViewport::GetDisplayPoint ( double data[3] )

virtual

◆ SetViewPoint() [1/2]

virtual void vtkViewport::SetViewPoint	(	double	,
		double	,
		double
	)

virtual

Specify a point location in view coordinates.

The origin is in the middle of the viewport and it extends from -1 to 1 in all three dimensions.

◆ SetViewPoint() [2/2]

virtual void vtkViewport::SetViewPoint ( double [3] )

virtual

◆ GetViewPoint() [1/2]

virtual double* vtkViewport::GetViewPoint ( )

virtual

◆ GetViewPoint() [2/2]

virtual void vtkViewport::GetViewPoint ( double data[3] )

virtual

◆ SetWorldPoint() [1/2]

virtual void vtkViewport::SetWorldPoint	(	double	,
		double	,
		double	,
		double
	)

virtual

Specify a point location in world coordinates.

This method takes homogeneous coordinates.

◆ SetWorldPoint() [2/2]

virtual void vtkViewport::SetWorldPoint ( double [4] )

virtual

◆ GetWorldPoint() [1/2]

virtual double* vtkViewport::GetWorldPoint ( )

virtual

◆ GetWorldPoint() [2/2]

virtual void vtkViewport::GetWorldPoint ( double data[4] )

virtual

◆ GetCenter()

virtual double* vtkViewport::GetCenter ( )

virtual

Return the center of this viewport in display coordinates.

◆ IsInViewport()

virtual int vtkViewport::IsInViewport	(	int	x,
		int	y
	)

virtual

Is a given display point in this Viewport's viewport.

◆ GetVTKWindow()

virtual vtkWindow* vtkViewport::GetVTKWindow ( )

pure virtual

Return the vtkWindow that owns this vtkViewport.

Implemented in vtkRenderer.

◆ DisplayToView()

virtual void vtkViewport::DisplayToView ( )

virtual

Convert display coordinates to view coordinates.

◆ ViewToDisplay()

virtual void vtkViewport::ViewToDisplay ( )

virtual

Convert view coordinates to display coordinates.

◆ WorldToView() [1/2]

virtual void vtkViewport::WorldToView ( )

virtual

Convert world point coordinates to view coordinates.

Reimplemented in vtkRenderer.

◆ ViewToWorld() [1/2]

virtual void vtkViewport::ViewToWorld ( )

virtual

Convert view point coordinates to world coordinates.

Reimplemented in vtkRenderer.

◆ DisplayToWorld()

void vtkViewport::DisplayToWorld ( )

inline

Convert display (or screen) coordinates to world coordinates.

Definition at line 225 of file vtkViewport.h.

◆ WorldToDisplay()

void vtkViewport::WorldToDisplay ( )

inline

Convert world point coordinates to display (or screen) coordinates.

Definition at line 234 of file vtkViewport.h.

◆ LocalDisplayToDisplay()

virtual void vtkViewport::LocalDisplayToDisplay	(	double &	x,
		double &	y
	)

virtual

These methods map from one coordinate system to another.

They are primarily used by the vtkCoordinate object and are often strung together. These methods return valid information only if the window has been realized (e.g., GetSize() returns something other than (0,0)).

◆ DisplayToNormalizedDisplay()

virtual void vtkViewport::DisplayToNormalizedDisplay	(	double &	u,
		double &	v
	)

virtual

◆ NormalizedDisplayToViewport()

virtual void vtkViewport::NormalizedDisplayToViewport	(	double &	x,
		double &	y
	)

virtual

◆ ViewportToNormalizedViewport()

virtual void vtkViewport::ViewportToNormalizedViewport	(	double &	u,
		double &	v
	)

virtual

◆ NormalizedViewportToView()

virtual void vtkViewport::NormalizedViewportToView	(	double &	x,
		double &	y,
		double &	z
	)

virtual

◆ ViewToPose()

virtual void vtkViewport::ViewToPose	(	double &	,
		double &	,
		double &
	)

inlinevirtual

Reimplemented in vtkRenderer.

Definition at line 253 of file vtkViewport.h.

◆ PoseToWorld()

virtual void vtkViewport::PoseToWorld	(	double &	,
		double &	,
		double &
	)

inlinevirtual

Reimplemented in vtkRenderer.

Definition at line 254 of file vtkViewport.h.

◆ DisplayToLocalDisplay()

virtual void vtkViewport::DisplayToLocalDisplay	(	double &	x,
		double &	y
	)

virtual

◆ NormalizedDisplayToDisplay()

virtual void vtkViewport::NormalizedDisplayToDisplay	(	double &	u,
		double &	v
	)

virtual

◆ ViewportToNormalizedDisplay()

virtual void vtkViewport::ViewportToNormalizedDisplay	(	double &	x,
		double &	y
	)

virtual

◆ NormalizedViewportToViewport()

virtual void vtkViewport::NormalizedViewportToViewport	(	double &	u,
		double &	v
	)

virtual

◆ ViewToNormalizedViewport()

virtual void vtkViewport::ViewToNormalizedViewport	(	double &	x,
		double &	y,
		double &	z
	)

virtual

◆ PoseToView()

virtual void vtkViewport::PoseToView	(	double &	,
		double &	,
		double &
	)

inlinevirtual

Reimplemented in vtkRenderer.

Definition at line 260 of file vtkViewport.h.

◆ WorldToPose()

virtual void vtkViewport::WorldToPose	(	double &	,
		double &	,
		double &
	)

inlinevirtual

Reimplemented in vtkRenderer.

Definition at line 261 of file vtkViewport.h.

◆ ViewToWorld() [2/2]

virtual void vtkViewport::ViewToWorld	(	double &	,
		double &	,
		double &
	)

inlinevirtual

Reimplemented in vtkRenderer.

Definition at line 262 of file vtkViewport.h.

◆ WorldToView() [2/2]

virtual void vtkViewport::WorldToView	(	double &	,
		double &	,
		double &
	)

inlinevirtual

Reimplemented in vtkRenderer.

Definition at line 263 of file vtkViewport.h.

◆ GetSize()

virtual int* vtkViewport::GetSize ( )

virtual

Get the size and origin of the viewport in display coordinates.

Note: if the window has not yet been realized, GetSize() and GetOrigin() return (0,0).

◆ GetOrigin()

virtual int* vtkViewport::GetOrigin ( )

virtual

◆ GetTiledSize()

void vtkViewport::GetTiledSize	(	int *	width,
		int *	height
	)

◆ GetTiledSizeAndOrigin()

virtual void vtkViewport::GetTiledSizeAndOrigin	(	int *	width,
		int *	height,
		int *	lowerLeftX,
		int *	lowerLeftY
	)

virtual

◆ PickProp() [1/2]

virtual vtkAssemblyPath* vtkViewport::PickProp	(	double	selectionX,
		double	selectionY
	)

pure virtual

Return the Prop that has the highest z value at the given x, y position in the viewport.

Basically, the top most prop that renders the pixel at selectionX, selectionY will be returned. If no Props are there NULL is returned. This method selects from the Viewports Prop list.

Implemented in vtkRenderer.

◆ PickProp() [2/2]

virtual vtkAssemblyPath* vtkViewport::PickProp	(	double	selectionX1,
		double	selectionY1,
		double	selectionX2,
		double	selectionY2
	)

pure virtual

Return the Prop that has the highest z value at the given x1, y1 and x2,y2 positions in the viewport.

Basically, the top most prop that renders the pixel at selectionX1, selectionY1, selectionX2, selectionY2 will be returned. If no Props are there NULL is returned. This method selects from the Viewports Prop list.

Implemented in vtkRenderer.

◆ PickPropFrom() [1/2]

vtkAssemblyPath* vtkViewport::PickPropFrom	(	double	selectionX,
		double	selectionY,
		vtkPropCollection *
	)

Same as PickProp with two arguments, but selects from the given collection of Props instead of the Renderers props.

Make sure the Props in the collection are in this renderer.

◆ PickPropFrom() [2/2]

vtkAssemblyPath* vtkViewport::PickPropFrom	(	double	selectionX1,
		double	selectionY1,
		double	selectionX2,
		double	selectionY2,
		vtkPropCollection *
	)

Same as PickProp with four arguments, but selects from the given collection of Props instead of the Renderers props.

Make sure the Props in the collection are in this renderer.

◆ GetPickX()

double vtkViewport::GetPickX ( ) const

inline

Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY).

Definition at line 319 of file vtkViewport.h.

◆ GetPickY()

double vtkViewport::GetPickY ( ) const

inline

Definition at line 320 of file vtkViewport.h.

◆ GetPickWidth()

double vtkViewport::GetPickWidth ( ) const

inline

Definition at line 321 of file vtkViewport.h.

◆ GetPickHeight()

double vtkViewport::GetPickHeight ( ) const

inline

Definition at line 322 of file vtkViewport.h.

◆ GetPickX1()

double vtkViewport::GetPickX1 ( ) const

inline

Definition at line 323 of file vtkViewport.h.

◆ GetPickY1()

double vtkViewport::GetPickY1 ( ) const

inline

Definition at line 324 of file vtkViewport.h.

◆ GetPickX2()

double vtkViewport::GetPickX2 ( ) const

inline

Definition at line 325 of file vtkViewport.h.

◆ GetPickY2()

double vtkViewport::GetPickY2 ( ) const

inline

Definition at line 326 of file vtkViewport.h.

◆ GetPickResultProps()

virtual vtkPropCollection* vtkViewport::GetPickResultProps ( )

virtual

◆ GetPickedZ()

virtual double vtkViewport::GetPickedZ ( )

inlinevirtual

Return the Z value for the last picked Prop.

Definition at line 333 of file vtkViewport.h.

◆ SetEnvironmentalBG() [1/2]

virtual void vtkViewport::SetEnvironmentalBG	(	double	,
		double	,
		double
	)

virtual

Set/Get the constant environmental color using an rgb color specification.

Note this is currently ignored outside of RayTracing.

◆ SetEnvironmentalBG() [2/2]

virtual void vtkViewport::SetEnvironmentalBG ( double [3] )

virtual

◆ GetEnvironmentalBG() [1/3]

virtual double* vtkViewport::GetEnvironmentalBG ( )

virtual

◆ GetEnvironmentalBG() [2/3]

virtual void vtkViewport::GetEnvironmentalBG	(	double &	,
		double &	,
		double &
	)

virtual

◆ GetEnvironmentalBG() [3/3]

virtual void vtkViewport::GetEnvironmentalBG ( double [3] )

virtual

◆ SetEnvironmentalBG2() [1/2]

virtual void vtkViewport::SetEnvironmentalBG2	(	double	,
		double	,
		double
	)

virtual

Set/Get the second environmental gradient color using an rgb color specification.

Note this is currently ignored outside of RayTracing.

◆ SetEnvironmentalBG2() [2/2]

virtual void vtkViewport::SetEnvironmentalBG2 ( double [3] )

virtual

◆ GetEnvironmentalBG2() [1/3]

virtual double* vtkViewport::GetEnvironmentalBG2 ( )

virtual

◆ GetEnvironmentalBG2() [2/3]

virtual void vtkViewport::GetEnvironmentalBG2	(	double &	,
		double &	,
		double &
	)

virtual

◆ GetEnvironmentalBG2() [3/3]

virtual void vtkViewport::GetEnvironmentalBG2 ( double [3] )

virtual

◆ SetGradientEnvironmentalBG()

virtual void vtkViewport::SetGradientEnvironmentalBG ( bool )

virtual

Set/Get whether this viewport should enable the gradient environment using the EnvironmentalBG (bottom) and EnvironmentalBG2 (top) colors.

Note this is currently ignored outside of RayTracing. Default is off.

◆ GetGradientEnvironmentalBG()

virtual bool vtkViewport::GetGradientEnvironmentalBG ( )

virtual

◆ GradientEnvironmentalBGOn()

virtual void vtkViewport::GradientEnvironmentalBGOn ( )

virtual

◆ GradientEnvironmentalBGOff()

virtual void vtkViewport::GradientEnvironmentalBGOff ( )

virtual

Member Data Documentation

◆ PickedProp

vtkAssemblyPath* vtkViewport::PickedProp

protected

Definition at line 373 of file vtkViewport.h.

◆ PickFromProps

vtkPropCollection* vtkViewport::PickFromProps

protected

Definition at line 374 of file vtkViewport.h.

◆ PickResultProps

vtkPropCollection* vtkViewport::PickResultProps

protected

Definition at line 375 of file vtkViewport.h.

◆ PickX1

double vtkViewport::PickX1

protected

Definition at line 376 of file vtkViewport.h.

◆ PickY1

double vtkViewport::PickY1

protected

Definition at line 377 of file vtkViewport.h.

◆ PickX2

double vtkViewport::PickX2

protected

Definition at line 378 of file vtkViewport.h.

◆ PickY2

double vtkViewport::PickY2

protected

Definition at line 379 of file vtkViewport.h.

◆ PickedZ

double vtkViewport::PickedZ

protected

Definition at line 380 of file vtkViewport.h.

◆ Props

vtkPropCollection* vtkViewport::Props

protected

Definition at line 383 of file vtkViewport.h.

◆ Actors2D

vtkActor2DCollection* vtkViewport::Actors2D

protected

Definition at line 384 of file vtkViewport.h.

◆ VTKWindow

vtkWindow* vtkViewport::VTKWindow

protected

Definition at line 385 of file vtkViewport.h.

◆ Background

double vtkViewport::Background[3]

protected

Definition at line 386 of file vtkViewport.h.

◆ Background2

double vtkViewport::Background2[3]

protected

Definition at line 387 of file vtkViewport.h.

◆ BackgroundAlpha

double vtkViewport::BackgroundAlpha

protected

Definition at line 388 of file vtkViewport.h.

◆ Viewport

double vtkViewport::Viewport[4]

protected

Definition at line 389 of file vtkViewport.h.

◆ Aspect

double vtkViewport::Aspect[2]

protected

Definition at line 390 of file vtkViewport.h.

◆ PixelAspect

double vtkViewport::PixelAspect[2]

protected

Definition at line 391 of file vtkViewport.h.

◆ Center

double vtkViewport::Center[2]

protected

Definition at line 392 of file vtkViewport.h.

◆ GradientBackground

bool vtkViewport::GradientBackground

protected

Definition at line 393 of file vtkViewport.h.

◆ EnvironmentalBG

double vtkViewport::EnvironmentalBG[3]

protected

Definition at line 395 of file vtkViewport.h.

◆ EnvironmentalBG2

double vtkViewport::EnvironmentalBG2[3]

protected

Definition at line 396 of file vtkViewport.h.

◆ GradientEnvironmentalBG

bool vtkViewport::GradientEnvironmentalBG

protected

Definition at line 397 of file vtkViewport.h.

◆ Size

int vtkViewport::Size[2]

protected

Definition at line 399 of file vtkViewport.h.

◆ Origin

int vtkViewport::Origin[2]

protected

Definition at line 400 of file vtkViewport.h.

◆ DisplayPoint

double vtkViewport::DisplayPoint[3]

protected

Definition at line 401 of file vtkViewport.h.

◆ ViewPoint

double vtkViewport::ViewPoint[3]

protected

Definition at line 402 of file vtkViewport.h.

◆ WorldPoint

double vtkViewport::WorldPoint[4]

protected

Definition at line 403 of file vtkViewport.h.

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

Rendering/Core/vtkViewport.h

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ Superclass

Constructor & Destructor Documentation

◆ vtkViewport()

◆ ~vtkViewport()

Member Function Documentation

◆ IsTypeOf()

◆ IsA()

◆ SafeDownCast()

◆ NewInstanceInternal()

◆ NewInstance()

◆ PrintSelf()

◆ AddViewProp()

◆ GetViewProps()

◆ HasViewProp()

◆ RemoveViewProp()

◆ RemoveAllViewProps()

◆ AddActor2D()

◆ RemoveActor2D()

◆ GetActors2D()

◆ SetBackground() [1/2]

◆ SetBackground() [2/2]

◆ GetBackground() [1/3]

◆ GetBackground() [2/3]

◆ GetBackground() [3/3]

◆ SetBackground2() [1/2]

◆ SetBackground2() [2/2]

◆ GetBackground2() [1/3]

◆ GetBackground2() [2/3]

◆ GetBackground2() [3/3]

◆ SetBackgroundAlpha()

◆ GetBackgroundAlpha()

◆ SetGradientBackground()

◆ GetGradientBackground()

◆ GradientBackgroundOn()

◆ GradientBackgroundOff()

◆ SetAspect() [1/2]

◆ SetAspect() [2/2]

◆ GetAspect() [1/2]

◆ GetAspect() [2/2]

◆ ComputeAspect()

◆ SetPixelAspect() [1/2]

◆ SetPixelAspect() [2/2]

◆ GetPixelAspect() [1/2]

◆ GetPixelAspect() [2/2]

◆ SetViewport() [1/2]

◆ SetViewport() [2/2]

◆ GetViewport() [1/2]

◆ GetViewport() [2/2]

◆ SetDisplayPoint() [1/2]

◆ SetDisplayPoint() [2/2]

◆ GetDisplayPoint() [1/2]

◆ GetDisplayPoint() [2/2]

◆ SetViewPoint() [1/2]

◆ SetViewPoint() [2/2]

◆ GetViewPoint() [1/2]

◆ GetViewPoint() [2/2]

◆ SetWorldPoint() [1/2]

◆ SetWorldPoint() [2/2]

◆ GetWorldPoint() [1/2]

◆ GetWorldPoint() [2/2]

◆ GetCenter()

◆ IsInViewport()

◆ GetVTKWindow()

◆ DisplayToView()

◆ ViewToDisplay()

◆ WorldToView() [1/2]

◆ ViewToWorld() [1/2]

◆ DisplayToWorld()

◆ WorldToDisplay()

◆ LocalDisplayToDisplay()

◆ DisplayToNormalizedDisplay()

◆ NormalizedDisplayToViewport()

◆ ViewportToNormalizedViewport()