vtkFLTKOpenGLRenderWindow Class Reference

#include <vtkFLTKOpenGLRenderWindow.h>

Inheritance diagram for vtkFLTKOpenGLRenderWindow:

[legend]Collaboration diagram for vtkFLTKOpenGLRenderWindow:

[legend]List of all members.

---

Detailed Description

OpenGL rendering window for FLTK interface.

vtkFLTKOpenGLRenderWindow is a concrete implementation of the abstract class vtkRenderWindow and the vtkOpenGLRenderer interfaces to the OpenGL graphics library. Application programmers should normally use vtkRenderWindow instead of the FLTK-OpenGL specific version.

Author:

Sean McInerney

Version:

Revision

1.22

Date:

Date

2004/06/15 18:40:26

See also:

vtkOpenGLRenderWindow Fl_VTK_Window Fl_Group

Definition at line 45 of file vtkFLTKOpenGLRenderWindow.h.

Public Member Functions
	vtkTypeRevisionMacro (vtkFLTKOpenGLRenderWindow, vtkOpenGLRenderWindow)
void	PrintSelf (ostream &, vtkIndent)
virtual void	Start (void)
	Begin the rendering process.
virtual void	Frame (void)
	End the rendering process and display the image.
virtual void	WindowInitialize (void)
	Initialize the window for rendering.
virtual void	Initialize (void)
	Initialize the rendering window.
virtual void	Finalize (void)
	"Deinitialize" the rendering window.
virtual void	WindowRemap (void)
	Remap the rendering window.
virtual int	GetEventPending (void)
	Check to see if a mouse button has been pressed.
void	MakeCurrent (void)
	Make this window the current OpenGL context.
void	SetForceMakeCurrent (void)
	If called, allow MakeCurrent() to skip cache-check when called.
void	Render (void)
	Updates window size before calling the superclass Render().
int *	GetScreenSize (void)
	Get the size of the screen in pixels.
int *	GetPosition (void)
	Get the position in screen coordinates (pixels) of the window.
int *	GetSize (void)
	Get the width and height in screen coordinates (pixels) of the window.
void	SetWindowName (const char *name)
	Set the name of the window.
void	SetOffScreenRendering (int toggle)
	Render without displaying the window.
virtual void	SetCurrentCursor (int shape)
	Change the shape of the cursor.
void	SetFullScreen (int)
	Change the window to fill the entire screen.
void	PrefFullScreen (void)
	Set the preferred window size to full screen.
void	SetBorders (int a)
	Toggle whether the window manager border is around the window.
void	SetStereoCapableWindow (int a)
	Toggle whether the window will be created in a stereo-capable mode.
virtual int	GetDesiredVisualMode (void)
	Get the properties of an ideal rendering window.
const char *	ReportCapabilities (void)
	Get report of capabilities for the render window.
int	SupportsOpenGL (void)
	Does this render window support OpenGL? 0-false, 1-true.
int	IsDirect (void)
	Is this render window using hardware acceleration? 0-false, 1-true.
Fl_Group *	GetFlParent (void)
	Get this RenderWindow's parent FLTK group (if any).
void	SetFlParent (Fl_Group *group)
	Sets the FLTK parent of the window that WILL BE created.
void	SetFlParent (void *group)
	Sets the FLTK parent of the window that WILL BE created (dangerously).
Fl_VTK_Window *	GetFlWindow (void)
	Get this RenderWindow's FLTK window.
void	SetFlWindow (Fl_VTK_Window *window)
	Set this RenderWindow to an existing FLTK window.
void	SetFlWindow (void *window)
	Set this RenderWindow to an existing FLTK window (dangerously).
void	SetPosition (int x, int y)
	Move the window to a new position on the display.
void	SetPosition (int a[2])
	Move the window to a new position on the display.
void	SetSize (int w, int h)
	Specify the size of the rendering window.
void	SetSize (int a[2])
	Specify the size of the rendering window.
void	SetMapped (int a)
	Keep track of whether the rendering window has been mapped to screen.
int	GetMapped (void)
	Keep track of whether the rendering window has been mapped to screen.
void	HideCursor (void)
	Hide or Show the mouse cursor.
void	ShowCursor (void)
	Hide or Show the mouse cursor.
