VTK  9.3.20240318
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkViewport Class Referenceabstract

abstract specification for Viewports More...

#include <vtkViewport.h>

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

Public Types

enum class  GradientModes : int { VTK_GRADIENT_VERTICAL , VTK_GRADIENT_HORIZONTAL , VTK_GRADIENT_RADIAL_VIEWPORT_FARTHEST_SIDE , VTK_GRADIENT_RADIAL_VIEWPORT_FARTHEST_CORNER }
 
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...
 
vtkViewportNewInstance () 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...
 
vtkPropCollectionGetViewProps ()
 Return any props in this viewport. More...
 
vtkTypeBool 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 ()
 Remove all props from the list of props. More...
 
virtual double * GetCenter ()
 Return the center of this viewport in display coordinates. More...
 
virtual vtkTypeBool IsInViewport (int x, int y)
 Is a given display point in this Viewport's viewport. More...
 
virtual vtkWindowGetVTKWindow ()=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...
 
void WorldToDisplay (double &x, double &y, double &z)
 Convert world point coordinates to display (or screen) coordinates. More...
 
virtual vtkAssemblyPathPickProp (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 vtkAssemblyPathPickProp (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...
 
vtkAssemblyPathPickPropFrom (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...
 
vtkAssemblyPathPickPropFrom (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...
 
virtual vtkAssemblyPathPickProp (double selectionX, double selectionY, int fieldAssociation, vtkSmartPointer< vtkSelection > selection)=0
 Return the Prop that has the highest z value at the given x, y position in the viewport. More...
 
virtual vtkAssemblyPathPickProp (double selectionX1, double selectionY1, double selectionX2, double selectionY2, int fieldAssociation, vtkSmartPointer< vtkSelection > selection)=0
 Return the Prop that has the highest z value at the given x1, y1 and x2,y2 positions in the viewport. More...
 
vtkAssemblyPathPickPropFrom (double selectionX, double selectionY, vtkPropCollection *, int fieldAssociation, vtkSmartPointer< vtkSelection > selection)
 Same as PickProp with two arguments, but selects from the given collection of Props instead of the Renderers props. More...
 
vtkAssemblyPathPickPropFrom (double selectionX1, double selectionY1, double selectionX2, double selectionY2, vtkPropCollection *, int fieldAssociation, vtkSmartPointer< vtkSelection > selection)
 Same as PickProp with four arguments, but selects from the given collection of Props instead of the Renderers props. More...
 
virtual double GetPickedZ ()
 Return the Z value for the last picked Prop. More...
 
void AddActor2D (vtkProp *p)
 Add/Remove different types of props to the renderer. More...
 
void RemoveActor2D (vtkProp *p)
 Add/Remove different types of props to the renderer. More...
 
vtkActor2DCollectionGetActors2D ()
 Add/Remove different types of props to the renderer. More...
 
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])
 Set/Get the background color of the rendering screen using an rgb color specification. More...
 
virtual double * GetBackground ()
 Set/Get the background color of the rendering screen using an rgb color specification. More...
 
virtual void GetBackground (double &, double &, double &)
 Set/Get the background color of the rendering screen using an rgb color specification. More...
 
virtual void GetBackground (double[3])
 Set/Get the background color of the rendering screen using an rgb color specification. More...
 
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])
 Set/Get the second background color of the rendering screen for gradient backgrounds using an rgb color specification. More...
 
virtual double * GetBackground2 ()
 Set/Get the second background color of the rendering screen for gradient backgrounds using an rgb color specification. More...
 
virtual void GetBackground2 (double &, double &, double &)
 Set/Get the second background color of the rendering screen for gradient backgrounds using an rgb color specification. More...
 
virtual void GetBackground2 (double[3])
 Set/Get the second background color of the rendering screen for gradient backgrounds using an rgb color specification. More...
 
virtual void SetBackgroundAlpha (double)
 Set/Get the alpha value used to fill the background with. More...
 
