represents a window in a windows GUI More...

#include <vtkXlibHardwareWindow.h>

Inheritance diagram for vtkXlibHardwareWindow:

Collaboration diagram for vtkXlibHardwareWindow:

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.

vtkXlibHardwareWindow *	NewInstance () const

void	PrintSelf (ostream &os, vtkIndent indent) override
	Methods invoked by print to print information about the object including superclasses.

void	SetParentId (Window)
	Sets the parent of the window that WILL BE created.

Window	GetWindowId ()
	Get this RenderWindow's X window id.

void	Create () override

void	Destroy () override

void	SetCurrentCursor (int) override
	Change the shape of the cursor.

void	SetWindowName (const char *) override
	Set name of window.

void	SetIcon (vtkImageData *img) override
	For window manager that supports it, set the icon displayed in the taskbar and the title bar.

void	SetWindowInfo (const char *info) override
	Set this RenderWindow's X window id to a pre-existing window.

void	SetCoverable (vtkTypeBool coverable) override
	Set whether this xwindow should be coverable by other windows, as opposed to always on top.

bool	EnsureDisplay () override
	Ensure the X display is opened.


Display *	GetDisplayId ()
	Get/set the X11 display.

void	SetDisplayId (Display *display)
	Get/set the X11 display.


void	SetWindowId (Window)
	Set this RenderWindow's X window id to a pre-existing window.

void	SetWindowId (void *) override
	Set this RenderWindow's X window id to a pre-existing window.


void	SetDisplayId (void *) override
	These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

void	SetParentId (void *) override
	These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

void *	GetGenericDisplayId () override
	These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

void *	GetGenericWindowId () override
	These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

void *	GetGenericParentId () override
	These are window system independent methods that are used to help interface vtkWindow to native windowing systems.


void	SetSize (int, int) override
	Set the size of the window in pixels.


void	SetPosition (int, int) override
	Set the position of the window.


void	HideCursor () override
	Hide or Show the mouse cursor, it is nice to be able to hide the default cursor if you want VTK to display a 3D cursor instead.

void	ShowCursor () override
	Hide or Show the mouse cursor, it is nice to be able to hide the default cursor if you want VTK to display a 3D cursor instead.

Public Member Functions inherited from vtkHardwareWindow
vtkHardwareWindow *	NewInstance () const

virtual void	SetInteractor (vtkRenderWindowInteractor *)
	Set/Get the interactor associated with this window.

virtual vtkRenderWindowInteractor *	GetInteractor ()
	Set/Get the interactor associated with this window.

virtual vtkTypeBool	GetCoverable ()
	Set/Get whether windows should be coverable (as opposed to always on top).

virtual void	CoverableOn ()
	Set/Get whether windows should be coverable (as opposed to always on top).

virtual void	CoverableOff ()
	Set/Get whether windows should be coverable (as opposed to always on top).

	vtkGetCharFromStdStringMacro (Platform)
	Get the platform name for this windowing system.

	vtkSetStdStringFromCharMacro (Platform)
	Get the platform name for this windowing system.

virtual void	SetFullScreen (vtkTypeBool)
	Turn on/off rendering full screen window size.

virtual vtkTypeBool	GetFullScreen ()
	Turn on/off rendering full screen window size.

virtual void	FullScreenOn ()
	Turn on/off rendering full screen window size.

virtual void	FullScreenOff ()
	Turn on/off rendering full screen window size.

Public Member Functions inherited from vtkWindow
vtkWindow *	NewInstance () const

int *	GetActualSize ()
	GetSize() returns the size * this->TileScale, whereas this method returns the size without multiplying with the tile scale.

virtual int *	GetScreenSize ()
	Get the current size of the screen in pixels.

virtual void	Render ()
	Ask each viewport owned by this Window to render its image and synchronize this process.

virtual void	ReleaseGraphicsResources (vtkWindow *)
	Release any graphics resources that are being consumed by this texture.

virtual bool	DetectDPI ()
	Attempt to detect and set the DPI of the display device by querying the system.

vtkTypeBool	GetOffScreenRendering ()
	Deprecated, directly use GetShowWindow and GetOffScreenBuffers instead.

virtual void	MakeCurrent ()
	Make the window current.

