VTK  9.3.20240327
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
vtkWin32HardwareWindow Class Reference

represents a window in a windows GUI More...

#include <vtkWin32HardwareWindow.h>

Inheritance diagram for vtkWin32HardwareWindow:
[legend]
Collaboration diagram for vtkWin32HardwareWindow:
[legend]

Public Types

typedef vtkHardwareWindow Superclass
 
- Public Types inherited from vtkHardwareWindow
typedef vtkWindow Superclass
 
- Public Types inherited from vtkWindow
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...
 
vtkWin32HardwareWindowNewInstance () const
 
void PrintSelf (ostream &os, vtkIndent indent) override
 Methods invoked by print to print information about the object including superclasses. More...
 
HINSTANCE GetApplicationInstance ()
 
HWND GetWindowId ()
 
void Create () override
 
void Destroy () override
 
void SetDisplayId (void *) override
 These are window system independent methods that are used to help interface vtkWindow to native windowing systems. More...
 
void SetWindowId (void *) override
 These are window system independent methods that are used to help interface vtkWindow to native windowing systems. More...
 
void SetParentId (void *) override
 These are window system independent methods that are used to help interface vtkWindow to native windowing systems. More...
 
void * GetGenericDisplayId () override
 These are window system independent methods that are used to help interface vtkWindow to native windowing systems. More...
 
void * GetGenericWindowId () override
 These are window system independent methods that are used to help interface vtkWindow to native windowing systems. More...
 
void * GetGenericParentId () override
 These are window system independent methods that are used to help interface vtkWindow to native windowing systems. More...
 
void SetSize (int, int) override
 Set the size of the window in pixels. More...
 
void SetPosition (int, int) override
 Set the position of the window. More...
 
- Public Member Functions inherited from vtkHardwareWindow
vtkHardwareWindowNewInstance () const
 
- Public Member Functions inherited from vtkWindow
vtkWindowNewInstance () const
 
int * GetActualSize ()
 GetSize() returns the size * this->TileScale, whereas this method returns the size without multiplying with the tile scale. More...
 
virtual int * GetScreenSize ()
 Get the current size of the screen in pixels. More...
 
virtual void SetIcon (vtkImageData *)
 Set the icon used in title bar and task bar. More...
 
virtual void Render ()
 Ask each viewport owned by this Window to render its image and synchronize this process. More...
 
virtual void ReleaseGraphicsResources (vtkWindow *)
 Release any graphics resources that are being consumed by this texture. More...
 
virtual bool DetectDPI ()
 Attempt to detect and set the DPI of the display device by querying the system. More...
 
vtkTypeBool GetOffScreenRendering ()
 Deprecated, directly use GetShowWindow and GetOffScreenBuffers instead. More...
 
virtual void MakeCurrent ()
 Make the window current. More...
 
virtual void ReleaseCurrent ()
 Release the current context. More...
 
virtual void * GetGenericContext ()
 These are window system independent methods that are used to help interface vtkWindow to native windowing systems. More...
 
virtual void * GetGenericDrawable ()
 These are window system independent methods that are used to help interface vtkWindow to native windowing systems. More...
 
virtual void SetWindowInfo (const char *)
 These are window system independent methods that are used to help interface vtkWindow to native windowing systems. More...
 
virtual void SetParentInfo (const char *)
 These are window system independent methods that are used to help interface vtkWindow to native windowing systems. More...
 
virtual int * GetPosition ()
 Get the position (x and y) of the rendering window in screen coordinates (in pixels). More...
 
virtual void SetPosition (int a[2])
 Get the position (x and y) of the rendering window in screen coordinates (in pixels). More...
 
virtual int * GetSize ()
 Get the size (width and height) of the rendering window in screen coordinates (in pixels). More...
 
virtual void SetSize (int a[2])
 Get the size (width and height) of the rendering window in screen coordinates (in pixels). More...
 
virtual vtkTypeBool GetMapped ()
 Keep track of whether the rendering window has been mapped to screen. More...
 
virtual bool GetShowWindow ()
 Show or not Show the window. More...
 
virtual void SetShowWindow (bool)
 Show or not Show the window. More...
 
virtual void ShowWindowOn ()
 Show or not Show the window. More...
 