virtual double GetBackgroundAlpha ()
 Set/Get the alpha value used to fill the background with. More...
 
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 ()
 Set/Get whether this viewport should have a gradient background using the Background (bottom) and Background2 (top) colors. More...
 
virtual void GradientBackgroundOn ()
 Set/Get whether this viewport should have a gradient background using the Background (bottom) and Background2 (top) colors. More...
 
virtual void GradientBackgroundOff ()
 Set/Get whether this viewport should have a gradient background using the Background (bottom) and Background2 (top) colors. More...
 
virtual void SetDitherGradient (bool)
 Set/Get whether this viewport should use dithering to reduce color banding when using gradient backgrounds. More...
 
virtual bool GetDitherGradient ()
 Set/Get whether this viewport should use dithering to reduce color banding when using gradient backgrounds. More...
 
virtual void DitherGradientOn ()
 Set/Get whether this viewport should use dithering to reduce color banding when using gradient backgrounds. More...
 
virtual void DitherGradientOff ()
 Set/Get whether this viewport should use dithering to reduce color banding when using gradient backgrounds. More...
 
 vtkSetEnumMacro (GradientMode, GradientModes)
 Specify the direction of the gradient background. More...
 
 vtkGetEnumMacro (GradientMode, GradientModes)
 Specify the direction of the gradient background. More...
 
virtual void SetAspect (double, double)
 Set the aspect ratio of the rendered image. More...
 
void SetAspect (double[2])
 Set the aspect ratio of the rendered image. More...
 
virtual double * GetAspect ()
 Set the aspect ratio of the rendered image. More...
 
virtual void GetAspect (double data[2])
 Set the aspect ratio of the rendered image. More...
 
virtual void ComputeAspect ()
 Set the aspect ratio of the rendered image. More...
 
virtual void SetPixelAspect (double, double)
 Set the aspect ratio of a pixel in the rendered image. More...
 
void SetPixelAspect (double[2])
 Set the aspect ratio of a pixel in the rendered image. More...
 
virtual double * GetPixelAspect ()
 Set the aspect ratio of a pixel in the rendered image. More...
 
virtual void GetPixelAspect (double data[2])
 Set the aspect ratio of a pixel in the rendered image. More...
 
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])
 Specify the viewport for the Viewport to draw in the rendering window. More...
 
virtual double * GetViewport ()
 Specify the viewport for the Viewport to draw in the rendering window. More...
 
virtual void GetViewport (double data[4])
 Specify the viewport for the Viewport to draw in the rendering window. More...
 
virtual void SetDisplayPoint (double, double, double)
 Set/get a point location in display (or screen) coordinates. More...
 
virtual void SetDisplayPoint (double[3])
 Set/get a point location in display (or screen) coordinates. More...
 
virtual double * GetDisplayPoint ()
 Set/get a point location in display (or screen) coordinates. More...
 
virtual void GetDisplayPoint (double data[3])
 Set/get a point location in display (or screen) coordinates. More...
 
virtual void SetViewPoint (double, double, double)
 Specify a point location in view coordinates. More...
 
virtual void SetViewPoint (double[3])
 Specify a point location in view coordinates. More...
 
virtual double * GetViewPoint ()
 Specify a point location in view coordinates. More...
 
virtual void GetViewPoint (double data[3])
 Specify a point location in view coordinates. More...
 
virtual void SetWorldPoint (double, double, double, double)
 Specify a point location in world coordinates. More...
 
virtual void SetWorldPoint (double[4])
 Specify a point location in world coordinates. More...
 
virtual double * GetWorldPoint ()
 Specify a point location in world coordinates. More...
 
virtual void GetWorldPoint (double data[4])
 Specify a point location in world 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)
 These methods map from one coordinate system to another. More...
 
virtual void NormalizedDisplayToViewport (double &x, double &y)
 These methods map from one coordinate system to another. More...
 
virtual void ViewportToNormalizedViewport (double &u, double &v)
 These methods map from one coordinate system to another. More...
 
virtual void NormalizedViewportToView (double &x, double &y, double &z)
 These methods map from one coordinate system to another. More...
 