void	SetDisplayId (void *id)
	Implementation of vtkWindow's system independent methods that are used to help interface to native windowing systems.
void	SetWindowId (void *id)
	Implementation of vtkWindow's system independent methods that are used to help interface to native windowing systems.
void	SetParentId (void *id)
	Implementation of vtkWindow's system independent methods that are used to help interface to native windowing systems.
void *	GetGenericDisplayId (void)
	Implementation of vtkWindow's system independent methods that are used to help interface to native windowing systems.
void *	GetGenericWindowId (void)
	Implementation of vtkWindow's system independent methods that are used to help interface to native windowing systems.
void *	GetGenericParentId (void)
	Implementation of vtkWindow's system independent methods that are used to help interface to native windowing systems.
void *	GetGenericContext (void)
	Implementation of vtkWindow's system independent methods that are used to help interface to native windowing systems.
void *	GetGenericDrawable (void)
	Implementation of vtkWindow's system independent methods that are used to help interface to native windowing systems.
void	SetDisplayInfo (char *id)
	Implementation of vtkWindow's system independent methods that are used to help interface to native windowing systems.
void	SetWindowInfo (char *id)
	Implementation of vtkWindow's system independent methods that are used to help interface to native windowing systems.
void	SetParentInfo (char *id)
	Implementation of vtkWindow's system independent methods that are used to help interface to native windowing systems.
void	SetNextWindowId (void *id)
	Implementation of vtkWindow's system independent methods that are used to help interface to native windowing systems.
void	SetNextWindowInfo (char *id)
	Implementation of vtkWindow's system independent methods that are used to help interface to native windowing systems.
Static Public Member Functions
vtkFLTKOpenGLRenderWindow *	New (void)
Protected Member Functions
	vtkFLTKOpenGLRenderWindow (void)
	~vtkFLTKOpenGLRenderWindow ()
virtual void	CheckDisplayConnection ()
	Set this RenderWindow to use fl_display, maybe opening the display.
Protected Attributes
vtkFLTKOpenGLRenderWindowInternal *	Internal
Fl_Group *	FlParent
Fl_VTK_Window *	FlWindow
int	Mode
int	OwnFlWindow
int	ScreenSize [2]
int	CursorHidden
int	ForceMakeCurrent
int	UsingHardware
char *	Capabilities

---

Constructor & Destructor Documentation

vtkFLTKOpenGLRenderWindow::vtkFLTKOpenGLRenderWindow (  void   )  [protected]

vtkFLTKOpenGLRenderWindow::~vtkFLTKOpenGLRenderWindow (   )  [protected]

---

Member Function Documentation

virtual void vtkFLTKOpenGLRenderWindow::CheckDisplayConnection (   )  [protected, virtual]

Set this RenderWindow to use fl_display, maybe opening the display.

virtual void vtkFLTKOpenGLRenderWindow::Finalize (  void   )  [virtual]

"Deinitialize" the rendering window. This will shutdown all system-specific resources. After having called this, it should be possible to destroy a window that was used for a SetWindow() call without any ill effects.

virtual void vtkFLTKOpenGLRenderWindow::Frame (  void   )  [virtual]

End the rendering process and display the image. Implements vtkRenderWindow.

virtual int vtkFLTKOpenGLRenderWindow::GetDesiredVisualMode (  void   )  [virtual]

Get the properties of an ideal rendering window.

virtual int vtkFLTKOpenGLRenderWindow::GetEventPending (  void   )  [virtual]

Check to see if a mouse button has been pressed. All other events are ignored by this method. This is a useful check to abort a long render. Ideally, you want to abort the render on any event which causes the DesiredUpdateRate to switch from a high-quality rate to a more interactive rate. Implements vtkRenderWindow.

Fl_Group* vtkFLTKOpenGLRenderWindow::GetFlParent (  void   )

Get this RenderWindow's parent FLTK group (if any).

Fl_VTK_Window* vtkFLTKOpenGLRenderWindow::GetFlWindow (  void   )

Get this RenderWindow's FLTK window.

void* vtkFLTKOpenGLRenderWindow::GetGenericContext (  void   )  [virtual]