virtual void	ReleaseCurrent ()
	Release the current context.

virtual void *	GetGenericContext ()
	These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

virtual void *	GetGenericDrawable ()
	These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

virtual void	SetParentInfo (const char *)
	These are window system independent methods that are used to help interface vtkWindow to native windowing systems.

virtual int *	GetPosition ()
	Get the position (x and y) of the rendering window in screen coordinates (in pixels).

virtual void	SetPosition (int a[2])
	Get the position (x and y) of the rendering window in screen coordinates (in pixels).

virtual int *	GetSize ()
	Get the size (width and height) of the rendering window in screen coordinates (in pixels).

virtual void	SetSize (int a[2])
	Get the size (width and height) of the rendering window in screen coordinates (in pixels).

virtual vtkTypeBool	GetMapped ()
	Keep track of whether the rendering window has been mapped to screen.

virtual bool	GetShowWindow ()
	Show or not Show the window.

virtual void	SetShowWindow (bool)
	Show or not Show the window.

virtual void	ShowWindowOn ()
	Show or not Show the window.

virtual void	ShowWindowOff ()
	Show or not Show the window.

virtual void	SetUseOffScreenBuffers (bool)
	Render to an offscreen destination such as a framebuffer.

virtual bool	GetUseOffScreenBuffers ()
	Render to an offscreen destination such as a framebuffer.

virtual void	UseOffScreenBuffersOn ()
	Render to an offscreen destination such as a framebuffer.

virtual void	UseOffScreenBuffersOff ()
	Render to an offscreen destination such as a framebuffer.

virtual void	SetErase (vtkTypeBool)
	Turn on/off erasing the screen between images.

virtual vtkTypeBool	GetErase ()
	Turn on/off erasing the screen between images.

virtual void	EraseOn ()
	Turn on/off erasing the screen between images.

virtual void	EraseOff ()
	Turn on/off erasing the screen between images.

virtual void	SetDoubleBuffer (vtkTypeBool)
	Keep track of whether double buffering is on or off.

virtual vtkTypeBool	GetDoubleBuffer ()
	Keep track of whether double buffering is on or off.

virtual void	DoubleBufferOn ()
	Keep track of whether double buffering is on or off.

virtual void	DoubleBufferOff ()
	Keep track of whether double buffering is on or off.

virtual char *	GetWindowName ()
	Get name of rendering window.

virtual unsigned char *	GetPixelData (int, int, int, int, int, int=0)
	Get the pixel data of an image, transmitted as RGBRGBRGB.

virtual int	GetPixelData (int, int, int, int, int, vtkUnsignedCharArray *, int=0)
	Get the pixel data of an image, transmitted as RGBRGBRGB.

virtual int	GetDPI ()
	Return a best estimate to the dots per inch of the display device being rendered (or printed).

virtual void	SetDPI (int)
	Return a best estimate to the dots per inch of the display device being rendered (or printed).

void	SetOffScreenRendering (vtkTypeBool val)
	Convenience to set SHowWindow and UseOffScreenBuffers in one call.

virtual void	OffScreenRenderingOn ()
	Convenience to set SHowWindow and UseOffScreenBuffers in one call.

virtual void	OffScreenRenderingOff ()
	Convenience to set SHowWindow and UseOffScreenBuffers in one call.

virtual void	SetTileScale (int, int)
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.

void	SetTileScale (int[2])
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.

virtual int *	GetTileScale ()
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.

virtual void	GetTileScale (int &, int &)
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.

virtual void	GetTileScale (int[2])
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.

void	SetTileScale (int s)
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.

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.

virtual void	SetTileViewport (double[4])
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.

virtual double *	GetTileViewport ()
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.

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.

virtual void	GetTileViewport (double[4])
	These methods are used by vtkWindowToImageFilter to tell a VTK window to simulate a larger window by tiling.

virtual void	SetBorders (vtkTypeBool)
	Turn on/off window manager borders.

virtual vtkTypeBool	GetBorders ()
	Turn on/off window manager borders.

virtual void	BordersOn ()
	Turn on/off window manager borders.

virtual void	BordersOff ()
	Turn on/off window manager borders.

