VTK
|
abstract specification for Viewports More...
#include <vtkViewport.h>
Public Types | |
typedef vtkObject | Superclass |
![]() | |
typedef vtkObjectBase | Superclass |
Public Member Functions | |
virtual int | IsA (const char *type) |
vtkViewport * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) |
void | AddViewProp (vtkProp *) |
vtkPropCollection * | GetViewProps () |
int | HasViewProp (vtkProp *) |
void | RemoveViewProp (vtkProp *) |
void | RemoveAllViewProps (void) |
virtual double * | GetCenter () |
virtual int | IsInViewport (int x, int y) |
virtual vtkWindow * | GetVTKWindow ()=0 |
virtual void | DisplayToView () |
virtual void | ViewToDisplay () |
virtual void | WorldToView () |
virtual void | ViewToWorld () |
void | DisplayToWorld () |
void | WorldToDisplay () |
virtual vtkAssemblyPath * | PickProp (double selectionX, double selectionY)=0 |
virtual double | GetPickedZ ()=0 |
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) |
vtkAssemblyPath * | PickPropFrom (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 vtkPropCollection * | GetPickResultProps () |
![]() | |
vtkObject * | NewInstance () const |
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) |
vtkCommand * | GetCommand (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) |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, bool(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) |
![]() | |
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 &) |
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 vtkViewport * | SafeDownCast (vtkObjectBase *o) |
![]() | |
static int | IsTypeOf (const char *type) |
static vtkObject * | SafeDownCast (vtkObjectBase *o) |
static vtkObject * | New () |
static void | BreakOnError () |
static void | SetGlobalWarningDisplay (int val) |
static void | GlobalWarningDisplayOn () |
static void | GlobalWarningDisplayOff () |
static int | GetGlobalWarningDisplay () |
![]() | |
static int | IsTypeOf (const char *name) |
static vtkObjectBase * | New () |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
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 |
![]() | |
vtkObject () | |
virtual | ~vtkObject () |
virtual void | RegisterInternal (vtkObjectBase *, int check) |
virtual void | UnRegisterInternal (vtkObjectBase *, int check) |
void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL) |
void | InternalReleaseFocus () |
![]() | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | CollectRevisions (ostream &) |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
vtkAssemblyPath * | PickedProp |
vtkPropCollection * | PickFromProps |
vtkPropCollection * | PickResultProps |
int | IsPicking |
unsigned int | CurrentPickId |
double | PickX1 |
double | PickY1 |
double | PickX2 |
double | PickY2 |
vtkPropCollection * | Props |
vtkActor2DCollection * | Actors2D |
vtkWindow * | VTKWindow |
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] |
![]() | |
unsigned char | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
![]() | |
vtkAtomicInt< vtkTypeInt32 > | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
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.
Definition at line 46 of file vtkViewport.h.
typedef vtkObject vtkViewport::Superclass |
Definition at line 49 of file vtkViewport.h.
|
protected |
|
protected |
|
static |
|
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, and vtkOpenGLRenderer.
|
static |
|
protectedvirtual |
Reimplemented from vtkObject.
Reimplemented in vtkRenderer, and vtkOpenGLRenderer.
vtkViewport* vtkViewport::NewInstance | ( | ) | const |
|
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 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.
|
inline |
Return any props in this viewport.
Definition at line 58 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 |
Set/Get the background color of the rendering screen using an rgb color specification.
|
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 |
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 |
Set/Get the second background color of the rendering screen for gradient backgrounds using an rgb color specification.
|
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 |
Set/Get the second background color of the rendering screen for gradient backgrounds using an rgb color specification.
|
virtual |
Set/Get whether this viewport should have a gradient background using the Background (top) and Background2 (bottom) colors. Default is off.
|
virtual |
Set/Get whether this viewport should have a gradient background using the Background (top) and Background2 (bottom) colors. Default is off.
|
virtual |
Set/Get whether this viewport should have a gradient background using the Background (top) and Background2 (bottom) colors. Default is off.
|
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 |
Set the aspect ratio of the rendered image. This is computed automatically and should not be set by the user.
|
virtual |
Set the aspect ratio of the rendered image. This is computed automatically and should not be set by the user.
|
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
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 |
Specify a point location in world coordinates. This method takes homogeneous coordinates.
|
virtual |
Specify a point location in world coordinates. This method takes homogeneous coordinates.
|
virtual |
Specify a point location in world coordinates. This method takes homogeneous coordinates.
|
virtual |
Return the center of this viewport in display coordinates.
Is a given display point in this Viewport's viewport.
|
pure virtual |
Return the vtkWindow that owns this vtkViewport.
Implemented in vtkRenderer.
|
virtual |
Convert display coordinates to view coordinates.
|
virtual |
Convert view coordinates to display coordinates.
|
virtual |
Convert world point coordinates to view coordinates.
Reimplemented in vtkRenderer.
|
virtual |
Convert view point coordinates to world coordinates.
Reimplemented in vtkRenderer.
|
inline |
Convert display (or screen) coordinates to world coordinates.
Definition at line 170 of file vtkViewport.h.
|
inline |
Convert world point coordinates to display (or screen) coordinates.
Definition at line 173 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 186 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 192 of file vtkViewport.h.
|
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 |
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 |
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).
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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.
|
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 234 of file vtkViewport.h.
|
virtual |
Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY).
|
virtual |
Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY).
|
pure virtual |
Return the Z value for the last picked Prop.
Implemented in vtkOpenGLRenderer.
|
protectedpure virtual |
Implemented in vtkOpenGLRenderer.
|
protectedpure virtual |
Implemented in vtkOpenGLRenderer.
|
protectedpure virtual |
Implemented in vtkOpenGLRenderer.
|
protectedpure virtual |
Implemented in vtkOpenGLRenderer.
|
protectedpure virtual |
Implemented in vtkOpenGLRenderer.
|
protectedpure virtual |
Implemented in vtkOpenGLRenderer.
|
protectedpure virtual |
Implemented in vtkOpenGLRenderer.
|
protected |
Definition at line 270 of file vtkViewport.h.
|
protected |
Definition at line 271 of file vtkViewport.h.
|
protected |
Definition at line 272 of file vtkViewport.h.
|
protected |
Definition at line 274 of file vtkViewport.h.
|
protected |
Definition at line 275 of file vtkViewport.h.
|
protected |
Definition at line 276 of file vtkViewport.h.
|
protected |
Definition at line 277 of file vtkViewport.h.
|
protected |
Definition at line 278 of file vtkViewport.h.
|
protected |
Definition at line 279 of file vtkViewport.h.
|
protected |
Definition at line 282 of file vtkViewport.h.
|
protected |
Definition at line 283 of file vtkViewport.h.
|
protected |
Definition at line 284 of file vtkViewport.h.
|
protected |
Definition at line 285 of file vtkViewport.h.
|
protected |
Definition at line 286 of file vtkViewport.h.
|
protected |
Definition at line 287 of file vtkViewport.h.
|
protected |
Definition at line 288 of file vtkViewport.h.
|
protected |
Definition at line 289 of file vtkViewport.h.
|
protected |
Definition at line 290 of file vtkViewport.h.
|
protected |
Definition at line 291 of file vtkViewport.h.
|
protected |
Definition at line 293 of file vtkViewport.h.
|
protected |
Definition at line 294 of file vtkViewport.h.
|
protected |
Definition at line 295 of file vtkViewport.h.
|
protected |
Definition at line 296 of file vtkViewport.h.
|
protected |
Definition at line 297 of file vtkViewport.h.