Main Page | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members | Related Pages

vtkViewport Class Reference

#include <vtkViewport.h>

Inheritance diagram for vtkViewport:

Inheritance graph
[legend]
Collaboration diagram for vtkViewport:

Collaboration graph
[legend]
List of all members.

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

Public Types

typedef vtkObject Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void AddViewProp (vtkProp *)
vtkPropCollectionGetViewProps ()
int HasViewProp (vtkProp *)
void RemoveViewProp (vtkProp *)
virtual double * GetCenter ()
virtual int IsInViewport (int x, int y)
virtual vtkWindowGetVTKWindow ()=0
virtual void DisplayToView ()
virtual void ViewToDisplay ()
virtual void WorldToView ()
virtual void ViewToWorld ()
void DisplayToWorld ()
virtual double GetPickedZ ()=0
void RemoveProp (vtkProp *)
void AddProp (vtkProp *)
vtkPropCollectionGetProps ()
int HasProp (vtkProp *)
void RemoveAllProps ()
void RemoveAllViewProps (void)
void AddActor2D (vtkProp *p)
void RemoveActor2D (vtkProp *p)
vtkActor2DCollectionGetActors2D ()
virtual void SetBackground (double, double, double)
virtual void SetBackground (double[3])
virtual double * GetBackground ()
virtual void GetBackground (double &, double &, double &)
virtual void GetBackground (double[3])
virtual void SetAspect (double, double)
void SetAspect (double[2])
virtual double * GetAspect ()
virtual void GetAspect (double data[2])
virtual void ComputeAspect ()
virtual void SetPixelAspect (double, double)
void SetPixelAspect (double[2])
virtual double * GetPixelAspect ()
virtual void GetPixelAspect (double data[2])
virtual void SetViewport (double, double, double, double)
virtual void SetViewport (double[4])
virtual double * GetViewport ()
virtual void GetViewport (double data[4])
virtual void SetDisplayPoint (double, double, double)
virtual void SetDisplayPoint (double[3])
virtual double * GetDisplayPoint ()
virtual void GetDisplayPoint (double data[3])
virtual void SetViewPoint (double, double, double)
virtual void SetViewPoint (double[3])
virtual double * GetViewPoint ()
virtual void GetViewPoint (double data[3])
virtual void SetWorldPoint (double, double, double, double)
virtual void SetWorldPoint (double[4])
virtual double * GetWorldPoint ()
virtual void GetWorldPoint (double data[4])
void WorldToDisplay ()
virtual void LocalDisplayToDisplay (double &x, double &y)
virtual void DisplayToNormalizedDisplay (double &u, double &v)
virtual void NormalizedDisplayToViewport (double &x, double &y)
virtual void ViewportToNormalizedViewport (double &u, double &v)
virtual void NormalizedViewportToView (double &x, double &y, double &z)
virtual void ViewToWorld (double &, double &, double &)
virtual void DisplayToLocalDisplay (double &x, double &y)
virtual void NormalizedDisplayToDisplay (double &u, double &v)
virtual void ViewportToNormalizedDisplay (double &x, double &y)
virtual void NormalizedViewportToViewport (double &u, double &v)
virtual void ViewToNormalizedViewport (double &x, double &y, double &z)
virtual void WorldToView (double &, double &, double &)
int * GetSize ()
int * GetOrigin ()
void GetTiledSize (int *width, int *height)
void GetTiledSizeAndOrigin (int *width, int *height, int *lowerLeftX, int *lowerLeftY)
virtual vtkAssemblyPathPickProp (double selectionX, double selectionY)=0
vtkAssemblyPathPickPropFrom (double selectionX, double selectionY, vtkPropCollection *)
virtual double GetPickX ()
virtual double GetPickY ()
virtual int GetIsPicking ()

Static Public Member Functions

static int IsTypeOf (const char *type)
static vtkViewportSafeDownCast (vtkObject *o)

Protected Member Functions

 vtkViewport ()
 ~vtkViewport ()
virtual void DevicePickRender ()=0
virtual void StartPick (unsigned int pickFromSize)=0
virtual void UpdatePickId ()=0
virtual void DonePick ()=0
virtual unsigned int GetPickedId ()=0

Protected Attributes

