abstract specification for Viewports More...
#include <vtkViewport.h>
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
| typedef vtkObject vtkViewport::Superclass |
Reimplemented from vtkObject.
Reimplemented in vtkRenderer, vtkMesaRenderer, and vtkOpenGLRenderer.
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 vtkRenderer, vtkMesaRenderer, and vtkOpenGLRenderer.
| static int vtkViewport::IsTypeOf | ( | const char * | name | ) | [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 vtkRenderer, vtkMesaRenderer, and vtkOpenGLRenderer.
| 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.
Reimplemented in vtkRenderer, vtkMesaRenderer, and vtkOpenGLRenderer.
| static vtkViewport* vtkViewport::SafeDownCast | ( | vtkObject * | o | ) | [static] |
Reimplemented from vtkObject.
Reimplemented in vtkRenderer, vtkMesaRenderer, and vtkOpenGLRenderer.
| 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 vtkRenderer, vtkMesaRenderer, and vtkOpenGLRenderer.
| 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 57 of file vtkViewport.h.
| 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.
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.
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.
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.
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.
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.
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).
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.
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.
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.
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.
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 169 of file vtkViewport.h.
| void vtkViewport::WorldToDisplay | ( | ) | [inline] |
Convert world point coordinates to display (or screen) coordinates.
Definition at line 172 of file vtkViewport.h.
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)).
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)).
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)).
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)).
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)).
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 185 of file vtkViewport.h.
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)).
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)).
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)).
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)).
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)).
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 191 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).
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.
| 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 226 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 227 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 228 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 229 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 230 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 231 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 232 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 233 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.
Implemented in vtkOpenGLRenderer, and vtkMesaRenderer.
| 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.
- 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 vtkOpenGLRenderer, and vtkMesaRenderer.
| virtual void vtkViewport::StartPick | ( | unsigned int | pickFromSize | ) | [protected, pure virtual] |
Implemented in vtkOpenGLRenderer, and vtkMesaRenderer.
| virtual void vtkViewport::UpdatePickId | ( | ) | [protected, pure virtual] |
Implemented in vtkOpenGLRenderer, and vtkMesaRenderer.
| virtual void vtkViewport::DonePick | ( | ) | [protected, pure virtual] |
Implemented in vtkOpenGLRenderer, and vtkMesaRenderer.
| virtual unsigned int vtkViewport::GetPickedId | ( | ) | [protected, pure virtual] |
Implemented in vtkOpenGLRenderer, and vtkMesaRenderer.
| virtual unsigned int vtkViewport::GetNumPickedIds | ( | ) | [protected, pure virtual] |
Implemented in vtkOpenGLRenderer, and vtkMesaRenderer.
| virtual int vtkViewport::GetPickedIds | ( | unsigned int | atMost, |
| unsigned int * | callerBuffer | ||
| ) | [protected, pure virtual] |
Implemented in vtkOpenGLRenderer, and vtkMesaRenderer.
Member Data Documentation
vtkAssemblyPath* vtkViewport::PickedProp [protected] |
Definition at line 299 of file vtkViewport.h.
vtkPropCollection* vtkViewport::PickFromProps [protected] |
Definition at line 300 of file vtkViewport.h.
vtkPropCollection* vtkViewport::PickResultProps [protected] |
Definition at line 301 of file vtkViewport.h.
int vtkViewport::IsPicking [protected] |
Definition at line 303 of file vtkViewport.h.
unsigned int vtkViewport::CurrentPickId [protected] |
Definition at line 304 of file vtkViewport.h.
double vtkViewport::PickX1 [protected] |
Definition at line 305 of file vtkViewport.h.
double vtkViewport::PickY1 [protected] |
Definition at line 306 of file vtkViewport.h.
double vtkViewport::PickX2 [protected] |
Definition at line 307 of file vtkViewport.h.
double vtkViewport::PickY2 [protected] |
Definition at line 308 of file vtkViewport.h.
vtkPropCollection* vtkViewport::Props [protected] |
Definition at line 311 of file vtkViewport.h.
vtkActor2DCollection* vtkViewport::Actors2D [protected] |
Definition at line 312 of file vtkViewport.h.
vtkWindow* vtkViewport::VTKWindow [protected] |
Definition at line 313 of file vtkViewport.h.
double vtkViewport::Background[3] [protected] |
Definition at line 314 of file vtkViewport.h.
double vtkViewport::Background2[3] [protected] |
Definition at line 315 of file vtkViewport.h.
double vtkViewport::Viewport[4] [protected] |
Definition at line 316 of file vtkViewport.h.
double vtkViewport::Aspect[2] [protected] |
Definition at line 317 of file vtkViewport.h.
double vtkViewport::PixelAspect[2] [protected] |
Definition at line 318 of file vtkViewport.h.
double vtkViewport::Center[2] [protected] |
Definition at line 319 of file vtkViewport.h.
bool vtkViewport::GradientBackground [protected] |
Definition at line 320 of file vtkViewport.h.
int vtkViewport::Size[2] [protected] |
Definition at line 322 of file vtkViewport.h.
int vtkViewport::Origin[2] [protected] |
Definition at line 323 of file vtkViewport.h.
double vtkViewport::DisplayPoint[3] [protected] |
Definition at line 324 of file vtkViewport.h.
double vtkViewport::ViewPoint[3] [protected] |
Definition at line 325 of file vtkViewport.h.
double vtkViewport::WorldPoint[4] [protected] |
Definition at line 326 of file vtkViewport.h.
The documentation for this class was generated from the following file:
- dox/Filtering/vtkViewport.h
