VTK
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

typedef vtkObject Superclass
 

Public Member Functions

virtual int 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...
 
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...
 
virtual doubleGetCenter ()
 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 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...
 
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 double GetPickedZ ()=0
 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 doubleGetBackground ()
 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 doubleGetBackground2 ()
 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 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 doubleGetAspect ()
 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 doubleGetPixelAspect ()
 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 doubleGetViewport ()
 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 doubleGetDisplayPoint ()
 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 doubleGetViewPoint ()
 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 doubleGetWorldPoint ()
 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 ViewToWorld (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 WorldToView (double &, double &, double &)
 These methods map from one coordinate system to another. More...
 
virtual intGetSize ()
 Get the size and origin of the viewport in display coordinates. More...
 
virtual intGetOrigin ()
 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 int GetIsPicking ()
 Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY). More...
 
virtual unsigned int GetCurrentPickId ()
 Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY). More...
 
void SetCurrentPickId (unsigned int a)
 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...
 
- 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 ()
 
int HasObserver (unsigned long event)
 
int HasObserver (const char *event)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
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...
 
int HasObserver (unsigned long event, vtkCommand *)
 Allow people to add/remove/invoke observers (callbacks) to any VTK object. More...
 
int 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...
 
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)
 This method invokes an event and return whether the event was aborted or not. More...
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 Return the class name as a string. 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 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...
 
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...
 

Static Public Member Functions