virtual void ShowWindowOff ()
 Show or not Show the window. More...
 
virtual void SetUseOffScreenBuffers (bool)
 Render to an offscreen destination such as a framebuffer. More...
 
virtual bool GetUseOffScreenBuffers ()
 Render to an offscreen destination such as a framebuffer. More...
 
virtual void UseOffScreenBuffersOn ()
 Render to an offscreen destination such as a framebuffer. More...
 
virtual void UseOffScreenBuffersOff ()
 Render to an offscreen destination such as a framebuffer. More...
 
virtual void SetErase (vtkTypeBool)
 Turn on/off erasing the screen between images. More...
 
virtual vtkTypeBool GetErase ()
 Turn on/off erasing the screen between images. More...
 
virtual void EraseOn ()
 Turn on/off erasing the screen between images. More...
 
virtual void EraseOff ()
 Turn on/off erasing the screen between images. More...
 
virtual void SetDoubleBuffer (vtkTypeBool)
 Keep track of whether double buffering is on or off. More...
 
virtual vtkTypeBool GetDoubleBuffer ()
 Keep track of whether double buffering is on or off. More...
 
virtual void DoubleBufferOn ()
 Keep track of whether double buffering is on or off. More...
 
virtual void DoubleBufferOff ()
 Keep track of whether double buffering is on or off. More...
 
virtual char * GetWindowName ()
 Get name of rendering window. More...
 
virtual void SetWindowName (const char *)
 Get name of rendering window. More...
 
virtual unsigned char * GetPixelData (int, int, int, int, int, int=0)
 Get the pixel data of an image, transmitted as RGBRGBRGB. More...
 
virtual int GetPixelData (int, int, int, int, int, vtkUnsignedCharArray *, int=0)
 Get the pixel data of an image, transmitted as RGBRGBRGB. More...
 
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)
 Return a best estimate to the dots per inch of the display device being rendered (or printed). More...
 
void SetOffScreenRendering (vtkTypeBool val)
 Convenience to set SHowWindow and UseOffScreenBuffers in one call. More...
 
virtual void OffScreenRenderingOn ()
 Convenience to set SHowWindow and UseOffScreenBuffers in one call. More...
 
virtual void OffScreenRenderingOff ()
 Convenience to set SHowWindow and UseOffScreenBuffers in one call. 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])
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
virtual int * GetTileScale ()
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
virtual void GetTileScale (int &, int &)
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
virtual void GetTileScale (int[2])
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
void SetTileScale (int s)
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
virtual void SetTileViewport (double, double, double, double)
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
virtual void SetTileViewport (double[4])
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
virtual double * GetTileViewport ()
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
virtual void GetTileViewport (double &, double &, double &, double &)
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. More...
 
virtual void GetTileViewport (double[4])
 These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling. 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...
 
