VTK
9.3.20240318
|
abstract specification for Viewports More...
#include <vtkViewport.h>
Public Types | |
enum class | GradientModes : int { VTK_GRADIENT_VERTICAL , VTK_GRADIENT_HORIZONTAL , VTK_GRADIENT_RADIAL_VIEWPORT_FARTHEST_SIDE , VTK_GRADIENT_RADIAL_VIEWPORT_FARTHEST_CORNER } |
typedef vtkObject | Superclass |
Public Member Functions | |
virtual vtkTypeBool | IsA (const char *type) |
Return 1 if this class is the same type of (or a subclass of) the named class. More... | |
vtkViewport * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
void | AddViewProp (vtkProp *) |
Add a prop to the list of props. More... | |
vtkPropCollection * | GetViewProps () |
Return any props in this viewport. More... | |
vtkTypeBool | HasViewProp (vtkProp *) |
Query if a prop is in the list of props. More... | |
void | RemoveViewProp (vtkProp *) |
Remove a prop from the list of props. More... | |
void | RemoveAllViewProps () |
Remove all props from the list of props. More... | |
virtual double * | GetCenter () |
Return the center of this viewport in display coordinates. More... | |
virtual vtkTypeBool | IsInViewport (int x, int y) |
Is a given display point in this Viewport's viewport. More... | |
virtual vtkWindow * | GetVTKWindow ()=0 |
Return the vtkWindow that owns this vtkViewport. More... | |
virtual void | DisplayToView () |
Convert display coordinates to view coordinates. More... | |
virtual void | ViewToDisplay () |
Convert view coordinates to display coordinates. More... | |
virtual void | WorldToView () |
Convert world point coordinates to view coordinates. More... | |
virtual void | ViewToWorld () |
Convert view point coordinates to world coordinates. More... | |
void | DisplayToWorld () |
Convert display (or screen) coordinates to world coordinates. More... | |
void | WorldToDisplay () |
Convert world point coordinates to display (or screen) coordinates. More... | |
void | WorldToDisplay (double &x, double &y, double &z) |
Convert world point coordinates to display (or screen) coordinates. More... | |
virtual vtkAssemblyPath * | PickProp (double selectionX, double selectionY)=0 |
Return the Prop that has the highest z value at the given x, y position in the viewport. More... | |
virtual vtkAssemblyPath * | PickProp (double selectionX1, double selectionY1, double selectionX2, double selectionY2)=0 |
Return the Prop that has the highest z value at the given x1, y1 and x2,y2 positions in the viewport. More... | |
vtkAssemblyPath * | 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. More... | |
vtkAssemblyPath * | PickPropFrom (double selectionX1, double selectionY1, double selectionX2, double selectionY2, vtkPropCollection *) |
Same as PickProp with four arguments, but selects from the given collection of Props instead of the Renderers props. More... | |
virtual vtkAssemblyPath * | PickProp (double selectionX, double selectionY, int fieldAssociation, vtkSmartPointer< vtkSelection > selection)=0 |
Return the Prop that has the highest z value at the given x, y position in the viewport. More... | |
virtual vtkAssemblyPath * | PickProp (double selectionX1, double selectionY1, double selectionX2, double selectionY2, int fieldAssociation, vtkSmartPointer< vtkSelection > selection)=0 |
Return the Prop that has the highest z value at the given x1, y1 and x2,y2 positions in the viewport. More... | |
vtkAssemblyPath * | PickPropFrom (double selectionX, double selectionY, vtkPropCollection *, int fieldAssociation, vtkSmartPointer< vtkSelection > selection) |
Same as PickProp with two arguments, but selects from the given collection of Props instead of the Renderers props. More... | |
vtkAssemblyPath * | PickPropFrom (double selectionX1, double selectionY1, double selectionX2, double selectionY2, vtkPropCollection *, int fieldAssociation, vtkSmartPointer< vtkSelection > selection) |
Same as PickProp with four arguments, but selects from the given collection of Props instead of the Renderers props. More... | |
virtual double | GetPickedZ () |
Return the Z value for the last picked Prop. More... | |
void | AddActor2D (vtkProp *p) |
Add/Remove different types of props to the renderer. More... | |
void | RemoveActor2D (vtkProp *p) |
Add/Remove different types of props to the renderer. More... | |
vtkActor2DCollection * | GetActors2D () |
Add/Remove different types of props to the renderer. More... | |
virtual void | SetBackground (double, double, double) |
Set/Get the background color of the rendering screen using an rgb color specification. More... | |
virtual void | SetBackground (double[3]) |
Set/Get the background color of the rendering screen using an rgb color specification. More... | |
virtual double * | GetBackground () |
Set/Get the background color of the rendering screen using an rgb color specification. More... | |
virtual void | GetBackground (double &, double &, double &) |
Set/Get the background color of the rendering screen using an rgb color specification. More... | |
virtual void | GetBackground (double[3]) |
Set/Get the background color of the rendering screen using an rgb color specification. More... | |
virtual void | SetBackground2 (double, double, double) |
Set/Get the second background color of the rendering screen for gradient backgrounds using an rgb color specification. More... | |
virtual void | SetBackground2 (double[3]) |
Set/Get the second background color of the rendering screen for gradient backgrounds using an rgb color specification. More... | |
virtual double * | GetBackground2 () |
Set/Get the second background color of the rendering screen for gradient backgrounds using an rgb color specification. More... | |
virtual void | GetBackground2 (double &, double &, double &) |
Set/Get the second background color of the rendering screen for gradient backgrounds using an rgb color specification. More... | |
virtual void | GetBackground2 (double[3]) |
Set/Get the second background color of the rendering screen for gradient backgrounds using an rgb color specification. More... | |
virtual void | SetBackgroundAlpha (double) |
Set/Get the alpha value used to fill the background with. More... | |
virtual double | GetBackgroundAlpha () |
Set/Get the alpha value used to fill the background with. More... | |
virtual void | SetGradientBackground (bool) |
Set/Get whether this viewport should have a gradient background using the Background (bottom) and Background2 (top) colors. More... | |
virtual bool | GetGradientBackground () |
Set/Get whether this viewport should have a gradient background using the Background (bottom) and Background2 (top) colors. More... | |
virtual void | GradientBackgroundOn () |
Set/Get whether this viewport should have a gradient background using the Background (bottom) and Background2 (top) colors. More... | |
virtual void | GradientBackgroundOff () |
Set/Get whether this viewport should have a gradient background using the Background (bottom) and Background2 (top) colors. More... | |
virtual void | SetDitherGradient (bool) |
Set/Get whether this viewport should use dithering to reduce color banding when using gradient backgrounds. More... | |
virtual bool | GetDitherGradient () |
Set/Get whether this viewport should use dithering to reduce color banding when using gradient backgrounds. More... | |
virtual void | DitherGradientOn () |
Set/Get whether this viewport should use dithering to reduce color banding when using gradient backgrounds. More... | |
virtual void | DitherGradientOff () |
Set/Get whether this viewport should use dithering to reduce color banding when using gradient backgrounds. More... | |
vtkSetEnumMacro (GradientMode, GradientModes) | |
Specify the direction of the gradient background. More... | |
vtkGetEnumMacro (GradientMode, GradientModes) | |
Specify the direction of the gradient background. More... | |
virtual void | SetAspect (double, double) |
Set the aspect ratio of the rendered image. More... | |
void | SetAspect (double[2]) |
Set the aspect ratio of the rendered image. More... | |
virtual double * | GetAspect () |
Set the aspect ratio of the rendered image. More... | |
virtual void | GetAspect (double data[2]) |
Set the aspect ratio of the rendered image. More... | |
virtual void | ComputeAspect () |
Set the aspect ratio of the rendered image. More... | |
virtual void | SetPixelAspect (double, double) |
Set the aspect ratio of a pixel in the rendered image. More... | |
void | SetPixelAspect (double[2]) |
Set the aspect ratio of a pixel in the rendered image. More... | |
virtual double * | GetPixelAspect () |
Set the aspect ratio of a pixel in the rendered image. More... | |
virtual void | GetPixelAspect (double data[2]) |
Set the aspect ratio of a pixel in the rendered image. More... | |
virtual void | SetViewport (double, double, double, double) |
Specify the viewport for the Viewport to draw in the rendering window. More... | |
virtual void | SetViewport (double[4]) |
Specify the viewport for the Viewport to draw in the rendering window. More... | |
virtual double * | GetViewport () |
Specify the viewport for the Viewport to draw in the rendering window. More... | |
virtual void | GetViewport (double data[4]) |
Specify the viewport for the Viewport to draw in the rendering window. More... | |
virtual void | SetDisplayPoint (double, double, double) |
Set/get a point location in display (or screen) coordinates. More... | |
virtual void | SetDisplayPoint (double[3]) |
Set/get a point location in display (or screen) coordinates. More... | |
virtual double * | GetDisplayPoint () |
Set/get a point location in display (or screen) coordinates. More... | |
virtual void | GetDisplayPoint (double data[3]) |
Set/get a point location in display (or screen) coordinates. More... | |
virtual void | SetViewPoint (double, double, double) |
Specify a point location in view coordinates. More... | |
virtual void | SetViewPoint (double[3]) |
Specify a point location in view coordinates. More... | |
virtual double * | GetViewPoint () |
Specify a point location in view coordinates. More... | |
virtual void | GetViewPoint (double data[3]) |
Specify a point location in view coordinates. More... | |
virtual void | SetWorldPoint (double, double, double, double) |
Specify a point location in world coordinates. More... | |
virtual void | SetWorldPoint (double[4]) |
Specify a point location in world coordinates. More... | |
virtual double * | GetWorldPoint () |
Specify a point location in world coordinates. More... | |
virtual void | GetWorldPoint (double data[4]) |
Specify a point location in world coordinates. More... | |
virtual void | LocalDisplayToDisplay (double &x, double &y) |
These methods map from one coordinate system to another. More... | |
virtual void | DisplayToNormalizedDisplay (double &u, double &v) |
These methods map from one coordinate system to another. More... | |
virtual void | NormalizedDisplayToViewport (double &x, double &y) |
These methods map from one coordinate system to another. More... | |
virtual void | ViewportToNormalizedViewport (double &u, double &v) |
These methods map from one coordinate system to another. More... | |
virtual void | NormalizedViewportToView (double &x, double &y, double &z) |
These methods map from one coordinate system to another. More... | |
virtual void | ViewToPose (double &, double &, double &) |
These methods map from one coordinate system to another. More... | |
virtual void | PoseToWorld (double &, double &, double &) |
These methods map from one coordinate system to another. More... | |
virtual void | DisplayToLocalDisplay (double &x, double &y) |
These methods map from one coordinate system to another. More... | |
virtual void | NormalizedDisplayToDisplay (double &u, double &v) |
These methods map from one coordinate system to another. More... | |
virtual void | ViewportToNormalizedDisplay (double &x, double &y) |
These methods map from one coordinate system to another. More... | |
virtual void | NormalizedViewportToViewport (double &u, double &v) |
These methods map from one coordinate system to another. More... | |
virtual void | ViewToNormalizedViewport (double &x, double &y, double &z) |
These methods map from one coordinate system to another. More... | |
virtual void | PoseToView (double &, double &, double &) |
These methods map from one coordinate system to another. More... | |
virtual void | WorldToPose (double &, double &, double &) |
These methods map from one coordinate system to another. More... | |
virtual void | ViewToWorld (double &, double &, double &) |
These methods map from one coordinate system to another. More... | |
virtual void | WorldToView (double &, double &, double &) |
These methods map from one coordinate system to another. More... | |
virtual void | ViewToDisplay (double &x, double &y, double &z) |
These methods map from one coordinate system to another. More... | |
virtual int * | GetSize () |
Get the size and origin of the viewport in display coordinates. More... | |
virtual int * | GetOrigin () |
Get the size and origin of the viewport in display coordinates. More... | |
void | GetTiledSize (int *width, int *height) |
Get the size and origin of the viewport in display coordinates. More... | |
virtual void | GetTiledSizeAndOrigin (int *width, int *height, int *lowerLeftX, int *lowerLeftY) |
Get the size and origin of the viewport in display coordinates. More... | |
double | GetPickX () const |
Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY). More... | |
double | GetPickY () const |
Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY). More... | |
double | GetPickWidth () const |
Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY). More... | |
double | GetPickHeight () const |
Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY). More... | |
double | GetPickX1 () const |
Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY). More... | |
double | GetPickY1 () const |
Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY). More... | |
double | GetPickX2 () const |
Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY). More... | |
double | GetPickY2 () const |
Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY). More... | |
virtual vtkPropCollection * | GetPickResultProps () |
Methods used to return the pick (x,y) in local display coordinates (i.e., it's that same as selectionX and selectionY). More... | |
virtual void | SetEnvironmentalBG (double, double, double) |
Set/Get the constant environmental color using an rgb color specification. More... | |
virtual void | SetEnvironmentalBG (double[3]) |
Set/Get the constant environmental color using an rgb color specification. More... | |
virtual double * | GetEnvironmentalBG () |
Set/Get the constant environmental color using an rgb color specification. More... | |
virtual void | GetEnvironmentalBG (double &, double &, double &) |
Set/Get the constant environmental color using an rgb color specification. More... | |
virtual void | GetEnvironmentalBG (double[3]) |
Set/Get the constant environmental color using an rgb color specification. More... | |
virtual void | SetEnvironmentalBG2 (double, double, double) |
Set/Get the second environmental gradient color using an rgb color specification. More... | |
virtual void | SetEnvironmentalBG2 (double[3]) |
Set/Get the second environmental gradient color using an rgb color specification. More... | |
virtual double * | GetEnvironmentalBG2 () |
Set/Get the second environmental gradient color using an rgb color specification. More... | |
virtual void | GetEnvironmentalBG2 (double &, double &, double &) |
Set/Get the second environmental gradient color using an rgb color specification. More... | |
virtual void | GetEnvironmentalBG2 (double[3]) |
Set/Get the second environmental gradient color using an rgb color specification. More... | |
virtual void | SetGradientEnvironmentalBG (bool) |
Set/Get whether this viewport should enable the gradient environment using the EnvironmentalBG (bottom) and EnvironmentalBG2 (top) colors. More... | |
virtual bool | GetGradientEnvironmentalBG () |
Set/Get whether this viewport should enable the gradient environment using the EnvironmentalBG (bottom) and EnvironmentalBG2 (top) colors. More... | |
virtual void | GradientEnvironmentalBGOn () |
Set/Get whether this viewport should enable the gradient environment using the EnvironmentalBG (bottom) and EnvironmentalBG2 (top) colors. More... | |
virtual void | GradientEnvironmentalBGOff () |
Set/Get whether this viewport should enable the gradient environment using the EnvironmentalBG (bottom) and EnvironmentalBG2 (top) colors. More... | |
Public Member Functions inherited from vtkObject | |
vtkBaseTypeMacro (vtkObject, vtkObjectBase) | |
virtual void | DebugOn () |
Turn debugging output on. More... | |
virtual void | DebugOff () |
Turn debugging output off. More... | |
bool | GetDebug () |
Get the value of the debug flag. More... | |
void | SetDebug (bool debugFlag) |
Set the value of the debug flag. More... | |
virtual void | Modified () |
Update the modification time for this object. More... | |
virtual vtkMTimeType | GetMTime () |
Return this object's modified time. More... | |
void | RemoveObserver (unsigned long tag) |
void | RemoveObservers (unsigned long event) |
void | RemoveObservers (const char *event) |
void | RemoveAllObservers () |
vtkTypeBool | HasObserver (unsigned long event) |
vtkTypeBool | HasObserver (const char *event) |
vtkTypeBool | InvokeEvent (unsigned long event) |
vtkTypeBool | InvokeEvent (const char *event) |
std::string | GetObjectDescription () const override |
The object description printed in messages and PrintSelf output. More... | |
unsigned long | AddObserver (unsigned long event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
unsigned long | AddObserver (const char *event, vtkCommand *, float priority=0.0f) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
vtkCommand * | GetCommand (unsigned long tag) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
void | RemoveObserver (vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
void | RemoveObservers (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
void | RemoveObservers (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
Allow people to add/remove/invoke observers (callbacks) to any VTK object. More... | |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f) |
Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More... | |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
Overloads to AddObserver that allow developers to add class member functions as callbacks for events. More... | |
template<class U , class T > | |
unsigned long | AddObserver (unsigned long event, U observer, bool(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f) |
Allow user to set the AbortFlagOn() with the return value of the callback method. More... | |
vtkTypeBool | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. More... | |
vtkTypeBool | InvokeEvent (const char *event, void *callData) |
This method invokes an event and return whether the event was aborted or not. More... | |
virtual void | SetObjectName (const std::string &objectName) |
Set/get the name of this object for reporting purposes. More... | |
virtual std::string | GetObjectName () const |
Set/get the name of this object for reporting purposes. More... | |
Public Member Functions inherited from vtkObjectBase | |
const char * | GetClassName () const |
Return the class name as a string. More... | |
virtual vtkIdType | GetNumberOfGenerationsFromBase (const char *name) |
Given the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More... | |
virtual void | Delete () |
Delete a VTK object. More... | |
virtual void | FastDelete () |
Delete a reference to this object. More... | |
void | InitializeObjectBase () |
void | Print (ostream &os) |
Print an object to an ostream. More... | |
void | Register (vtkObjectBase *o) |
Increase the reference count (mark as used by another object). More... | |
virtual void | UnRegister (vtkObjectBase *o) |
Decrease the reference count (release by another object). More... | |
int | GetReferenceCount () |
Return the current reference count of this object. More... | |
void | SetReferenceCount (int) |
Sets the reference count. More... | |
bool | GetIsInMemkind () const |
A local state flag that remembers whether this object lives in the normal or extended memory space. More... | |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. More... | |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
Methods invoked by print to print information about the object including superclasses. More... | |
virtual bool | UsesGarbageCollector () const |
Indicate whether the class uses vtkGarbageCollector or not. More... | |
Static Public Member Functions | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkViewport * | SafeDownCast (vtkObjectBase *o) |
Static Public Member Functions inherited from vtkObject | |
static vtkObject * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
static void | BreakOnError () |
This method is called when vtkErrorMacro executes. More... | |
static void | SetGlobalWarningDisplay (vtkTypeBool val) |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
static void | GlobalWarningDisplayOn () |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
static void | GlobalWarningDisplayOff () |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
static vtkTypeBool | GetGlobalWarningDisplay () |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
Static Public Member Functions inherited from vtkObjectBase | |
static vtkTypeBool | IsTypeOf (const char *name) |
Return 1 if this class type is the same type of (or a subclass of) the named class. More... | |
static vtkIdType | GetNumberOfGenerationsFromBaseType (const char *name) |
Given a the name of a base class of this class type, return the distance of inheritance between this class type and the named class (how many generations of inheritance are there between this class and the named class). More... | |
static vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
static void | SetMemkindDirectory (const char *directoryname) |
The name of a directory, ideally mounted -o dax, to memory map an extended memory space within. More... | |
static bool | GetUsingMemkind () |
A global state flag that controls whether vtkObjects are constructed in the usual way (the default) or within the extended memory space. More... | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkViewport () | |
~vtkViewport () override | |
Protected Member Functions inherited from vtkObject | |
vtkObject () | |
~vtkObject () override | |
void | RegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
void | UnRegisterInternal (vtkObjectBase *, vtkTypeBool check) override |
void | InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=nullptr) |
These methods allow a command to exclusively grab all events. More... | |
void | InternalReleaseFocus () |
These methods allow a command to exclusively grab all events. More... | |
Protected Member Functions inherited from vtkObjectBase | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
vtkAssemblyPath * | PickedProp |
vtkPropCollection * | PickFromProps |
vtkPropCollection * | PickResultProps |
double | PickX1 |
double | PickY1 |
double | PickX2 |
double | PickY2 |
double | PickedZ |
vtkPropCollection * | Props |
vtkActor2DCollection * | Actors2D |
vtkWindow * | VTKWindow |
double | Background [3] |
double | Background2 [3] |
double | BackgroundAlpha |
double | Viewport [4] |
double | Aspect [2] |
double | PixelAspect [2] |
double | Center [2] |
bool | GradientBackground |
bool | DitherGradient |
GradientModes | GradientMode = GradientModes::VTK_GRADIENT_VERTICAL |
double | EnvironmentalBG [3] |
double | EnvironmentalBG2 [3] |
bool | GradientEnvironmentalBG |
int | Size [2] |
int | Origin [2] |
double | DisplayPoint [3] |
double | ViewPoint [3] |
double | WorldPoint [4] |
Protected Attributes inherited from vtkObject | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
std::string | ObjectName |
Protected Attributes inherited from vtkObjectBase | |
std::atomic< int32_t > | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
Additional Inherited Members | |
Static Protected Member Functions inherited from vtkObjectBase | |
static vtkMallocingFunction | GetCurrentMallocFunction () |
static vtkReallocingFunction | GetCurrentReallocFunction () |
static vtkFreeingFunction | GetCurrentFreeFunction () |
static vtkFreeingFunction | GetAlternateFreeFunction () |
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 63 of file vtkViewport.h.
typedef vtkObject vtkViewport::Superclass |
Definition at line 66 of file vtkViewport.h.
|
strong |
Enumerator | |
---|---|
VTK_GRADIENT_VERTICAL | |
VTK_GRADIENT_HORIZONTAL | |
VTK_GRADIENT_RADIAL_VIEWPORT_FARTHEST_SIDE | |
VTK_GRADIENT_RADIAL_VIEWPORT_FARTHEST_CORNER |
Definition at line 158 of file vtkViewport.h.
|
protected |
|
overrideprotected |
|
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 vtkObjectBase.
Reimplemented in vtkZSpaceRenderer, vtkWebGPURenderer, vtkVRRenderer, vtkOpenXRRenderer, vtkOpenVRRenderer, vtkOpenGLRenderer, vtkExternalOpenGLRenderer, and vtkRenderer.
|
static |
|
protectedvirtual |
Reimplemented in vtkZSpaceRenderer, vtkWebGPURenderer, vtkVRRenderer, vtkOpenXRRenderer, vtkOpenVRRenderer, vtkOpenGLRenderer, vtkExternalOpenGLRenderer, and vtkRenderer.
vtkViewport* vtkViewport::NewInstance | ( | ) | const |
|
overridevirtual |
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 vtkZSpaceRenderer, vtkWebGPURenderer, vtkVRRenderer, vtkOpenXRRenderer, vtkOpenGLRenderer, and vtkExternalOpenGLRenderer.
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 79 of file vtkViewport.h.
vtkTypeBool vtkViewport::HasViewProp | ( | vtkProp * | ) |
Query if a prop is in the list of props.
void vtkViewport::RemoveViewProp | ( | vtkProp * | ) |
Remove a prop from the list of props.
Does nothing if the prop is not already present or if the parameter is NULL.
void vtkViewport::RemoveAllViewProps | ( | ) |
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.
|
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.
|
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.
|
virtual |
Set/Get the background color of the rendering screen 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.
|
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.
|
virtual |
Set/Get the second background color of the rendering screen for gradient backgrounds using an rgb color specification.
|
virtual |
Set/Get the alpha value used to fill the background with.
By default, this is set to 0.0.
|
virtual |
Set/Get the alpha value used to fill the background with.
By default, this is set to 0.0.
|
virtual |
Set/Get whether this viewport should have a gradient background using the Background (bottom) and Background2 (top) colors.
Default is off.
|
virtual |
Set/Get whether this viewport should have a gradient background using the Background (bottom) and Background2 (top) colors.
Default is off.
|
virtual |
Set/Get whether this viewport should have a gradient background using the Background (bottom) and Background2 (top) colors.
Default is off.
|
virtual |
Set/Get whether this viewport should have a gradient background using the Background (bottom) and Background2 (top) colors.
Default is off.
|
virtual |
Set/Get whether this viewport should use dithering to reduce color banding when using gradient backgrounds.
By default, this feature is enabled.
|
virtual |
Set/Get whether this viewport should use dithering to reduce color banding when using gradient backgrounds.
By default, this feature is enabled.
|
virtual |
Set/Get whether this viewport should use dithering to reduce color banding when using gradient backgrounds.
By default, this feature is enabled.
|
virtual |
Set/Get whether this viewport should use dithering to reduce color banding when using gradient backgrounds.
By default, this feature is enabled.
vtkViewport::vtkSetEnumMacro | ( | GradientMode | , |
GradientModes | |||
) |
Specify the direction of the gradient background.
All modes smoothly interpolate the color from Background
to Background2
vtkViewport::vtkGetEnumMacro | ( | GradientMode | , |
GradientModes | |||
) |
Specify the direction of the gradient background.
All modes smoothly interpolate the color from Background
to Background2
|
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 |
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 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).
|
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.
|
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 |
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.
|
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.
|
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 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.
|
virtual |
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 281 of file vtkViewport.h.
|
inline |
Convert world point coordinates to display (or screen) coordinates.
Definition at line 290 of file vtkViewport.h.
|
inline |
Convert world point coordinates to display (or screen) coordinates.
Definition at line 299 of file vtkViewport.h.
|
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 |
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 |
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 |
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 |
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)).
|
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)).
Reimplemented in vtkRenderer.
Definition at line 318 of file vtkViewport.h.
|
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)).
Reimplemented in vtkRenderer.
Definition at line 319 of file vtkViewport.h.
|
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 |
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 |
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 |
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 |
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)).
|
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)).
Reimplemented in vtkRenderer.
Definition at line 325 of file vtkViewport.h.
|
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)).
Reimplemented in vtkRenderer.
Definition at line 326 of file vtkViewport.h.
|
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)).
Reimplemented in vtkRenderer.
Definition at line 327 of file vtkViewport.h.
|
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)).
Reimplemented in vtkRenderer.
Definition at line 328 of file vtkViewport.h.
|
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 |
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).
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 |
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.
|
pure virtual |
Return the Prop that has the highest z value at the given x1, y1 and x2,y2 positions in the viewport.
Basically, the top most prop that renders the pixel at selectionX1, selectionY1, selectionX2, selectionY2 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.
vtkAssemblyPath* vtkViewport::PickPropFrom | ( | double | selectionX1, |
double | selectionY1, | ||
double | selectionX2, | ||
double | selectionY2, | ||
vtkPropCollection * | |||
) |
Same as PickProp with four 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.
|
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. Additionally, you can set the field association of the hardware selector used internally, and get its selection result by passing a non-null vtkSmartPointer<vtkSelection>.
Implemented in vtkRenderer.
|
pure virtual |
Return the Prop that has the highest z value at the given x1, y1 and x2,y2 positions in the viewport.
Basically, the top most prop that renders the pixel at selectionX1, selectionY1, selectionX2, selectionY2 will be returned. If no Props are there, NULL is returned. This method selects from the Viewports Prop list. Additionally, you can set the field association of the hardware selector used internally, and get its selection result by passing a non-null vtkSmartPointer<vtkSelection>.
Implemented in vtkRenderer.
vtkAssemblyPath* vtkViewport::PickPropFrom | ( | double | selectionX, |
double | selectionY, | ||
vtkPropCollection * | , | ||
int | fieldAssociation, | ||
vtkSmartPointer< vtkSelection > | selection | ||
) |
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. Additionally, you can set the field association of the hardware selector used internally, and get its selection result by passing a non-null vtkSmartPointer<vtkSelection>.
vtkAssemblyPath* vtkViewport::PickPropFrom | ( | double | selectionX1, |
double | selectionY1, | ||
double | selectionX2, | ||
double | selectionY2, | ||
vtkPropCollection * | , | ||
int | fieldAssociation, | ||
vtkSmartPointer< vtkSelection > | selection | ||
) |
Same as PickProp with four 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. Additionally, you can set the field association of the hardware selector used internally, and get its selection result by passing a non-null vtkSmartPointer<vtkSelection>.
|
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 429 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 430 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 431 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 432 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 433 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 434 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 435 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 436 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).
|
inlinevirtual |
Return the Z value for the last picked Prop.
Definition at line 443 of file vtkViewport.h.
|
virtual |
Set/Get the constant environmental color using an rgb color specification.
Note this is currently ignored outside of RayTracing.
|
virtual |
Set/Get the constant environmental color using an rgb color specification.
Note this is currently ignored outside of RayTracing.
|
virtual |
Set/Get the constant environmental color using an rgb color specification.
Note this is currently ignored outside of RayTracing.
|
virtual |
Set/Get the constant environmental color using an rgb color specification.
Note this is currently ignored outside of RayTracing.
|
virtual |
Set/Get the constant environmental color using an rgb color specification.
Note this is currently ignored outside of RayTracing.
|
virtual |
Set/Get the second environmental gradient color using an rgb color specification.
Note this is currently ignored outside of RayTracing.
|
virtual |
Set/Get the second environmental gradient color using an rgb color specification.
Note this is currently ignored outside of RayTracing.
|
virtual |
Set/Get the second environmental gradient color using an rgb color specification.
Note this is currently ignored outside of RayTracing.
|
virtual |
Set/Get the second environmental gradient color using an rgb color specification.
Note this is currently ignored outside of RayTracing.
|
virtual |
Set/Get the second environmental gradient color using an rgb color specification.
Note this is currently ignored outside of RayTracing.
|
virtual |
Set/Get whether this viewport should enable the gradient environment using the EnvironmentalBG (bottom) and EnvironmentalBG2 (top) colors.
Note this is currently ignored outside of RayTracing. Default is off.
|
virtual |
Set/Get whether this viewport should enable the gradient environment using the EnvironmentalBG (bottom) and EnvironmentalBG2 (top) colors.
Note this is currently ignored outside of RayTracing. Default is off.
|
virtual |
Set/Get whether this viewport should enable the gradient environment using the EnvironmentalBG (bottom) and EnvironmentalBG2 (top) colors.
Note this is currently ignored outside of RayTracing. Default is off.
|
virtual |
Set/Get whether this viewport should enable the gradient environment using the EnvironmentalBG (bottom) and EnvironmentalBG2 (top) colors.
Note this is currently ignored outside of RayTracing. Default is off.
|
protected |
Definition at line 483 of file vtkViewport.h.
|
protected |
Definition at line 484 of file vtkViewport.h.
|
protected |
Definition at line 485 of file vtkViewport.h.
|
protected |
Definition at line 486 of file vtkViewport.h.
|
protected |
Definition at line 487 of file vtkViewport.h.
|
protected |
Definition at line 488 of file vtkViewport.h.
|
protected |
Definition at line 489 of file vtkViewport.h.
|
protected |
Definition at line 490 of file vtkViewport.h.
|
protected |
Definition at line 493 of file vtkViewport.h.
|
protected |
Definition at line 494 of file vtkViewport.h.
|
protected |
Definition at line 495 of file vtkViewport.h.
|
protected |
Definition at line 496 of file vtkViewport.h.
|
protected |
Definition at line 497 of file vtkViewport.h.
|
protected |
Definition at line 498 of file vtkViewport.h.
|
protected |
Definition at line 499 of file vtkViewport.h.
|
protected |
Definition at line 500 of file vtkViewport.h.
|
protected |
Definition at line 501 of file vtkViewport.h.
|
protected |
Definition at line 502 of file vtkViewport.h.
|
protected |
Definition at line 503 of file vtkViewport.h.
|
protected |
Definition at line 504 of file vtkViewport.h.
|
protected |
Definition at line 505 of file vtkViewport.h.
|
protected |
Definition at line 507 of file vtkViewport.h.
|
protected |
Definition at line 508 of file vtkViewport.h.
|
protected |
Definition at line 509 of file vtkViewport.h.
|
protected |
Definition at line 511 of file vtkViewport.h.
|
protected |
Definition at line 512 of file vtkViewport.h.
|
protected |
Definition at line 513 of file vtkViewport.h.
|
protected |
Definition at line 514 of file vtkViewport.h.
|
protected |
Definition at line 515 of file vtkViewport.h.