virtual void ViewToPose (double &, double &, double &)
 These methods map from one coordinate system to another. More...
 
virtual void PoseToWorld (double &, double &, double &)
 These methods map from one coordinate system to another. More...
 
virtual void DisplayToLocalDisplay (double &x, double &y)
 These methods map from one coordinate system to another. More...
 
virtual void NormalizedDisplayToDisplay (double &u, double &v)
 These methods map from one coordinate system to another. More...
 
virtual void ViewportToNormalizedDisplay (double &x, double &y)
 These methods map from one coordinate system to another. More...
 
virtual void NormalizedViewportToViewport (double &u, double &v)
 These methods map from one coordinate system to another. More...
 
virtual void ViewToNormalizedViewport (double &x, double &y, double &z)
 These methods map from one coordinate system to another. More...
 
virtual void PoseToView (double &, double &, double &)
 These methods map from one coordinate system to another. More...
 
virtual void WorldToPose (double &, double &, double &)
 These methods map from one coordinate system to another. More...
 
virtual void ViewToWorld (double &, double &, double &)
 These methods map from one coordinate system to another. More...
 
virtual void WorldToView (double &, double &, double &)
 These methods map from one coordinate system to another. More...
 
virtual void ViewToDisplay (double &x, double &y, double &z)
 These methods map from one coordinate system to another. More...
 
virtual int * GetSize ()
 Get the size and origin of the viewport in display coordinates. More...
 
virtual int * GetOrigin ()
 Get the size and origin of the viewport in display coordinates. More...
 
void GetTiledSize (int *width, int *height)
 Get the size and origin of the viewport in display coordinates. More...
 
virtual void GetTiledSizeAndOrigin (int *width, int *height, int *lowerLeftX, int *lowerLeftY)
 Get the size and origin of the viewport in display coordinates. 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
 Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY). More...
 
double GetPickWidth () 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 GetPickHeight () 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 GetPickX1 () 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 GetPickY1 () 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 GetPickX2 () 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 GetPickY2 () const
 Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY). More...
 
virtual vtkPropCollectionGetPickResultProps ()
 Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY). More...
 
virtual void SetEnvironmentalBG (double, double, double)
 Set/Get the constant environmental color using an rgb color specification. More...
 
virtual void SetEnvironmentalBG (double[3])
 Set/Get the constant environmental color using an rgb color specification. More...
 
virtual double * GetEnvironmentalBG ()
 Set/Get the constant environmental color using an rgb color specification. More...
 
virtual void GetEnvironmentalBG (double &, double &, double &)
 Set/Get the constant environmental color using an rgb color specification. More...
 
virtual void GetEnvironmentalBG (double[3])
 Set/Get the constant environmental color using an rgb color specification. More...
 
virtual void SetEnvironmentalBG2 (double, double, double)
 Set/Get the second environmental gradient color using an rgb color specification. More...
 
virtual void SetEnvironmentalBG2 (double[3])
 Set/Get the second environmental gradient color using an rgb color specification. More...
 
virtual double * GetEnvironmentalBG2 ()
 Set/Get the second environmental gradient color using an rgb color specification. More...
 
virtual void GetEnvironmentalBG2 (double &, double &, double &)
 Set/Get the second environmental gradient color using an rgb color specification. More...
 
virtual void GetEnvironmentalBG2 (double[3])
 Set/Get the second environmental gradient color using an rgb color specification. More...
 
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 ()
 Set/Get whether this viewport should enable the gradient environment using the EnvironmentalBG (bottom) and EnvironmentalBG2 (top) colors. More...
 
virtual void GradientEnvironmentalBGOn ()
 Set/Get whether this viewport should enable the gradient environment using the EnvironmentalBG (bottom) and EnvironmentalBG2 (top) colors. More...
 
virtual void GradientEnvironmentalBGOff ()
 Set/Get whether this viewport should enable the gradient environment using the EnvironmentalBG (bottom) and EnvironmentalBG2 (top) colors. More...
 