virtual void	SetCursorPosition (int, int)
	Hide or Show the mouse cursor, it is nice to be able to hide the default cursor if you want VTK to display a 3D cursor instead.

virtual int	GetCurrentCursor ()
	Change the shape of the cursor.

	vtkSetFilePathMacro (CursorFileName)
	Set/Get the full path to the custom cursor.

	vtkGetFilePathMacro (CursorFileName)
	Set/Get the full path to the custom cursor.

Public Member Functions inherited from vtkObject
	vtkBaseTypeMacro (vtkObject, vtkObjectBase)

virtual void	DebugOn ()
	Turn debugging output on.

virtual void	DebugOff ()
	Turn debugging output off.

bool	GetDebug ()
	Get the value of the debug flag.

void	SetDebug (bool debugFlag)
	Set the value of the debug flag.

virtual void	Modified ()
	Update the modification time for this object.

virtual vtkMTimeType	GetMTime ()
	Return this object's modified time.

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.

unsigned long	AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

unsigned long	AddObserver (const char event, vtkCommand , float priority=0.0f)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkCommand *	GetCommand (unsigned long tag)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObserver (vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

void	RemoveObservers (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (unsigned long event, vtkCommand *)
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

vtkTypeBool	HasObserver (const char event, vtkCommand )
	Allow people to add/remove/invoke observers (callbacks) to any VTK object.

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.

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.

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.

vtkTypeBool	InvokeEvent (unsigned long event, void *callData)
	This method invokes an event and return whether the event was aborted or not.

vtkTypeBool	InvokeEvent (const char event, void callData)
	This method invokes an event and return whether the event was aborted or not.

virtual void	SetObjectName (const std::string &objectName)
	Set/get the name of this object for reporting purposes.

virtual std::string	GetObjectName () const
	Set/get the name of this object for reporting purposes.

Public Member Functions inherited from vtkObjectBase
const char *	GetClassName () const
	Return the class name as a string.

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).

virtual void	Delete ()
	Delete a VTK object.

virtual void	FastDelete ()
	Delete a reference to this object.

void	InitializeObjectBase ()

void	Print (ostream &os)
	Print an object to an ostream.

void	Register (vtkObjectBase *o)
	Increase the reference count (mark as used by another object).

virtual void	UnRegister (vtkObjectBase *o)
	Decrease the reference count (release by another object).

int	GetReferenceCount ()
	Return the current reference count of this object.

void	SetReferenceCount (int)
	Sets the reference count.

bool	GetIsInMemkind () const
	A local state flag that remembers whether this object lives in the normal or extended memory space.

virtual void	PrintHeader (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual void	PrintTrailer (ostream &os, vtkIndent indent)
	Methods invoked by print to print information about the object including superclasses.

virtual bool	UsesGarbageCollector () const
	Indicate whether the class uses `vtkGarbageCollector` or not.

Static Public Member Functions
static vtkXlibHardwareWindow *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkXlibHardwareWindow *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkHardwareWindow
static vtkHardwareWindow *	New ()

static vtkTypeBool	IsTypeOf (const char *type)

static vtkHardwareWindow *	SafeDownCast (vtkObjectBase *o)

Static Public Member Functions inherited from vtkWindow
static vtkTypeBool	IsTypeOf (const char *type)

static vtkWindow *	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.

static void	BreakOnError ()
	This method is called when vtkErrorMacro executes.

static void	SetGlobalWarningDisplay (vtkTypeBool val)
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOn ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static void	GlobalWarningDisplayOff ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

static vtkTypeBool	GetGlobalWarningDisplay ()
	This is a global flag that controls whether any debug, warning or error messages are displayed.

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.

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).

static vtkObjectBase *	New ()
	Create an object with Debug turned off, modified time initialized to zero, and reference counting on.

static void	SetMemkindDirectory (const char *directoryname)
	The name of a directory, ideally mounted -o dax, to memory map an extended memory space within.

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.

Protected Member Functions
virtual vtkObjectBase *	NewInstanceInternal () const

	vtkXlibHardwareWindow ()

	~vtkXlibHardwareWindow () override

vtkXVisualInfo *	GetDesiredVisualInfo ()

void	CloseDisplay ()

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.

void	InternalReleaseFocus ()
	These methods allow a command to exclusively grab all events.

Protected Member Functions inherited from vtkObjectBase
	vtkObjectBase ()

virtual	~vtkObjectBase ()

virtual void	ReportReferences (vtkGarbageCollector *)

	vtkObjectBase (const vtkObjectBase &)

void	operator= (const vtkObjectBase &)

Protected Attributes
Display *	DisplayId

Window	ParentId

Window	WindowId

Colormap	ColorMap

vtkTypeBool	OwnDisplay

vtkTypeBool	OwnWindow

vtkTypeBool	CursorHidden

Cursor	XCCrosshair

Cursor	XCArrow

Cursor	XCSizeAll

Cursor	XCSizeNS

Cursor	XCSizeWE

Cursor	XCSizeNE

Cursor	XCSizeNW

Cursor	XCSizeSE

Cursor	XCSizeSW

Cursor	XCHand

Cursor	XCCustom

Protected Attributes inherited from vtkHardwareWindow
vtkWeakPointer< vtkRenderWindowInteractor >	Interactor = nullptr

vtkTypeBool	Coverable = false

std::string	Platform = "Generic"

vtkTypeBool	FullScreen = false

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

vtkTypeBool	Borders = true

int	CurrentCursor = VTK_CURSOR_DEFAULT

char *	CursorFileName = nullptr

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

Events:: vtkCommand::CursorChangedEvent

Definition at line 25 of file vtkXlibHardwareWindow.h.

Member Typedef Documentation

◆ Superclass

typedef vtkHardwareWindow vtkXlibHardwareWindow::Superclass

Definition at line 29 of file vtkXlibHardwareWindow.h.

Constructor & Destructor Documentation

◆ vtkXlibHardwareWindow()

vtkXlibHardwareWindow::vtkXlibHardwareWindow ( )

protected

◆ ~vtkXlibHardwareWindow()

vtkXlibHardwareWindow::~vtkXlibHardwareWindow ( )

overrideprotected

Member Function Documentation

◆ New()

static vtkXlibHardwareWindow * vtkXlibHardwareWindow::New ( )

static

◆ IsTypeOf()

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

static

◆ IsA()

virtual vtkTypeBool vtkXlibHardwareWindow::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 vtkXlibHardwareWindow * vtkXlibHardwareWindow::SafeDownCast ( vtkObjectBase * o )

static

◆ NewInstanceInternal()

virtual vtkObjectBase * vtkXlibHardwareWindow::NewInstanceInternal ( ) const

protectedvirtual

Reimplemented from vtkHardwareWindow.

◆ NewInstance()

vtkXlibHardwareWindow * vtkXlibHardwareWindow::NewInstance ( ) const

◆ PrintSelf()

void vtkXlibHardwareWindow::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.

◆ GetDisplayId()

Display * vtkXlibHardwareWindow::GetDisplayId ( )

Get/set the X11 display.

If unset, windows will open the default display (":0.0" unless the DISPLAY environment variable is provided).

◆ SetDisplayId() [1/2]

void vtkXlibHardwareWindow::SetDisplayId ( Display * display )

Get/set the X11 display.

If unset, windows will open the default display (":0.0" unless the DISPLAY environment variable is provided).

◆ SetParentId() [1/2]

void vtkXlibHardwareWindow::SetParentId ( Window )

Sets the parent of the window that WILL BE created.

◆ GetWindowId()

Window vtkXlibHardwareWindow::GetWindowId ( )

Get this RenderWindow's X window id.

◆ SetWindowId() [1/2]

void vtkXlibHardwareWindow::SetWindowId ( Window )

Set this RenderWindow's X window id to a pre-existing window.

◆ SetWindowId() [2/2]

void vtkXlibHardwareWindow::SetWindowId ( void * )

overridevirtual

Set this RenderWindow's X window id to a pre-existing window.

Reimplemented from vtkWindow.

◆ Create()

void vtkXlibHardwareWindow::Create ( )

overridevirtual

Reimplemented from vtkHardwareWindow.

◆ Destroy()

void vtkXlibHardwareWindow::Destroy ( )

overridevirtual

Reimplemented from vtkHardwareWindow.