Implementation of vtkWindow's system independent methods that are used to help interface to native windowing systems. Note: These methods can only be used to set Fl_Window subclasses as parent since an Fl_Group is never associated with an XID. Implements vtkRenderWindow.

void* vtkFLTKOpenGLRenderWindow::GetGenericDisplayId (  void   )  [virtual]

Implementation of vtkWindow's system independent methods that are used to help interface to native windowing systems. Note: These methods can only be used to set Fl_Window subclasses as parent since an Fl_Group is never associated with an XID. Implements vtkRenderWindow.

void* vtkFLTKOpenGLRenderWindow::GetGenericDrawable (  void   )  [virtual]

Implementation of vtkWindow's system independent methods that are used to help interface to native windowing systems. Note: These methods can only be used to set Fl_Window subclasses as parent since an Fl_Group is never associated with an XID. Implements vtkRenderWindow.

void* vtkFLTKOpenGLRenderWindow::GetGenericParentId (  void   )  [virtual]

Implementation of vtkWindow's system independent methods that are used to help interface to native windowing systems. Note: These methods can only be used to set Fl_Window subclasses as parent since an Fl_Group is never associated with an XID. Implements vtkRenderWindow.

void* vtkFLTKOpenGLRenderWindow::GetGenericWindowId (  void   )  [virtual]

Implementation of vtkWindow's system independent methods that are used to help interface to native windowing systems. Note: These methods can only be used to set Fl_Window subclasses as parent since an Fl_Group is never associated with an XID. Implements vtkRenderWindow.

int vtkFLTKOpenGLRenderWindow::GetMapped (  void   )  [virtual]

Keep track of whether the rendering window has been mapped to screen. Reimplemented from vtkWindow.

int* vtkFLTKOpenGLRenderWindow::GetPosition (  void   )  [virtual]

Get the position in screen coordinates (pixels) of the window. Reimplemented from vtkWindow.

int* vtkFLTKOpenGLRenderWindow::GetScreenSize (  void   )  [virtual]

Get the size of the screen in pixels. Implements vtkWindow.

int* vtkFLTKOpenGLRenderWindow::GetSize (  void   )  [virtual]

Get the width and height in screen coordinates (pixels) of the window. Reimplemented from vtkWindow.

void vtkFLTKOpenGLRenderWindow::HideCursor (  void   )  [virtual]

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. Note: Set cursor position in window (note that (0,0) is the lower left corner). Implements vtkRenderWindow.

virtual void vtkFLTKOpenGLRenderWindow::Initialize (  void   )  [virtual]

Initialize the rendering window. This will setup all system-specific resources. This method and Finalize() must be symmetric and it should be possible to call them multiple times, even changing the underlying window Id in-between. This is what WindowRemap() does.

int vtkFLTKOpenGLRenderWindow::IsDirect (  void   )  [virtual]

Is this render window using hardware acceleration? 0-false, 1-true. Reimplemented from vtkRenderWindow.

void vtkFLTKOpenGLRenderWindow::MakeCurrent (  void   )  [virtual]

Make this window the current OpenGL context. Implements vtkOpenGLRenderWindow.

vtkFLTKOpenGLRenderWindow* vtkFLTKOpenGLRenderWindow::New (  void   )  [static]

Reimplemented from vtkRenderWindow.

void vtkFLTKOpenGLRenderWindow::PrefFullScreen (  void   )

Set the preferred window size to full screen.

void vtkFLTKOpenGLRenderWindow::PrintSelf (  ostream &  , vtkIndent  )  [virtual]

Reimplemented from vtkOpenGLRenderWindow.

void vtkFLTKOpenGLRenderWindow::Render (  void   )  [virtual]

Updates window size before calling the superclass Render(). Reimplemented from vtkRenderWindow.

const char* vtkFLTKOpenGLRenderWindow::ReportCapabilities (  void   )  [virtual]

Get report of capabilities for the render window. Reimplemented from vtkRenderWindow.

void vtkFLTKOpenGLRenderWindow::SetBorders (  int  a  )  [virtual]

Toggle whether the window manager border is around the window. The default value is true. Under most X window managers this does not work after the window has been mapped. Reimplemented from vtkRenderWindow.