- Public Member Functions inherited from vtkObject
 vtkBaseTypeMacro (vtkObject, vtkObjectBase)
 
virtual void DebugOn ()
 Turn debugging output on. More...
 
virtual void DebugOff ()
 Turn debugging output off. More...
 
bool GetDebug ()
 Get the value of the debug flag. More...
 
void SetDebug (bool debugFlag)
 Set the value of the debug flag. More...
 
virtual void Modified ()
 Update the modification time for this object. More...
 
virtual vtkMTimeType GetMTime ()
 Return this object's modified time. More...
 
void RemoveObserver (unsigned long tag)
 
void RemoveObservers (unsigned long event)
 
void RemoveObservers (const char *event)
 
void RemoveAllObservers ()
 
vtkTypeBool HasObserver (unsigned long event)
 
vtkTypeBool HasObserver (const char *event)
 
vtkTypeBool InvokeEvent (unsigned long event)
 
vtkTypeBool InvokeEvent (const char *event)
 
std::string GetObjectDescription () const override
 The object description printed in messages and PrintSelf output. 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)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkCommandGetCommand (unsigned long tag)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObserver (vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
void RemoveObservers (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
vtkTypeBool HasObserver (const char *event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More...
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 Allow user to set the AbortFlagOn() with the return value of the callback method. More...
 
vtkTypeBool InvokeEvent (unsigned long event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
vtkTypeBool InvokeEvent (const char *event, void *callData)
 This method invokes an event and return whether the event was aborted or not. More...
 
virtual void SetObjectName (const std::string &objectName)
 Set/get the name of this object for reporting purposes. More...
 
virtual std::string GetObjectName () const
 Set/get the name of this object for reporting purposes. More...
 
- 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 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...
 
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...
 
bool GetIsInMemkind () const
 A local state flag that remembers whether this object lives in the normal or extended memory space. More...
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 Methods invoked by print to print information about the object including superclasses. More...
 
virtual bool UsesGarbageCollector () const
 Indicate whether the class uses vtkGarbageCollector or not. More...
 

Static Public Member Functions

static vtkTypeBool IsTypeOf (const char *type)
 
static vtkViewportSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void BreakOnError ()
 This method is called when vtkErrorMacro executes. More...
 
static void SetGlobalWarningDisplay (vtkTypeBool val)
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOn ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static void GlobalWarningDisplayOff ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
static vtkTypeBool GetGlobalWarningDisplay ()
 This is a global flag that controls whether any debug, warning or error messages are displayed. More...
 
- Static Public Member Functions inherited from vtkObjectBase
static vtkTypeBool IsTypeOf (const char *name)
 Return 1 if this class type is the same type of (or a subclass of) the named class. More...
 
static 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 
static void SetMemkindDirectory (const char *directoryname)
 The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More...
 
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. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () 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 ()
 These methods allow a command to exclusively grab all events. More...
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkAssemblyPathPickedProp
 
vtkPropCollectionPickFromProps
 
vtkPropCollectionPickResultProps
 
double PickX1
 
double PickY1
 
double PickX2
 
double PickY2
 
double PickedZ
 
vtkPropCollectionProps
 
vtkActor2DCollectionActors2D
 
vtkWindowVTKWindow
 
double Background [3]
 
double Background2 [3]
 
double BackgroundAlpha
 
double Viewport [4]
 
double Aspect [2]
 
double PixelAspect [2]
 
double Center [2]
 
bool GradientBackground
 
bool DitherGradient
 
GradientModes GradientMode = GradientModes::VTK_GRADIENT_VERTICAL
 
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
 
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

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
Examples:
vtkViewport (Examples)
Online Examples:

Tests:
vtkViewport (Tests)

Definition at line 63 of file vtkViewport.h.

Member Typedef Documentation

◆ Superclass

Definition at line 66 of file vtkViewport.h.

Member Enumeration Documentation

◆ GradientModes

enum vtkViewport::GradientModes : int
strong
Enumerator
VTK_GRADIENT_VERTICAL 
VTK_GRADIENT_HORIZONTAL 
VTK_GRADIENT_RADIAL_VIEWPORT_FARTHEST_SIDE 
VTK_GRADIENT_RADIAL_VIEWPORT_FARTHEST_CORNER 

Definition at line 158 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 vtkZSpaceRenderer, vtkWebGPURenderer, vtkVRRenderer, vtkOpenXRRenderer, vtkOpenVRRenderer, vtkOpenGLRenderer, vtkExternalOpenGLRenderer, and vtkRenderer.

◆ SafeDownCast()

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

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkViewport::NewInstanceInternal ( ) const
protectedvirtual

◆ 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 vtkZSpaceRenderer, vtkWebGPURenderer, vtkVRRenderer, vtkOpenXRRenderer, vtkOpenGLRenderer, and vtkExternalOpenGLRenderer.

◆ 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 79 of file vtkViewport.h.

◆ HasViewProp()

vtkTypeBool 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 or if the parameter is NULL.

◆ RemoveAllViewProps()

void vtkViewport::RemoveAllViewProps ( )

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)

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.

◆ GetActors2D()

vtkActor2DCollection* vtkViewport::GetActors2D ( )

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.

◆ 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

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

◆ GetBackground() [1/3]

virtual double* vtkViewport::GetBackground ( )
virtual

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

◆ GetBackground() [2/3]

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

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

◆ GetBackground() [3/3]

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

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

◆ 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

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

◆ GetBackground2() [1/3]

virtual double* vtkViewport::GetBackground2 ( )
virtual

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

◆ GetBackground2() [2/3]

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

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

◆ GetBackground2() [3/3]

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

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

◆ 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

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

By default, this is set to 0.0.

◆ 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

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

Default is off.

◆ GradientBackgroundOn()

virtual void vtkViewport::GradientBackgroundOn ( )
virtual

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

Default is off.

◆ GradientBackgroundOff()

virtual void vtkViewport::GradientBackgroundOff ( )
virtual

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

Default is off.

◆ SetDitherGradient()

virtual void vtkViewport::SetDitherGradient ( bool  )
virtual

Set/Get whether this viewport should use dithering to reduce color banding when using gradient backgrounds.

By default, this feature is enabled.

◆ GetDitherGradient()

virtual bool vtkViewport::GetDitherGradient ( )
virtual

Set/Get whether this viewport should use dithering to reduce color banding when using gradient backgrounds.

By default, this feature is enabled.

◆ DitherGradientOn()

virtual void vtkViewport::DitherGradientOn ( )
virtual

Set/Get whether this viewport should use dithering to reduce color banding when using gradient backgrounds.

By default, this feature is enabled.

◆ DitherGradientOff()

virtual void vtkViewport::DitherGradientOff ( )
virtual

Set/Get whether this viewport should use dithering to reduce color banding when using gradient backgrounds.

By default, this feature is enabled.

◆ vtkSetEnumMacro()

vtkViewport::vtkSetEnumMacro ( GradientMode  ,
GradientModes   
)

Specify the direction of the gradient background.

All modes smoothly interpolate the color from Background to Background2

See also
vtkViewport::GradientModes

◆ vtkGetEnumMacro()

vtkViewport::vtkGetEnumMacro ( GradientMode  ,
GradientModes   
)

Specify the direction of the gradient background.

All modes smoothly interpolate the color from Background to Background2

See also
vtkViewport::GradientModes

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

Set the aspect ratio of the rendered image.

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

◆ GetAspect() [1/2]

virtual double* vtkViewport::GetAspect ( )
virtual

Set the aspect ratio of the rendered image.

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

◆ GetAspect() [2/2]

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

Set the aspect ratio of the rendered image.

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

◆ ComputeAspect()

virtual void vtkViewport::ComputeAspect ( )
virtual

Set the aspect ratio of the rendered image.

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

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

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

◆ GetPixelAspect() [1/2]

virtual double* vtkViewport::GetPixelAspect ( )
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).

◆ GetPixelAspect() [2/2]

virtual void vtkViewport::GetPixelAspect ( double  data[2])
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).

◆ 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

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.

◆ GetViewport() [1/2]

virtual double* vtkViewport::GetViewport ( )
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.

◆ GetViewport() [2/2]

virtual void vtkViewport::GetViewport ( double  data[4])
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.

◆ 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

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.

◆ GetDisplayPoint() [1/2]

virtual double* vtkViewport::GetDisplayPoint ( )
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.

◆ GetDisplayPoint() [2/2]

virtual void vtkViewport::GetDisplayPoint ( double  data[3])
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.

◆ 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

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.

◆ GetViewPoint() [1/2]

virtual double* vtkViewport::GetViewPoint ( )
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.

◆ GetViewPoint() [2/2]

virtual void vtkViewport::GetViewPoint ( double  data[3])
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.

◆ 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

Specify a point location in world coordinates.

This method takes homogeneous coordinates.

◆ GetWorldPoint() [1/2]

virtual double* vtkViewport::GetWorldPoint ( )
virtual

Specify a point location in world coordinates.

This method takes homogeneous coordinates.

◆ GetWorldPoint() [2/2]

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

Specify a point location in world coordinates.

This method takes homogeneous coordinates.

◆ GetCenter()

virtual double* vtkViewport::GetCenter ( )
virtual

Return the center of this viewport in display coordinates.

◆ IsInViewport()

virtual vtkTypeBool 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() [1/2]

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 281 of file vtkViewport.h.

◆ WorldToDisplay() [1/2]

void vtkViewport::WorldToDisplay ( )
inline

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

Definition at line 290 of file vtkViewport.h.

◆ WorldToDisplay() [2/2]

void vtkViewport::WorldToDisplay ( double &  x,
double &  y,
double &  z 
)
inline

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

Definition at line 299 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

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

◆ NormalizedDisplayToViewport()

virtual void vtkViewport::NormalizedDisplayToViewport ( 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)).

