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 Types inherited from vtkObject
typedef vtkObjectBase 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 *)
 
void RemoveAllViewProps (void)
 
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 ()
 
void WorldToDisplay ()
 
virtual vtkAssemblyPathPickProp (double selectionX, double selectionY)=0
 
virtual double GetPickedZ ()=0
 
void RemoveProp (vtkProp *)
 
void AddProp (vtkProp *)
 
vtkPropCollectionGetProps ()
 
int HasProp (vtkProp *)
 
void RemoveAllProps ()
 
void AddActor2D (vtkProp *p)
 
void RemoveActor2D (vtkProp *p)
 
vtkActor2DCollection * GetActors2D ()
 
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 SetBackground2 (double, double, double)
 
virtual void SetBackground2 (double[3])
 
virtual double * GetBackground2 ()
 
virtual void GetBackground2 (double &, double &, double &)
 
virtual void GetBackground2 (double[3])
 
virtual void SetGradientBackground (bool)
 
virtual bool GetGradientBackground ()
 
virtual void GradientBackgroundOn ()
 
virtual void GradientBackgroundOff ()
 
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])
 
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 &)
 
virtual int * GetSize ()
 
virtual int * GetOrigin ()
 
void GetTiledSize (int *width, int *height)
 
virtual void GetTiledSizeAndOrigin (int *width, int *height, int *lowerLeftX, int *lowerLeftY)
 
vtkAssemblyPathPickPropFrom (double selectionX, double selectionY, vtkPropCollection *)
 
double GetPickX () const
 
double GetPickY () const
 
double GetPickWidth () const
 
double GetPickHeight () const
 
double GetPickX1 () const
 
double GetPickY1 () const
 
double GetPickX2 () const
 
double GetPickY2 () const
 
virtual int GetIsPicking ()
 
virtual vtkPropCollectionGetPickResultProps ()
 
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
 
virtual void DebugOff ()
 
unsigned char GetDebug ()
 
void SetDebug (unsigned char debugFlag)
 
virtual void Modified ()
 
virtual unsigned long GetMTime ()
 
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
 
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
 
vtkCommandGetCommand (unsigned long tag)
 
void RemoveObserver (vtkCommand *)
 
void RemoveObservers (unsigned long event, vtkCommand *)
 
void RemoveObservers (const char *event, vtkCommand *)
 
int HasObserver (unsigned long event, vtkCommand *)
 
int HasObserver (const char *event, vtkCommand *)
 
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)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
 
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
 
int InvokeEvent (unsigned long event, void *callData)
 
int InvokeEvent (const char *event, void *callData)
 
int InvokeEvent (unsigned long event)
 
int InvokeEvent (const char *event)
 
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
 
virtual void Delete ()
 
virtual void FastDelete ()
 
void Print (ostream &os)
 
virtual void Register (vtkObjectBase *o)
 
virtual void UnRegister (vtkObjectBase *o)
 
void SetReferenceCount (int)
 
void PrintRevisions (ostream &os)
 
virtual void PrintHeader (ostream &os, vtkIndent indent)
 
virtual void PrintTrailer (ostream &os, vtkIndent indent)
 
int GetReferenceCount ()
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkViewportSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkObject
static int IsTypeOf (const char *type)
 
static vtkObjectSafeDownCast (vtkObject *o)
 
static vtkObjectNew ()
 
static void BreakOnError ()
 
static void SetGlobalWarningDisplay (int val)
 
static void GlobalWarningDisplayOn ()
 
static void GlobalWarningDisplayOff ()
 
static int GetGlobalWarningDisplay ()
 
- Static Public Member Functions inherited from vtkObjectBase
static int IsTypeOf (const char *name)
 
static vtkObjectBaseNew ()
 

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
 
virtual unsigned int GetNumPickedIds ()=0
 
virtual int GetPickedIds (unsigned int atMost, unsigned int *callerBuffer)=0
 
- Protected Member Functions inherited from vtkObject
 vtkObject ()
 
virtual ~vtkObject ()
 
virtual void RegisterInternal (vtkObjectBase *, int check)
 
virtual void UnRegisterInternal (vtkObjectBase *, int check)
 
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
 
void InternalReleaseFocus ()
 
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
 
virtual ~vtkObjectBase ()
 
virtual void CollectRevisions (ostream &os)
 
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
 
vtkActor2DCollection * Actors2D
 
vtkWindowVTKWindow
 
double Background [3]
 