virtual void vtkFLTKOpenGLRenderWindow::SetCurrentCursor (  int  shape  )  [virtual]

Change the shape of the cursor. Reimplemented from vtkRenderWindow.

void vtkFLTKOpenGLRenderWindow::SetDisplayId (  void *  id  )  [virtual]

Implementation of vtkWindow's system independent methods that are used to help interface to native windowing systems. Note: These methods can only be used to set Fl_Window subclasses as parent since an Fl_Group is never associated with an XID. Implements vtkRenderWindow.

void vtkFLTKOpenGLRenderWindow::SetDisplayInfo (  char *  id  )

Implementation of vtkWindow's system independent methods that are used to help interface to native windowing systems. Note: These methods can only be used to set Fl_Window subclasses as parent since an Fl_Group is never associated with an XID.

void vtkFLTKOpenGLRenderWindow::SetFlParent (  void *  group  )

Sets the FLTK parent of the window that WILL BE created (dangerously).

void vtkFLTKOpenGLRenderWindow::SetFlParent (  Fl_Group *  group  )

Sets the FLTK parent of the window that WILL BE created.

void vtkFLTKOpenGLRenderWindow::SetFlWindow (  void *  window  )

Set this RenderWindow to an existing FLTK window (dangerously).

void vtkFLTKOpenGLRenderWindow::SetFlWindow (  Fl_VTK_Window *  window  )

Set this RenderWindow to an existing FLTK window.

void vtkFLTKOpenGLRenderWindow::SetForceMakeCurrent (  void   )  [virtual]

If called, allow MakeCurrent() to skip cache-check when called. MakeCurrent() reverts to original behavior of cache-checking on the next render. Reimplemented from vtkRenderWindow.

void vtkFLTKOpenGLRenderWindow::SetFullScreen (  int   )  [virtual]

Change the window to fill the entire screen. Implements vtkRenderWindow.

void vtkFLTKOpenGLRenderWindow::SetMapped (  int  a  )  [virtual]

Keep track of whether the rendering window has been mapped to screen. Reimplemented from vtkWindow.

void vtkFLTKOpenGLRenderWindow::SetNextWindowId (  void *  id  )  [virtual]

Implementation of vtkWindow's system independent methods that are used to help interface to native windowing systems. Note: These methods can only be used to set Fl_Window subclasses as parent since an Fl_Group is never associated with an XID. Implements vtkRenderWindow.

void vtkFLTKOpenGLRenderWindow::SetNextWindowInfo (  char *  id  )  [virtual]

Implementation of vtkWindow's system independent methods that are used to help interface to native windowing systems. Note: These methods can only be used to set Fl_Window subclasses as parent since an Fl_Group is never associated with an XID. Implements vtkRenderWindow.

void vtkFLTKOpenGLRenderWindow::SetOffScreenRendering (  int  toggle  )  [virtual]

Render without displaying the window. Reimplemented from vtkWindow.

void vtkFLTKOpenGLRenderWindow::SetParentId (  void *  id  )  [virtual]

Implementation of vtkWindow's system independent methods that are used to help interface to native windowing systems. Note: These methods can only be used to set Fl_Window subclasses as parent since an Fl_Group is never associated with an XID. Implements vtkRenderWindow.

void vtkFLTKOpenGLRenderWindow::SetParentInfo (  char *  id  )  [virtual]

Implementation of vtkWindow's system independent methods that are used to help interface to native windowing systems. Note: These methods can only be used to set Fl_Window subclasses as parent since an Fl_Group is never associated with an XID. Implements vtkRenderWindow.

void vtkFLTKOpenGLRenderWindow::SetPosition (  int  a[2]  )  [inline, virtual]

Move the window to a new position on the display. Reimplemented from vtkWindow. Definition at line 117 of file vtkFLTKOpenGLRenderWindow.h.

void vtkFLTKOpenGLRenderWindow::SetPosition (  int  x, int  y )  [virtual]

Move the window to a new position on the display. Reimplemented from vtkWindow.

void vtkFLTKOpenGLRenderWindow::SetSize (  int  a[2]  )  [inline, virtual]

Specify the size of the rendering window. Reimplemented from vtkWindow. Definition at line 126 of file vtkFLTKOpenGLRenderWindow.h.

