VTK
|
window superclass for vtkRenderWindow More...
#include <vtkWindow.h>
Public Types | |
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... | |
vtkWindow * | NewInstance () const |
void | PrintSelf (ostream &os, vtkIndent indent) override |
Methods invoked by print to print information about the object including superclasses. More... | |
virtual void | SetDisplayId (void *)=0 |
These are window system independent methods that are used to help interface vtkWindow to native windowing systems. More... | |
virtual void | SetWindowId (void *)=0 |
virtual void | SetParentId (void *)=0 |
virtual void * | GetGenericDisplayId ()=0 |
virtual void * | GetGenericWindowId ()=0 |
virtual void * | GetGenericParentId ()=0 |
virtual void * | GetGenericContext ()=0 |
virtual void * | GetGenericDrawable ()=0 |
virtual void | SetWindowInfo (const char *)=0 |
virtual void | SetParentInfo (const char *)=0 |
virtual int * | GetPosition () |
Set/Get the position in screen coordinates of the rendering window. More... | |
virtual void | SetPosition (int, int) |
virtual void | SetPosition (int a[2]) |
virtual int * | GetSize () |
Set/Get the size of the window in screen coordinates in pixels. More... | |
virtual void | SetSize (int, int) |
virtual void | SetSize (int a[2]) |
int * | GetActualSize () |
GetSize() returns the size * this->TileScale, whereas this method returns the size without multiplying with the tile scale. More... | |
virtual int * | GetScreenSize ()=0 |
Get the current size of the screen in pixels. More... | |
virtual void | SetMapped (vtkTypeBool) |
Keep track of whether the rendering window has been mapped to screen. More... | |
virtual vtkTypeBool | GetMapped () |
virtual void | MappedOn () |
virtual void | MappedOff () |
virtual void | SetErase (vtkTypeBool) |
Turn on/off erasing the screen between images. More... | |
virtual vtkTypeBool | GetErase () |
virtual void | EraseOn () |
virtual void | EraseOff () |
virtual void | SetDoubleBuffer (vtkTypeBool) |
Keep track of whether double buffering is on or off. More... | |
virtual vtkTypeBool | GetDoubleBuffer () |
virtual void | DoubleBufferOn () |
virtual void | DoubleBufferOff () |
virtual char * | GetWindowName () |
Get name of rendering window. More... | |
virtual void | SetWindowName (const char *) |
virtual void | Render ()=0 |
Ask each viewport owned by this Window to render its image and synchronize this process. More... | |
virtual unsigned char * | GetPixelData (int x, int y, int x2, int y2, int front, int right=0)=0 |
Get the pixel data of an image, transmitted as RGBRGBRGB. More... | |
virtual int | GetPixelData (int x, int y, int x2, int y2, int front, vtkUnsignedCharArray *data, int right=0)=0 |
virtual int | GetDPI () |
Return a best estimate to the dots per inch of the display device being rendered (or printed). More... | |
virtual void | SetDPI (int) |
virtual bool | DetectDPI () |
Attempt to detect and set the DPI of the display device by querying the system. More... | |
virtual void | SetOffScreenRendering (vtkTypeBool) |
Create a window in memory instead of on the screen. More... | |
virtual vtkTypeBool | GetOffScreenRendering () |
virtual void | OffScreenRenderingOn () |
virtual void | OffScreenRenderingOff () |
virtual void | MakeCurrent () |
Make the window current. More... | |
virtual void | SetTileScale (int, int) |
These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More... | |
void | SetTileScale (int[2]) |
virtual int * | GetTileScale () |
virtual void | GetTileScale (int &, int &) |
virtual void | GetTileScale (int[2]) |
void | SetTileScale (int s) |
virtual void | SetTileViewport (double, double, double, double) |
virtual void | SetTileViewport (double[4]) |
virtual double * | GetTileViewport () |
virtual void | GetTileViewport (double &, double &, double &, double &) |
virtual void | GetTileViewport (double[4]) |
![]() | |
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... | |
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) |
vtkCommand * | GetCommand (unsigned long tag) |
void | RemoveObserver (vtkCommand *) |
void | RemoveObservers (unsigned long event, vtkCommand *) |
void | RemoveObservers (const char *event, vtkCommand *) |
vtkTypeBool | HasObserver (unsigned long event, vtkCommand *) |
vtkTypeBool | HasObserver (const char *event, vtkCommand *) |
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) |
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) |
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... | |
int | InvokeEvent (unsigned long event, void *callData) |
This method invokes an event and return whether the event was aborted or not. More... | |
int | InvokeEvent (const char *event, void *callData) |
int | InvokeEvent (unsigned long event) |
int | InvokeEvent (const char *event) |
![]() | |
const char * | GetClassName () const |
Return the class name as a string. 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... | |
virtual void | PrintHeader (ostream &os, vtkIndent indent) |
virtual void | PrintTrailer (ostream &os, vtkIndent indent) |
virtual 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... | |
void | PrintRevisions (ostream &) |
Legacy. More... | |
Static Public Member Functions | |
static vtkTypeBool | IsTypeOf (const char *type) |
static vtkWindow * | SafeDownCast (vtkObjectBase *o) |
![]() | |
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 (int val) |
This is a global flag that controls whether any debug, warning or error messages are displayed. More... | |
static void | GlobalWarningDisplayOn () |
static void | GlobalWarningDisplayOff () |
static int | GetGlobalWarningDisplay () |
![]() | |
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 vtkObjectBase * | New () |
Create an object with Debug turned off, modified time initialized to zero, and reference counting on. More... | |
Protected Member Functions | |
virtual vtkObjectBase * | NewInstanceInternal () const |
vtkWindow () | |
~vtkWindow () override | |
![]() | |
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 () |
![]() | |
vtkObjectBase () | |
virtual | ~vtkObjectBase () |
virtual void | CollectRevisions (ostream &) |
virtual void | ReportReferences (vtkGarbageCollector *) |
vtkObjectBase (const vtkObjectBase &) | |
void | operator= (const vtkObjectBase &) |
Protected Attributes | |
vtkTypeBool | OffScreenRendering |
char * | WindowName |
int | Size [2] |
int | Position [2] |
vtkTypeBool | Mapped |
vtkTypeBool | Erase |
vtkTypeBool | DoubleBuffer |
int | DPI |
double | TileViewport [4] |
int | TileSize [2] |
int | TileScale [2] |
![]() | |
bool | Debug |
vtkTimeStamp | MTime |
vtkSubjectHelper * | SubjectHelper |
![]() | |
vtkAtomicInt32 | ReferenceCount |
vtkWeakPointerBase ** | WeakPointers |
window superclass for vtkRenderWindow
vtkWindow is an abstract object to specify the behavior of a rendering window. It contains vtkViewports.
Definition at line 37 of file vtkWindow.h.
typedef vtkObject vtkWindow::Superclass |
Definition at line 40 of file vtkWindow.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 vtkRenderWindow, vtkOpenVRRenderWindow, vtkOpenGLRenderWindow, vtkExternalOpenGLRenderWindow, vtkCocoaRenderWindow, vtkIOSRenderWindow, vtkEGLRenderWindow, vtkGenericOpenGLRenderWindow, vtkOSOpenGLRenderWindow, vtkXOpenGLRenderWindow, and vtkWin32OpenGLRenderWindow.
|
static |
|
protectedvirtual |
vtkWindow* vtkWindow::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 vtkRenderWindow, vtkOpenGLRenderWindow, vtkExternalOpenGLRenderWindow, vtkCocoaRenderWindow, vtkIOSRenderWindow, vtkGenericOpenGLRenderWindow, vtkXOpenGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkOpenVRRenderWindow, vtkEGLRenderWindow, and vtkOSOpenGLRenderWindow.
|
pure virtual |
These are window system independent methods that are used to help interface vtkWindow to native windowing systems.
Implemented in vtkRenderWindow, vtkXOpenGLRenderWindow, vtkCocoaRenderWindow, vtkIOSRenderWindow, vtkWin32OpenGLRenderWindow, vtkGenericOpenGLRenderWindow, vtkOpenVRRenderWindow, vtkOSOpenGLRenderWindow, and vtkEGLRenderWindow.
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
pure virtual |
|
virtual |
Set/Get the position in screen coordinates of the rendering window.
Measured in pixels.
Reimplemented in vtkXOpenGLRenderWindow, vtkCocoaRenderWindow, vtkIOSRenderWindow, vtkWin32OpenGLRenderWindow, vtkEGLRenderWindow, and vtkOSOpenGLRenderWindow.
|
virtual |
|
virtual |
Set/Get the size of the window in screen coordinates in pixels.
Reimplemented in vtkCocoaRenderWindow, vtkIOSRenderWindow, and vtkWin32OpenGLRenderWindow.
|
virtual |
int* vtkWindow::GetActualSize | ( | ) |
GetSize() returns the size * this->TileScale, whereas this method returns the size without multiplying with the tile scale.
Measured in pixels.
|
pure virtual |
Get the current size of the screen in pixels.
Implemented in vtkXOpenGLRenderWindow, vtkCocoaRenderWindow, vtkIOSRenderWindow, vtkWin32OpenGLRenderWindow, vtkGenericOpenGLRenderWindow, vtkOpenVRRenderWindow, vtkEGLRenderWindow, and vtkOSOpenGLRenderWindow.
|
virtual |
Keep track of whether the rendering window has been mapped to screen.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Turn on/off erasing the screen between images.
This allows multiple exposure sequences if turned on. You will need to turn double buffering off or make use of the SwapBuffers methods to prevent you from swapping buffers between exposures.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Keep track of whether double buffering is on or off.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Get name of rendering window.
|
virtual |
Reimplemented in vtkXOpenGLRenderWindow, vtkCocoaRenderWindow, vtkIOSRenderWindow, vtkWin32OpenGLRenderWindow, vtkOSOpenGLRenderWindow, and vtkEGLRenderWindow.
|
pure virtual |
Ask each viewport owned by this Window to render its image and synchronize this process.
Implemented in vtkOpenGLRenderWindow, vtkXOpenGLRenderWindow, vtkRenderWindow, vtkGenericOpenGLRenderWindow, vtkOpenVRRenderWindow, and vtkEGLRenderWindow.
|
pure virtual |
Get the pixel data of an image, transmitted as RGBRGBRGB.
The front argument indicates if the front buffer should be used or the back buffer. It is the caller's responsibility to delete the resulting array. It is very important to realize that the memory in this array is organized from the bottom of the window to the top. The origin of the screen is in the lower left corner. The y axis increases as you go up the screen. So the storage of pixels is from left to right and from bottom to top. (x,y) is any corner of the rectangle. (x2,y2) is its opposite corner on the diagonal.
Implemented in vtkOpenGLRenderWindow.
|
pure virtual |
Implemented in vtkOpenGLRenderWindow.
|
virtual |
Return a best estimate to the dots per inch of the display device being rendered (or printed).
|
virtual |
|
inlinevirtual |
Attempt to detect and set the DPI of the display device by querying the system.
Note that this is not supported on most backends, and this method will return false if the DPI could not be detected. Use GetDPI() to inspect the detected value.
Reimplemented in vtkWin32OpenGLRenderWindow.
Definition at line 168 of file vtkWindow.h.
|
virtual |
Create a window in memory instead of on the screen.
This may not be supported for every type of window and on some windows you may need to invoke this prior to the first render.
Reimplemented in vtkEGLRenderWindow, vtkWin32OpenGLRenderWindow, vtkXOpenGLRenderWindow, and vtkOSOpenGLRenderWindow.
|
virtual |
Reimplemented in vtkEGLRenderWindow.
|
virtual |
|
virtual |
|
inlinevirtual |
Make the window current.
May be overridden in subclasses to do for example a glXMakeCurrent or a wglMakeCurrent.
Reimplemented in vtkRenderWindow, vtkWin32OpenGLRenderWindow, vtkCocoaRenderWindow, vtkIOSRenderWindow, vtkXOpenGLRenderWindow, vtkGenericOpenGLRenderWindow, vtkOpenVRRenderWindow, vtkOSOpenGLRenderWindow, and vtkEGLRenderWindow.
Definition at line 185 of file vtkWindow.h.
These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.
For 3D geometry these methods have no impact. It is just in handling annotation that this information must be available to the mappers and the coordinate calculations.
void vtkWindow::SetTileScale | ( | int | [2] | ) |
|
virtual |
|
virtual |
|
inline |
Definition at line 196 of file vtkWindow.h.
|
virtual |
|
virtual |
|
virtual |
|
protected |
Definition at line 198 of file vtkWindow.h.
|
protected |
Definition at line 206 of file vtkWindow.h.
|
protected |
Definition at line 207 of file vtkWindow.h.
|
protected |
Definition at line 208 of file vtkWindow.h.
|
protected |
Definition at line 209 of file vtkWindow.h.
|
protected |
Definition at line 210 of file vtkWindow.h.
|
protected |
Definition at line 211 of file vtkWindow.h.
|
protected |
Definition at line 212 of file vtkWindow.h.
|
protected |
Definition at line 214 of file vtkWindow.h.
|
protected |
Definition at line 215 of file vtkWindow.h.
|
protected |
Definition at line 216 of file vtkWindow.h.