◆ ViewportToNormalizedViewport()

virtual void vtkViewport::ViewportToNormalizedViewport ( double &  u,
double &  v 
)
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)).

◆ NormalizedViewportToView()

virtual void vtkViewport::NormalizedViewportToView ( double &  x,
double &  y,
double &  z 
)
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)).

◆ ViewToPose()

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

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

Reimplemented in vtkRenderer.

Definition at line 318 of file vtkViewport.h.

◆ PoseToWorld()

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

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

Reimplemented in vtkRenderer.

Definition at line 319 of file vtkViewport.h.

◆ DisplayToLocalDisplay()

virtual void vtkViewport::DisplayToLocalDisplay ( 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)).

◆ NormalizedDisplayToDisplay()

virtual void vtkViewport::NormalizedDisplayToDisplay ( double &  u,
double &  v 
)
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)).

◆ ViewportToNormalizedDisplay()

virtual void vtkViewport::ViewportToNormalizedDisplay ( 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)).

◆ NormalizedViewportToViewport()

virtual void vtkViewport::NormalizedViewportToViewport ( double &  u,
double &  v 
)
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)).

◆ ViewToNormalizedViewport()

virtual void vtkViewport::ViewToNormalizedViewport ( double &  x,
double &  y,
double &  z 
)
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)).