void vtkFLTKOpenGLRenderWindow::SetSize (  int  w, int  h )  [virtual]

Specify the size of the rendering window. Reimplemented from vtkWindow.

void vtkFLTKOpenGLRenderWindow::SetStereoCapableWindow (  int  a  )  [virtual]

Toggle whether the window will be created in a stereo-capable mode. This method must be called before the window is realized. This method overrides the superclass method since this class can actually check whether the window has been realized yet. Reimplemented from vtkRenderWindow.

void vtkFLTKOpenGLRenderWindow::SetWindowId (  void *  id  )  [virtual]

Implementation of vtkWindow's system independent methods that are used to help interface to native windowing systems. Note: These methods can only be used to set Fl_Window subclasses as parent since an Fl_Group is never associated with an XID. Implements vtkRenderWindow.

void vtkFLTKOpenGLRenderWindow::SetWindowInfo (  char *  id  )  [virtual]

Implementation of vtkWindow's system independent methods that are used to help interface to native windowing systems. Note: These methods can only be used to set Fl_Window subclasses as parent since an Fl_Group is never associated with an XID. Implements vtkRenderWindow.

void vtkFLTKOpenGLRenderWindow::SetWindowName (  const char *  name  )  [virtual]

Set the name of the window. This normally appears at top of the window. Reimplemented from vtkWindow.

void vtkFLTKOpenGLRenderWindow::ShowCursor (  void   )  [virtual]

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. Note: Set cursor position in window (note that (0,0) is the lower left corner). Implements vtkRenderWindow.

virtual void vtkFLTKOpenGLRenderWindow::Start (  void   )  [virtual]

Begin the rendering process. Implements vtkRenderWindow.

int vtkFLTKOpenGLRenderWindow::SupportsOpenGL (  void   )  [virtual]

Does this render window support OpenGL? 0-false, 1-true. Reimplemented from vtkRenderWindow.

vtkFLTKOpenGLRenderWindow::vtkTypeRevisionMacro (  vtkFLTKOpenGLRenderWindow  , vtkOpenGLRenderWindow  )

virtual void vtkFLTKOpenGLRenderWindow::WindowInitialize (  void   )  [virtual]

Initialize the window for rendering.

virtual void vtkFLTKOpenGLRenderWindow::WindowRemap (  void   )  [virtual]

Remap the rendering window. This is useful for changing properties that can't normally be changed once the window is up. Implements vtkRenderWindow.

---

Member Data Documentation

char* vtkFLTKOpenGLRenderWindow::Capabilities [protected]

Definition at line 252 of file vtkFLTKOpenGLRenderWindow.h.

int vtkFLTKOpenGLRenderWindow::CursorHidden [protected]

Definition at line 249 of file vtkFLTKOpenGLRenderWindow.h.

Fl_Group* vtkFLTKOpenGLRenderWindow::FlParent [protected]

Definition at line 243 of file vtkFLTKOpenGLRenderWindow.h.

Fl_VTK_Window* vtkFLTKOpenGLRenderWindow::FlWindow [protected]

Definition at line 244 of file vtkFLTKOpenGLRenderWindow.h.

int vtkFLTKOpenGLRenderWindow::ForceMakeCurrent [protected]

Definition at line 250 of file vtkFLTKOpenGLRenderWindow.h.

vtkFLTKOpenGLRenderWindowInternal* vtkFLTKOpenGLRenderWindow::Internal [protected]

Definition at line 241 of file vtkFLTKOpenGLRenderWindow.h.

int vtkFLTKOpenGLRenderWindow::Mode [protected]

Definition at line 246 of file vtkFLTKOpenGLRenderWindow.h.

int vtkFLTKOpenGLRenderWindow::OwnFlWindow [protected]

Definition at line 247 of file vtkFLTKOpenGLRenderWindow.h.

int vtkFLTKOpenGLRenderWindow::ScreenSize[2] [protected]

Definition at line 248 of file vtkFLTKOpenGLRenderWindow.h.

int vtkFLTKOpenGLRenderWindow::UsingHardware [protected]

Definition at line 251 of file vtkFLTKOpenGLRenderWindow.h.

---

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

• vtkFLTKOpenGLRenderWindow.h

---