static int 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 (int 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 int 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 vtkObjectBaseNew ()
 Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More...
 

Protected Member Functions

virtual vtkObjectBaseNewInstanceInternal () const
 
 vtkViewport ()
 
 ~vtkViewport () override
 
virtual void DevicePickRender ()=0
 
virtual void StartPick (unsigned int pickFromSize)=0
 
virtual void UpdatePickId ()=0
 
virtual void DonePick ()=0
 
virtual unsigned int GetPickedId ()=0
 
virtual unsigned int GetNumPickedIds ()=0
 
virtual int GetPickedIds (unsigned int atMost, unsigned int *callerBuffer)=0
 
- 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 CollectRevisions (ostream &)
 
virtual void ReportReferences (vtkGarbageCollector *)
 
 vtkObjectBase (const vtkObjectBase &)
 
void operator= (const vtkObjectBase &)
 

Protected Attributes

vtkAssemblyPathPickedProp
 
vtkPropCollectionPickFromProps
 
vtkPropCollectionPickResultProps
 
int IsPicking
 
unsigned int CurrentPickId
 
double PickX1
 
double PickY1
 
double PickX2
 
double PickY2
 
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
 
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
vtkAtomicInt32 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
Tests:
vtkViewport (Tests)

Definition at line 47 of file vtkViewport.h.

Member Typedef Documentation

Definition at line 50 of file vtkViewport.h.

Constructor & Destructor Documentation

vtkViewport::vtkViewport ( )
protected
vtkViewport::~vtkViewport ( )
overrideprotected

Member Function Documentation

static int vtkViewport::IsTypeOf ( const char *  type)
static
virtual int 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, vtkExternalOpenGLRenderer, vtkOpenGLRenderer, vtkOpenGLRenderer, vtkOpenVRRenderer, and vtkOculusRenderer.

static vtkViewport* vtkViewport::SafeDownCast ( vtkObjectBase o)
static
virtual vtkObjectBase* vtkViewport::NewInstanceInternal ( ) const
protectedvirtual
vtkViewport* vtkViewport::NewInstance ( ) const
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 vtkExternalOpenGLRenderer, vtkOpenGLRenderer, vtkOpenGLRenderer, and vtkOpenVRRenderer.

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.

vtkPropCollection* vtkViewport::GetViewProps ( )
inline

Return any props in this viewport.

Definition at line 63 of file vtkViewport.h.

int vtkViewport::HasViewProp ( vtkProp )

Query if a prop is in the list of props.

void vtkViewport::RemoveViewProp ( vtkProp )

Remove a prop from the list of props.

Does nothing if the prop is not already present.

void vtkViewport::RemoveAllViewProps ( void  )

Remove all props from the list of props.

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.

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.

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.

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

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

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

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

virtual double* vtkViewport::GetBackground ( )
virtual

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

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

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

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

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

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.

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.

virtual double* vtkViewport::GetBackground2 ( )
virtual

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

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.

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.

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.

virtual double vtkViewport::GetBackgroundAlpha ( )
virtual

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

By default, this is set to 0.0.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

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

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

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

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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

Specify a point location in world coordinates.

This method takes homogeneous coordinates.

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

Specify a point location in world coordinates.

This method takes homogeneous coordinates.

virtual double* vtkViewport::GetWorldPoint ( )
virtual

Specify a point location in world coordinates.

This method takes homogeneous coordinates.

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

Specify a point location in world coordinates.

This method takes homogeneous coordinates.

virtual double* vtkViewport::GetCenter ( )
virtual

Return the center of this viewport in display coordinates.

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

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

virtual vtkWindow* vtkViewport::GetVTKWindow ( )
pure virtual

Return the vtkWindow that owns this vtkViewport.

Implemented in vtkRenderer.

virtual void vtkViewport::DisplayToView ( )
virtual

Convert display coordinates to view coordinates.

virtual void vtkViewport::ViewToDisplay ( )
virtual

Convert view coordinates to display coordinates.

virtual void vtkViewport::WorldToView ( )
virtual

Convert world point coordinates to view coordinates.

Reimplemented in vtkRenderer.

virtual void vtkViewport::ViewToWorld ( )
virtual

Convert view point coordinates to world coordinates.

Reimplemented in vtkRenderer.

void vtkViewport::DisplayToWorld ( )
inline

Convert display (or screen) coordinates to world coordinates.

Definition at line 228 of file vtkViewport.h.

void vtkViewport::WorldToDisplay ( )
inline

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

Definition at line 233 of file vtkViewport.h.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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.

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.

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.

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

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

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

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

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

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

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

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

virtual int vtkViewport::GetIsPicking ( )
virtual

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

virtual unsigned int vtkViewport::GetCurrentPickId ( )
virtual

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

void vtkViewport::SetCurrentPickId ( unsigned int  a)
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 323 of file vtkViewport.h.

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

virtual double vtkViewport::GetPickedZ ( )
pure virtual

Return the Z value for the last picked Prop.

Implemented in vtkOpenGLRenderer, and vtkOpenGLRenderer.

virtual void vtkViewport::DevicePickRender ( )
protectedpure virtual

Implemented in vtkOpenGLRenderer, and vtkOpenGLRenderer.

virtual void vtkViewport::StartPick ( unsigned int  pickFromSize)
protectedpure virtual

Implemented in vtkOpenGLRenderer, and vtkOpenGLRenderer.

virtual void vtkViewport::UpdatePickId ( )
protectedpure virtual

Implemented in vtkOpenGLRenderer, and vtkOpenGLRenderer.

virtual void vtkViewport::DonePick ( )
protectedpure virtual

Implemented in vtkOpenGLRenderer, and vtkOpenGLRenderer.

virtual unsigned int vtkViewport::GetPickedId ( )
protectedpure virtual

Implemented in vtkOpenGLRenderer, and vtkOpenGLRenderer.

virtual unsigned int vtkViewport::GetNumPickedIds ( )
protectedpure virtual

Implemented in vtkOpenGLRenderer, and vtkOpenGLRenderer.

virtual int vtkViewport::GetPickedIds ( unsigned int  atMost,
unsigned int callerBuffer 
)
protectedpure virtual

Implemented in vtkOpenGLRenderer, and vtkOpenGLRenderer.

Member Data Documentation

vtkAssemblyPath* vtkViewport::PickedProp
protected

Definition at line 358 of file vtkViewport.h.

vtkPropCollection* vtkViewport::PickFromProps
protected

Definition at line 359 of file vtkViewport.h.

vtkPropCollection* vtkViewport::PickResultProps
protected

Definition at line 360 of file vtkViewport.h.

int vtkViewport::IsPicking
protected

Definition at line 362 of file vtkViewport.h.

unsigned int vtkViewport::CurrentPickId
protected

Definition at line 363 of file vtkViewport.h.

double vtkViewport::PickX1
protected

Definition at line 364 of file vtkViewport.h.

double vtkViewport::PickY1
protected

Definition at line 365 of file vtkViewport.h.

double vtkViewport::PickX2
protected

Definition at line 366 of file vtkViewport.h.

double vtkViewport::PickY2
protected

Definition at line 367 of file vtkViewport.h.

vtkPropCollection* vtkViewport::Props
protected

Definition at line 370 of file vtkViewport.h.

vtkActor2DCollection* vtkViewport::Actors2D
protected

Definition at line 371 of file vtkViewport.h.

vtkWindow* vtkViewport::VTKWindow
protected

Definition at line 372 of file vtkViewport.h.

double vtkViewport::Background[3]
protected

Definition at line 373 of file vtkViewport.h.

double vtkViewport::Background2[3]
protected

Definition at line 374 of file vtkViewport.h.

double vtkViewport::BackgroundAlpha
protected

Definition at line 375 of file vtkViewport.h.

double vtkViewport::Viewport[4]
protected

Definition at line 376 of file vtkViewport.h.

double vtkViewport::Aspect[2]
protected

Definition at line 377 of file vtkViewport.h.

double vtkViewport::PixelAspect[2]
protected

Definition at line 378 of file vtkViewport.h.

double vtkViewport::Center[2]
protected

Definition at line 379 of file vtkViewport.h.

bool vtkViewport::GradientBackground
protected

Definition at line 380 of file vtkViewport.h.

int vtkViewport::Size[2]
protected

Definition at line 382 of file vtkViewport.h.

int vtkViewport::Origin[2]
protected

Definition at line 383 of file vtkViewport.h.

double vtkViewport::DisplayPoint[3]
protected

Definition at line 384 of file vtkViewport.h.

double vtkViewport::ViewPoint[3]
protected

Definition at line 385 of file vtkViewport.h.

double vtkViewport::WorldPoint[4]
protected

Definition at line 386 of file vtkViewport.h.


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