◆ PoseToView()

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

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

Reimplemented in vtkRenderer.

Definition at line 325 of file vtkViewport.h.

◆ WorldToPose()

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

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

Reimplemented in vtkRenderer.

Definition at line 326 of file vtkViewport.h.

◆ ViewToWorld() [2/2]

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

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

Reimplemented in vtkRenderer.

Definition at line 327 of file vtkViewport.h.

◆ WorldToView() [2/2]

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

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

Reimplemented in vtkRenderer.

Definition at line 328 of file vtkViewport.h.

◆ ViewToDisplay() [2/2]

virtual void vtkViewport::ViewToDisplay ( double &  x,
double &  y,
double &  z 
)
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)).

◆ 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

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

◆ GetTiledSize()

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

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

◆ GetTiledSizeAndOrigin()

virtual void vtkViewport::GetTiledSizeAndOrigin ( int *  width,
int *  height,
int *  lowerLeftX,
int *  lowerLeftY 
)
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).

◆ PickProp() [1/4]

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/4]

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/4]

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/4]

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.

◆ PickProp() [3/4]

virtual vtkAssemblyPath* vtkViewport::PickProp ( double  selectionX,
double  selectionY,
int  fieldAssociation,
vtkSmartPointer< vtkSelection selection 
)
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. Additionally, you can set the field association of the hardware selector used internally, and get its selection result by passing a non-null vtkSmartPointer<vtkSelection>.