vtkCommandGetCommand (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 vtkWin32HardwareWindowNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkWin32HardwareWindowSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkHardwareWindow
static vtkHardwareWindowNew ()
 
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkHardwareWindowSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkWindow
static vtkTypeBool IsTypeOf (const char *type)
 
static vtkWindowSafeDownCast (vtkObjectBase *o)
 
- Static Public Member Functions inherited from vtkObject
static vtkObjectNew ()
 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 vtkObjectBaseNew ()
 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 vtkObjectBaseNewInstanceInternal () const
 
 vtkWin32HardwareWindow ()
 
 ~vtkWin32HardwareWindow () override
 
- Protected Member Functions inherited from vtkHardwareWindow
 vtkHardwareWindow ()
 
 ~vtkHardwareWindow () override
 
- Protected Member Functions inherited from vtkWindow
 vtkWindow ()
 
 ~vtkWindow () 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

HWND ParentId
 
HWND WindowId
 
HINSTANCE ApplicationInstance
 
- Protected Attributes inherited from vtkHardwareWindow
bool Borders
 
- Protected Attributes inherited from vtkWindow
char * WindowName
 
int Size [2]
 
int Position [2]
 
vtkTypeBool Mapped
 
bool ShowWindow
 
bool UseOffScreenBuffers
 
vtkTypeBool Erase
 
vtkTypeBool DoubleBuffer
 
int DPI
 
double TileViewport [4]
 
int TileSize [2]
 
int TileScale [2]
 
- 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 ()
 

Detailed Description

represents a window in a windows GUI

Definition at line 16 of file vtkWin32HardwareWindow.h.

Member Typedef Documentation

◆ Superclass

Definition at line 20 of file vtkWin32HardwareWindow.h.

Constructor & Destructor Documentation

◆ vtkWin32HardwareWindow()

vtkWin32HardwareWindow::vtkWin32HardwareWindow ( )
protected

◆ ~vtkWin32HardwareWindow()

vtkWin32HardwareWindow::~vtkWin32HardwareWindow ( )
overrideprotected

Member Function Documentation

◆ New()

static vtkWin32HardwareWindow* vtkWin32HardwareWindow::New ( )
static

◆ IsTypeOf()

static vtkTypeBool vtkWin32HardwareWindow::IsTypeOf ( const char *  type)
static

◆ IsA()

virtual vtkTypeBool vtkWin32HardwareWindow::IsA ( const char *  name)
virtual

Return 1 if this class is the same type of (or a subclass of) the named class.

Returns 0 otherwise. This method works in combination with vtkTypeMacro found in vtkSetGet.h.

Reimplemented from vtkHardwareWindow.

◆ SafeDownCast()

static vtkWin32HardwareWindow* vtkWin32HardwareWindow::SafeDownCast ( vtkObjectBase o)
static

◆ NewInstanceInternal()

virtual vtkObjectBase* vtkWin32HardwareWindow::NewInstanceInternal ( ) const
protectedvirtual

Reimplemented from vtkHardwareWindow.

◆ NewInstance()

vtkWin32HardwareWindow* vtkWin32HardwareWindow::NewInstance ( ) const

◆ PrintSelf()

void vtkWin32HardwareWindow::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
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 vtkHardwareWindow.

◆ GetApplicationInstance()

HINSTANCE vtkWin32HardwareWindow::GetApplicationInstance ( )

◆ GetWindowId()

HWND vtkWin32HardwareWindow::GetWindowId ( )

◆ Create()

void vtkWin32HardwareWindow::Create ( )
overridevirtual

Reimplemented from vtkHardwareWindow.

◆ Destroy()

void vtkWin32HardwareWindow::Destroy ( )
overridevirtual

Reimplemented from vtkHardwareWindow.

◆ SetDisplayId()

void vtkWin32HardwareWindow::SetDisplayId ( void *  )
overridevirtual

These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

Reimplemented from vtkWindow.

◆ SetWindowId()

void vtkWin32HardwareWindow::SetWindowId ( void *  )
overridevirtual

These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

Reimplemented from vtkWindow.

◆ SetParentId()

void vtkWin32HardwareWindow::SetParentId ( void *  )
overridevirtual

These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

Reimplemented from vtkWindow.

◆ GetGenericDisplayId()

void* vtkWin32HardwareWindow::GetGenericDisplayId ( )
overridevirtual

These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

Reimplemented from vtkWindow.

◆ GetGenericWindowId()

void* vtkWin32HardwareWindow::GetGenericWindowId ( )
overridevirtual

These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

Reimplemented from vtkWindow.

◆ GetGenericParentId()

void* vtkWin32HardwareWindow::GetGenericParentId ( )
overridevirtual

These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

Reimplemented from vtkWindow.

◆ SetSize()

void vtkWin32HardwareWindow::SetSize ( int  ,
int   
)
overridevirtual

Set the size of the window in pixels.

Reimplemented from vtkWindow.

◆ SetPosition()

void vtkWin32HardwareWindow::SetPosition ( int  ,
int   
)
overridevirtual

Set the position of the window.

Reimplemented from vtkWindow.

Member Data Documentation

◆ ParentId

HWND vtkWin32HardwareWindow::ParentId
protected

Definition at line 63 of file vtkWin32HardwareWindow.h.

◆ WindowId

HWND vtkWin32HardwareWindow::WindowId
protected

Definition at line 64 of file vtkWin32HardwareWindow.h.

◆ ApplicationInstance

HINSTANCE vtkWin32HardwareWindow::ApplicationInstance
protected

Definition at line 65 of file vtkWin32HardwareWindow.h.


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