double Background2 [3]
 
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
unsigned char Debug
 
vtkTimeStamp MTime
 
vtkSubjectHelper * SubjectHelper
 
- Protected Attributes inherited from vtkObjectBase
int 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 45 of file vtkViewport.h.

Member Typedef Documentation

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.

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

static vtkViewport* vtkViewport::SafeDownCast ( vtkObject o)
static
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.

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)

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::SetGradientBackground ( bool  )
virtual

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

virtual bool vtkViewport::GetGradientBackground ( )
virtual

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

virtual void vtkViewport::GradientBackgroundOn ( )
virtual

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

virtual void vtkViewport::GradientBackgroundOff ( )
virtual

Set/Get whether this viewport should have a gradient background using the Background (top) and Background2 (bottom) 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.

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.

virtual void vtkViewport::ViewToWorld ( )
virtual

Convert view point coordinates to world coordinates.

void vtkViewport::DisplayToWorld ( )
inline

Convert display (or screen) coordinates to world coordinates.

Definition at line 167 of file vtkViewport.h.

void vtkViewport::WorldToDisplay ( )
inline

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

Definition at line 170 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)).

Definition at line 183 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)).

Definition at line 189 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.

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.

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 224 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 225 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 226 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 227 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 228 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 229 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 230 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 231 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 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.

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 ( )
virtual void vtkViewport::DevicePickRender ( )
protectedpure virtual
virtual void vtkViewport::StartPick ( unsigned int  pickFromSize)
protectedpure virtual
virtual void vtkViewport::UpdatePickId ( )
protectedpure virtual
virtual void vtkViewport::DonePick ( )
protectedpure virtual
virtual unsigned int vtkViewport::GetPickedId ( )
protectedpure virtual
virtual unsigned int vtkViewport::GetNumPickedIds ( )
protectedpure virtual
virtual int vtkViewport::GetPickedIds ( unsigned int  atMost,
unsigned int *  callerBuffer 
)
protectedpure virtual

Member Data Documentation

vtkAssemblyPath* vtkViewport::PickedProp
protected

Definition at line 297 of file vtkViewport.h.

vtkPropCollection* vtkViewport::PickFromProps
protected

Definition at line 298 of file vtkViewport.h.

vtkPropCollection* vtkViewport::PickResultProps
protected

Definition at line 299 of file vtkViewport.h.

int vtkViewport::IsPicking
protected

Definition at line 301 of file vtkViewport.h.

unsigned int vtkViewport::CurrentPickId
protected

Definition at line 302 of file vtkViewport.h.

double vtkViewport::PickX1
protected

Definition at line 303 of file vtkViewport.h.

double vtkViewport::PickY1
protected

Definition at line 304 of file vtkViewport.h.

double vtkViewport::PickX2
protected

Definition at line 305 of file vtkViewport.h.

double vtkViewport::PickY2
protected

Definition at line 306 of file vtkViewport.h.

vtkPropCollection* vtkViewport::Props
protected

Definition at line 309 of file vtkViewport.h.

vtkActor2DCollection* vtkViewport::Actors2D
protected

Definition at line 310 of file vtkViewport.h.

vtkWindow* vtkViewport::VTKWindow
protected

Definition at line 311 of file vtkViewport.h.

double vtkViewport::Background[3]
protected

Definition at line 312 of file vtkViewport.h.

double vtkViewport::Background2[3]
protected

Definition at line 313 of file vtkViewport.h.

double vtkViewport::Viewport[4]
protected

Definition at line 314 of file vtkViewport.h.

double vtkViewport::Aspect[2]
protected

Definition at line 315 of file vtkViewport.h.

double vtkViewport::PixelAspect[2]
protected

Definition at line 316 of file vtkViewport.h.

double vtkViewport::Center[2]
protected

Definition at line 317 of file vtkViewport.h.

bool vtkViewport::GradientBackground
protected

Definition at line 318 of file vtkViewport.h.

int vtkViewport::Size[2]
protected

Definition at line 320 of file vtkViewport.h.

int vtkViewport::Origin[2]
protected

Definition at line 321 of file vtkViewport.h.

double vtkViewport::DisplayPoint[3]
protected

Definition at line 322 of file vtkViewport.h.

double vtkViewport::ViewPoint[3]
protected

Definition at line 323 of file vtkViewport.h.

double vtkViewport::WorldPoint[4]
protected

Definition at line 324 of file vtkViewport.h.


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