Implemented in vtkRenderer.

◆ PickProp() [4/4]

virtual vtkAssemblyPath* vtkViewport::PickProp ( double  selectionX1,
double  selectionY1,
double  selectionX2,
double  selectionY2,
int  fieldAssociation,
vtkSmartPointer< vtkSelection selection 
)
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. Additionally, you can set the field association of the hardware selector used internally, and get its selection result by passing a non-null vtkSmartPointer<vtkSelection>.

Implemented in vtkRenderer.

◆ PickPropFrom() [3/4]

vtkAssemblyPath* vtkViewport::PickPropFrom ( double  selectionX,
double  selectionY,
vtkPropCollection ,
int  fieldAssociation,
vtkSmartPointer< vtkSelection selection 
)

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. Additionally, you can set the field association of the hardware selector used internally, and get its selection result by passing a non-null vtkSmartPointer<vtkSelection>.

◆ PickPropFrom() [4/4]

vtkAssemblyPath* vtkViewport::PickPropFrom ( double  selectionX1,
double  selectionY1,
double  selectionX2,
double  selectionY2,
vtkPropCollection ,
int  fieldAssociation,
vtkSmartPointer< vtkSelection selection 
)

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. Additionally, you can set the field association of the hardware selector used internally, and get its selection result by passing a non-null vtkSmartPointer<vtkSelection>.

◆ 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 429 of file vtkViewport.h.

◆ GetPickY()

double vtkViewport::GetPickY ( ) 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 430 of file vtkViewport.h.

◆ GetPickWidth()

double vtkViewport::GetPickWidth ( ) 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 431 of file vtkViewport.h.

◆ GetPickHeight()

double vtkViewport::GetPickHeight ( ) 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 432 of file vtkViewport.h.

◆ GetPickX1()

double vtkViewport::GetPickX1 ( ) 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 433 of file vtkViewport.h.

◆ GetPickY1()

double vtkViewport::GetPickY1 ( ) 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 434 of file vtkViewport.h.

◆ GetPickX2()

double vtkViewport::GetPickX2 ( ) 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 435 of file vtkViewport.h.

◆ GetPickY2()

double vtkViewport::GetPickY2 ( ) 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 436 of file vtkViewport.h.

◆ GetPickResultProps()

virtual vtkPropCollection* vtkViewport::GetPickResultProps ( )
virtual

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

◆ GetPickedZ()

virtual double vtkViewport::GetPickedZ ( )
inlinevirtual

Return the Z value for the last picked Prop.

Definition at line 443 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

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

Note this is currently ignored outside of RayTracing.

◆ GetEnvironmentalBG() [1/3]

virtual double* vtkViewport::GetEnvironmentalBG ( )
virtual

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

Note this is currently ignored outside of RayTracing.

◆ GetEnvironmentalBG() [2/3]

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

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

Note this is currently ignored outside of RayTracing.

◆ GetEnvironmentalBG() [3/3]

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

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

Note this is currently ignored outside of RayTracing.

◆ 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

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

Note this is currently ignored outside of RayTracing.

◆ GetEnvironmentalBG2() [1/3]

virtual double* vtkViewport::GetEnvironmentalBG2 ( )
virtual

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

Note this is currently ignored outside of RayTracing.

◆ GetEnvironmentalBG2() [2/3]

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

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

Note this is currently ignored outside of RayTracing.

◆ GetEnvironmentalBG2() [3/3]

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

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

Note this is currently ignored outside of RayTracing.

