Main Page   Class Hierarchy   Alphabetical List   Compound List   Compound Members   Related Pages  

vtkViewport Class Reference

abstract specification for Viewports. More...

#include <vtkViewport.h>

Inheritance diagram for vtkViewport:

Inheritance graph
[legend]
Collaboration diagram for vtkViewport:

Collaboration graph
[legend]
List of all members.

Public Methods

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void AddProp (vtkProp *)
vtkPropCollectionGetProps ()
void RemoveProp (vtkProp *)
void AddActor2D (vtkProp *p)
void RemoveActor2D (vtkProp *p)
vtkActor2DCollectionGetActors2D ()
virtual void SetBackground (float, float, float)
virtual void SetBackground (float[3])
virtual float * GetBackground ()
virtual void GetBackground (float data[3])
virtual void SetAspect (float, float)
void SetAspect (float[2])
virtual float * GetAspect ()
virtual void GetAspect (float data[2])
void ComputeAspect ()
virtual void SetViewport (float, float, float, float)
virtual void SetViewport (float[4])
virtual float * GetViewport ()
virtual void GetViewport (float data[4])
virtual void SetDisplayPoint (float, float, float)
virtual void SetDisplayPoint (float[3])
virtual float * GetDisplayPoint ()
virtual void GetDisplayPoint (float data[3])
void GetDisplayPoint (double *a)
virtual void SetViewPoint (float, float, float)
virtual void SetViewPoint (float[3])
virtual float * GetViewPoint ()
virtual void GetViewPoint (float data[3])
virtual void SetWorldPoint (float, float, float, float)
virtual void SetWorldPoint (float[4])
virtual float * GetWorldPoint ()
virtual void GetWorldPoint (float data[4])
void GetWorldPoint (double *a)
virtual float * GetCenter ()
virtual int IsInViewport (int x, int y)
virtual vtkWindowGetVTKWindow ()=0
void SetStartRenderMethod (void(*f)(void *), void *arg)
void SetEndRenderMethod (void(*f)(void *), void *arg)
void SetStartRenderMethodArgDelete (void(*f)(void *))
void SetEndRenderMethodArgDelete (void(*f)(void *))
virtual void DisplayToView ()
virtual void ViewToDisplay ()
virtual void WorldToView ()
virtual void ViewToWorld ()
void DisplayToWorld ()
void WorldToDisplay ()
virtual void LocalDisplayToDisplay (float &x, float &y)
virtual void DisplayToNormalizedDisplay (float &u, float &v)
virtual void NormalizedDisplayToViewport (float &x, float &y)
virtual void ViewportToNormalizedViewport (float &u, float &v)
virtual void NormalizedViewportToView (float &x, float &y, float &z)
virtual void ViewToWorld (float &, float &, float &)
virtual void DisplayToLocalDisplay (float &x, float &y)
virtual void NormalizedDisplayToDisplay (float &u, float &v)
virtual void ViewportToNormalizedDisplay (float &x, float &y)
virtual void NormalizedViewportToViewport (float &u, float &v)
virtual void ViewToNormalizedViewport (float &x, float &y, float &z)
virtual void WorldToView (float &, float &, float &)
int * GetSize ()
int * GetOrigin ()
virtual vtkAssemblyPathPickProp (float selectionX, float selectionY)=0
vtkAssemblyPathPickPropFrom (float selectionX, float selectionY, vtkPropCollection *)
virtual float GetPickX ()
virtual float GetPickY ()
virtual int GetIsPicking ()
virtual float GetPickedZ ()=0

Static Public Methods

int IsTypeOf (const char *type)
vtkViewport * SafeDownCast (vtkObject *o)

Protected Methods

 vtkViewport ()
 ~vtkViewport ()
 vtkViewport (const vtkViewport &)