vtkAssemblyPathPickedProp
vtkPropCollectionPickFromProps
int IsPicking
unsigned int CurrentPickId
double PickX
double PickY
vtkPropCollectionProps
vtkActor2DCollectionActors2D
vtkWindowVTKWindow
double Background [3]
double Viewport [4]
double Aspect [2]
double PixelAspect [2]
double Center [2]
int Size [2]
int Origin [2]
double DisplayPoint [3]
double ViewPoint [3]
double WorldPoint [4]


Member Typedef Documentation

typedef vtkObject vtkViewport::Superclass
 

Reimplemented from vtkObject.

Reimplemented in vtkMesaRenderer, vtkOpenGLRenderer, and vtkRenderer.

Definition at line 48 of file vtkViewport.h.


Constructor & Destructor Documentation

vtkViewport::vtkViewport  )  [protected]
 

vtkViewport::~vtkViewport  )  [protected]
 


Member Function Documentation

virtual const char* vtkViewport::GetClassName  )  [virtual]
 

Reimplemented from vtkObject.

Reimplemented in vtkMesaRenderer, vtkOpenGLRenderer, and vtkRenderer.

static int vtkViewport::IsTypeOf const char *  type  )  [static]
 

Return 1 if this class type is the same type of (or a subclass of) the named class. Returns 0 otherwise. This method works in combination with vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkMesaRenderer, vtkOpenGLRenderer, and vtkRenderer.

virtual int vtkViewport::IsA const char *  type  )  [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 vtkTypeRevisionMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkMesaRenderer, vtkOpenGLRenderer, and vtkRenderer.

static vtkViewport* vtkViewport::SafeDownCast vtkObject o  )  [static]
 

Reimplemented from vtkObject.

Reimplemented in vtkMesaRenderer, vtkOpenGLRenderer, and vtkRenderer.

void vtkViewport::PrintSelf ostream &  os,
vtkIndent  indent
[virtual]
 

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 vtkMesaRenderer, vtkOpenGLRenderer, and vtkRenderer.

void vtkViewport::AddViewProp vtkProp  ) 
 

Add a prop to the list of props. 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 56 of file vtkViewport.h.

int vtkViewport::HasViewProp vtkProp  ) 
 

Query if a prop is in the list of props.

void vtkViewport::RemoveViewProp vtkProp  ) 
 

Remove an actor from the list of actors.

void vtkViewport::RemoveAllViewProps void   ) 
 

Remove all actors from the list of actors.

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  ) 
 

Remove all actors from the list of actors.

vtkActor2DCollection* vtkViewport::GetActors2D  ) 
 

Remove all actors from the list of actors.

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

void vtkViewport::WorldToDisplay  )  [inline]
 

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

Definition at line 155 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]
 

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

virtual void vtkViewport::NormalizedDisplayToViewport double &  x,
double &  y
[virtual]
 

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

virtual void vtkViewport::ViewportToNormalizedViewport double &  u,
double &  v
[virtual]
 

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

virtual void vtkViewport::NormalizedViewportToView double &  x,
double &  y,
double &  z
[virtual]
 

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

virtual void vtkViewport::ViewToWorld double &  ,
double &  ,
double & 
[inline, virtual]
 

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

Reimplemented in vtkRenderer.

Definition at line 168 of file vtkViewport.h.

virtual void vtkViewport::DisplayToLocalDisplay double &  x,
double &  y
[virtual]
 

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

virtual void vtkViewport::NormalizedDisplayToDisplay double &  u,
double &  v
[virtual]
 

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

virtual void vtkViewport::ViewportToNormalizedDisplay double &  x,
double &  y
[virtual]
 

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

virtual void vtkViewport::NormalizedViewportToViewport double &  u,
double &  v
[virtual]
 

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

virtual void vtkViewport::ViewToNormalizedViewport double &  x,
double &  y,
double &  z
[virtual]
 

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

virtual void vtkViewport::WorldToView double &  ,
double &  ,
double & 
[inline, virtual]
 

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

Reimplemented in vtkRenderer.

Definition at line 174 of file vtkViewport.h.

int* vtkViewport::GetSize  ) 
 

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

int* vtkViewport::GetOrigin  ) 
 

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

void vtkViewport::GetTiledSizeAndOrigin int *  width,
int *  height,
int *  lowerLeftX,
int *  lowerLeftY
 

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.

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.