◆ 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

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.

◆ GradientEnvironmentalBGOn()

virtual void vtkViewport::GradientEnvironmentalBGOn ( )
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.

◆ GradientEnvironmentalBGOff()

virtual void vtkViewport::GradientEnvironmentalBGOff ( )
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.

Member Data Documentation

◆ PickedProp

vtkAssemblyPath* vtkViewport::PickedProp
protected

Definition at line 483 of file vtkViewport.h.

◆ PickFromProps

vtkPropCollection* vtkViewport::PickFromProps
protected

Definition at line 484 of file vtkViewport.h.

◆ PickResultProps

vtkPropCollection* vtkViewport::PickResultProps
protected

Definition at line 485 of file vtkViewport.h.

◆ PickX1

double vtkViewport::PickX1
protected

Definition at line 486 of file vtkViewport.h.

◆ PickY1

double vtkViewport::PickY1
protected

Definition at line 487 of file vtkViewport.h.

◆ PickX2

double vtkViewport::PickX2
protected

Definition at line 488 of file vtkViewport.h.

◆ PickY2

double vtkViewport::PickY2
protected

Definition at line 489 of file vtkViewport.h.

◆ PickedZ

double vtkViewport::PickedZ
protected

Definition at line 490 of file vtkViewport.h.

◆ Props

vtkPropCollection* vtkViewport::Props
protected

Definition at line 493 of file vtkViewport.h.

◆ Actors2D

vtkActor2DCollection* vtkViewport::Actors2D
protected

Definition at line 494 of file vtkViewport.h.

◆ VTKWindow

vtkWindow* vtkViewport::VTKWindow
protected

Definition at line 495 of file vtkViewport.h.

◆ Background

double vtkViewport::Background[3]
protected

Definition at line 496 of file vtkViewport.h.

◆ Background2

double vtkViewport::Background2[3]
protected

Definition at line 497 of file vtkViewport.h.

◆ BackgroundAlpha

double vtkViewport::BackgroundAlpha
protected

Definition at line 498 of file vtkViewport.h.

◆ Viewport

double vtkViewport::Viewport[4]
protected

Definition at line 499 of file vtkViewport.h.

◆ Aspect

double vtkViewport::Aspect[2]
protected

Definition at line 500 of file vtkViewport.h.

◆ PixelAspect

double vtkViewport::PixelAspect[2]
protected

Definition at line 501 of file vtkViewport.h.

◆ Center

double vtkViewport::Center[2]
protected

Definition at line 502 of file vtkViewport.h.

◆ GradientBackground

bool vtkViewport::GradientBackground
protected

Definition at line 503 of file vtkViewport.h.

◆ DitherGradient

bool vtkViewport::DitherGradient
protected

Definition at line 504 of file vtkViewport.h.

◆ GradientMode

GradientModes vtkViewport::GradientMode = GradientModes::VTK_GRADIENT_VERTICAL
protected

Definition at line 505 of file vtkViewport.h.

◆ EnvironmentalBG

double vtkViewport::EnvironmentalBG[3]
protected

Definition at line 507 of file vtkViewport.h.

◆ EnvironmentalBG2

double vtkViewport::EnvironmentalBG2[3]
protected

Definition at line 508 of file vtkViewport.h.

◆ GradientEnvironmentalBG

bool vtkViewport::GradientEnvironmentalBG
protected

Definition at line 509 of file vtkViewport.h.

◆ Size

int vtkViewport::Size[2]
protected

Definition at line 511 of file vtkViewport.h.

◆ Origin

int vtkViewport::Origin[2]
protected

Definition at line 512 of file vtkViewport.h.

◆ DisplayPoint

double vtkViewport::DisplayPoint[3]
protected

Definition at line 513 of file vtkViewport.h.

◆ ViewPoint

double vtkViewport::ViewPoint[3]
protected

Definition at line 514 of file vtkViewport.h.

◆ WorldPoint

double vtkViewport::WorldPoint[4]
protected

Definition at line 515 of file vtkViewport.h.


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