void operator= (const 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
float PickX
float PickY
vtkPropCollectionProps
vtkActor2DCollectionActors2D
vtkWindowVTKWindow
float Background [3]
float Viewport [4]
float Aspect [2]
float Center [2]
unsigned long StartTag
unsigned long EndTag
int Size [2]
int Origin [2]
float DisplayPoint [3]
float ViewPoint [3]
float WorldPoint [4]

Detailed Description

abstract specification for Viewports.

Date:
2000/12/10 20:08:21
Revision:
1.30

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 vtkImager vtkRenderer


Member Function Documentation

void vtkViewport::AddActor2D vtkProp   p [inline]
 

Add/Remove different types of props to the renderer. These methods are all synonyms to AddProp and RemoveProp. They are here for convenience and backwards compatibility.

void vtkViewport::AddProp vtkProp  
 

Add a prop to the list of props. Prop is the superclass of all actors, volumes, 2D actors, composite props etc.

virtual void vtkViewport::DisplayToView   [virtual]
 

Convert display coordinates to view coordinates.

void vtkViewport::DisplayToWorld   [inline]
 

Convert display (or screen) coordinates to world coordinates.

virtual float* vtkViewport::GetCenter   [virtual]
 

Return the center of this viewport in display coordinates.

virtual const char* vtkViewport::GetClassName   [virtual]
 

Return the class name as a string. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkMesaRenderer.

virtual float vtkViewport::GetPickedZ   [pure virtual]
 

Return the Z value for the last picked Prop.

Implemented in vtkMesaRenderer.

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

vtkPropCollection* vtkViewport::GetProps   [inline]
 

Return any props in this viewport.

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

virtual vtkWindow* vtkViewport::GetVTKWindow   [pure virtual]
 

Return the vtkWindow that owns this vtkViewport.

Implemented in 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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkMesaRenderer.

virtual int vtkViewport::IsInViewport int    x,
int    y
[virtual]
 

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

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 vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkMesaRenderer.

virtual void vtkViewport::LocalDisplayToDisplay float &    x,
float &    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 vtkAssemblyPath* vtkViewport::PickProp float    selectionX,
float    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 float    selectionX,
float    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.

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.

void vtkViewport::RemoveProp vtkProp  
 

Remove an actor from the list of actors.

vtkViewport* vtkViewport::SafeDownCast vtkObject   o [static]
 

Will cast the supplied object to vtkObject* is this is a safe operation (i.e., a safe downcast); otherwise NULL is returned. This method is defined in all subclasses of vtkObject with the vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkObject.

Reimplemented in vtkMesaRenderer.

virtual void vtkViewport::SetAspect float   ,
float   
[virtual]
 

Set the aspect ratio of the rendered image. This is computed automatically and should not be set by the user.

virtual void vtkViewport::SetBackground float   ,
float   ,
float   
[virtual]
 

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

virtual void vtkViewport::SetDisplayPoint float   ,
float   ,
float   
[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.

void vtkViewport::SetEndRenderMethod void(*    f)(void *),
void *    arg
 

Specify a function to be called when rendering process completes. Function will be called with argument provided.

void vtkViewport::SetEndRenderMethodArgDelete void(*    f)(void *)
 

Set the arg delete method. This is used to free user memory.

void vtkViewport::SetStartRenderMethod void(*    f)(void *),
void *    arg
 

Specify a function to be called before rendering process begins. Function will be called with argument provided.

void vtkViewport::SetStartRenderMethodArgDelete void(*    f)(void *)
 

Set the arg delete method. This is used to free user memory.

virtual void vtkViewport::SetViewPoint float   ,
float   ,
float   
[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::SetViewport float   ,
float   ,
float   ,
float   
[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::SetWorldPoint float   ,
float   ,
float   ,
float   
[virtual]
 

Specify a point location in world coordinates. This method takes homogeneous coordinates.

virtual void vtkViewport::ViewToDisplay   [virtual]
 

Convert view coordinates to display coordinates.

virtual void vtkViewport::ViewToWorld   [virtual]
 

Convert view point coordinates to world coordinates.

Reimplemented in vtkRenderer.

void vtkViewport::WorldToDisplay   [inline]
 

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

virtual void vtkViewport::WorldToView   [virtual]
 

Convert world point coordinates to view coordinates.

Reimplemented in vtkRenderer.


The documentation for this class was generated from the following file:
Generated on Tue Mar 19 13:34:23 2002 for VTK by doxygen1.2.14 written by Dimitri van Heesch, © 1997-2002