virtual double vtkViewport::GetPickX  )  [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::GetPickY  )  [virtual]
 

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

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 double vtkViewport::GetPickedZ  )  [pure virtual]
 

Return the Z value for the last picked Prop.

Implemented in vtkMesaRenderer, and vtkOpenGLRenderer.

void vtkViewport::RemoveProp vtkProp  ) 
 

Deprecated:
Replaced by vtkViewport::RemoveViewProp() as of VTK 5.0.

void vtkViewport::AddProp vtkProp  ) 
 

Deprecated:
Replaced by vtkViewport::AddViewProp() as of VTK 5.0.

vtkPropCollection* vtkViewport::GetProps  ) 
 

Deprecated:
Replaced by vtkViewport::GetViewProps() as of VTK 5.0.

int vtkViewport::HasProp vtkProp  ) 
 

Deprecated:
Replaced by vtkViewport::HasViewProp() as of VTK 5.0.

void vtkViewport::RemoveAllProps  ) 
 

Deprecated:
Replaced by vtkViewport::RemoveAllViewProps() as of VTK 5.0.

virtual void vtkViewport::DevicePickRender  )  [protected, pure virtual]
 

Implemented in vtkMesaRenderer, and vtkOpenGLRenderer.

virtual void vtkViewport::StartPick unsigned int  pickFromSize  )  [protected, pure virtual]
 

Implemented in vtkMesaRenderer, and vtkOpenGLRenderer.

virtual void vtkViewport::UpdatePickId  )  [protected, pure virtual]
 

Implemented in vtkMesaRenderer, and vtkOpenGLRenderer.

virtual void vtkViewport::DonePick  )  [protected, pure virtual]
 

Implemented in vtkMesaRenderer, and vtkOpenGLRenderer.

virtual unsigned int vtkViewport::GetPickedId  )  [protected, pure virtual]
 

Implemented in vtkMesaRenderer, and vtkOpenGLRenderer.


Member Data Documentation

vtkAssemblyPath* vtkViewport::PickedProp [protected]
 

Definition at line 270 of file vtkViewport.h.

vtkPropCollection* vtkViewport::PickFromProps [protected]
 

Definition at line 271 of file vtkViewport.h.

int vtkViewport::IsPicking [protected]
 

Definition at line 273 of file vtkViewport.h.

unsigned int vtkViewport::CurrentPickId [protected]
 

Definition at line 274 of file vtkViewport.h.

double vtkViewport::PickX [protected]
 

Definition at line 275 of file vtkViewport.h.

double vtkViewport::PickY [protected]
 

Definition at line 276 of file vtkViewport.h.

vtkPropCollection* vtkViewport::Props [protected]
 

Definition at line 279 of file vtkViewport.h.

vtkActor2DCollection* vtkViewport::Actors2D [protected]
 

Definition at line 280 of file vtkViewport.h.

vtkWindow* vtkViewport::VTKWindow [protected]
 

Definition at line 281 of file vtkViewport.h.

double vtkViewport::Background[3] [protected]
 

Definition at line 282 of file vtkViewport.h.

double vtkViewport::Viewport[4] [protected]
 

Definition at line 283 of file vtkViewport.h.

double vtkViewport::Aspect[2] [protected]
 

Definition at line 284 of file vtkViewport.h.

double vtkViewport::PixelAspect[2] [protected]
 

Definition at line 285 of file vtkViewport.h.

double vtkViewport::Center[2] [protected]
 

Definition at line 286 of file vtkViewport.h.

int vtkViewport::Size[2] [protected]
 

Definition at line 288 of file vtkViewport.h.

int vtkViewport::Origin[2] [protected]
 

Definition at line 289 of file vtkViewport.h.

double vtkViewport::DisplayPoint[3] [protected]
 

Definition at line 290 of file vtkViewport.h.

double vtkViewport::ViewPoint[3] [protected]
 

Definition at line 291 of file vtkViewport.h.

double vtkViewport::WorldPoint[4] [protected]
 

Definition at line 292 of file vtkViewport.h.


The documentation for this class was generated from the following file:
Generated on Tue Jan 22 00:28:14 2008 for VTK by  doxygen 1.4.3-20050530