vtkGenericOpenGLRenderWindow Class Reference

#include <vtkGenericOpenGLRenderWindow.h>

Inheritance diagram for vtkGenericOpenGLRenderWindow:

Inheritance graph
[legend]
Collaboration diagram for vtkGenericOpenGLRenderWindow:

Collaboration graph
[legend]

List of all members.


Detailed Description

platform independent render window

vtkGenericOpenGLRenderWindow provides a skeleton for implementing a render window using one's own OpenGL context and drawable. To be effective, one must register an observer for WindowMakeCurrentEvent, WindowIsCurrentEvent and WindowFrameEvent. When this class sends a WindowIsCurrentEvent, the call data is an bool* which one can use to return whether the context is current.

Events:
vtkCommand::WindowSupportsOpenGLEvent vtkCommand::WindowFrameEvent vtkCommand::WindowIsCurrentEvent vtkCommand::WindowIsDirectEvent vtkCommand::WindowMakeCurrentEvent
Tests:
vtkGenericOpenGLRenderWindow (Tests)

Definition at line 37 of file vtkGenericOpenGLRenderWindow.h.


Public Types

typedef vtkOpenGLRenderWindow Superclass

Public Member Functions

virtual const char * GetClassName ()
virtual int IsA (const char *type)
void PrintSelf (ostream &os, vtkIndent indent)
void Finalize ()
 Cleans up graphics resources allocated in the context for this VTK scene.
void Frame ()
 flush the pending drawing operations Class user may to watch for WindowFrameEvent and act on it
void MakeCurrent ()
 Makes the context current.
bool IsCurrent ()
 Returns if the context is current.
int SupportsOpenGL ()
 Returns if OpenGL is supported.
int IsDirect ()
 Returns if the context is direct.
void SetFrontBuffer (unsigned int)
 set the drawing buffers to use
void SetFrontLeftBuffer (unsigned int)
void SetFrontRightBuffer (unsigned int)
void SetBackBuffer (unsigned int)
void SetBackLeftBuffer (unsigned int)
void SetBackRightBuffer (unsigned int)
void PushState ()
 convenience function to push the state and push/init the tranform matrices
void PopState ()
 convenience function to pop the state and pop the tranform matrices
void SetWindowId (void *)
 does nothing
void * GetGenericWindowId ()
void SetDisplayId (void *)
void SetParentId (void *)
void * GetGenericDisplayId ()
void * GetGenericParentId ()
void * GetGenericContext ()
void * GetGenericDrawable ()
void SetWindowInfo (char *)
void SetParentInfo (char *)
int * GetScreenSize ()
void Start ()
void HideCursor ()
void ShowCursor ()
void SetFullScreen (int)
void WindowRemap ()
int GetEventPending ()
void SetNextWindowId (void *)
void SetNextWindowInfo (char *)
void CreateAWindow ()
void DestroyWindow ()

Static Public Member Functions

static
vtkGenericOpenGLRenderWindow
New ()
static int IsTypeOf (const char *type)
static
vtkGenericOpenGLRenderWindow
SafeDownCast (vtkObject *o)

Protected Member Functions

 vtkGenericOpenGLRenderWindow ()
 ~vtkGenericOpenGLRenderWindow ()

Member Typedef Documentation

Reimplemented from vtkOpenGLRenderWindow.

Definition at line 41 of file vtkGenericOpenGLRenderWindow.h.


Constructor & Destructor Documentation

vtkGenericOpenGLRenderWindow::vtkGenericOpenGLRenderWindow (  )  [protected]

vtkGenericOpenGLRenderWindow::~vtkGenericOpenGLRenderWindow (  )  [protected]


Member Function Documentation

static vtkGenericOpenGLRenderWindow* vtkGenericOpenGLRenderWindow::New (  )  [static]

Construct an instance of vtkRenderWindow with its screen size set to 300x300, borders turned on, positioned at (0,0), double buffering turned on.

Reimplemented from vtkRenderWindow.

virtual const char* vtkGenericOpenGLRenderWindow::GetClassName (  )  [virtual]

Reimplemented from vtkOpenGLRenderWindow.

static int vtkGenericOpenGLRenderWindow::IsTypeOf ( const char *  name  )  [static]

Return 1 if this class type 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 vtkOpenGLRenderWindow.

virtual int vtkGenericOpenGLRenderWindow::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 vtkOpenGLRenderWindow.

static vtkGenericOpenGLRenderWindow* vtkGenericOpenGLRenderWindow::SafeDownCast ( vtkObject o  )  [static]

Reimplemented from vtkOpenGLRenderWindow.

void vtkGenericOpenGLRenderWindow::PrintSelf ( ostream &  os,
vtkIndent  indent 
) [virtual]

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

void vtkGenericOpenGLRenderWindow::Finalize (  )  [virtual]

Cleans up graphics resources allocated in the context for this VTK scene.

Implements vtkRenderWindow.

void vtkGenericOpenGLRenderWindow::Frame (  )  [virtual]

flush the pending drawing operations Class user may to watch for WindowFrameEvent and act on it

Implements vtkRenderWindow.

void vtkGenericOpenGLRenderWindow::MakeCurrent (  )  [virtual]

Makes the context current.

It is the class user's responsibility to watch for WindowMakeCurrentEvent and set it current.

Implements vtkRenderWindow.

bool vtkGenericOpenGLRenderWindow::IsCurrent (  )  [virtual]

Returns if the context is current.

It is the class user's responsibility to watch for WindowIsCurrentEvent and set the bool* flag passed through the call data parameter.

Implements vtkRenderWindow.

int vtkGenericOpenGLRenderWindow::SupportsOpenGL (  )  [virtual]

Returns if OpenGL is supported.

It is the class user's responsibility to watch for WindowSupportsOpenGLEvent and set the int* flag passed through the call data parameter.

Reimplemented from vtkRenderWindow.

int vtkGenericOpenGLRenderWindow::IsDirect (  )  [virtual]

Returns if the context is direct.

It is the class user's responsibility to watch for WindowIsDirectEvent and set the int* flag passed through the call data parameter.

Reimplemented from vtkRenderWindow.

void vtkGenericOpenGLRenderWindow::SetFrontBuffer ( unsigned  int  ) 

set the drawing buffers to use

void vtkGenericOpenGLRenderWindow::SetFrontLeftBuffer ( unsigned  int  ) 

void vtkGenericOpenGLRenderWindow::SetFrontRightBuffer ( unsigned  int  ) 

void vtkGenericOpenGLRenderWindow::SetBackBuffer ( unsigned  int  ) 

void vtkGenericOpenGLRenderWindow::SetBackLeftBuffer ( unsigned  int  ) 

void vtkGenericOpenGLRenderWindow::SetBackRightBuffer ( unsigned  int  ) 

void vtkGenericOpenGLRenderWindow::PushState (  ) 

convenience function to push the state and push/init the tranform matrices

void vtkGenericOpenGLRenderWindow::PopState (  ) 

convenience function to pop the state and pop the tranform matrices

void vtkGenericOpenGLRenderWindow::SetWindowId ( void *   )  [virtual]

does nothing

Implements vtkRenderWindow.

void* vtkGenericOpenGLRenderWindow::GetGenericWindowId (  )  [virtual]

Dummy stubs for vtkWindow API.

Implements vtkRenderWindow.

void vtkGenericOpenGLRenderWindow::SetDisplayId ( void *   )  [virtual]

Dummy stubs for vtkWindow API.

Implements vtkRenderWindow.

void vtkGenericOpenGLRenderWindow::SetParentId ( void *   )  [virtual]

Dummy stubs for vtkWindow API.

Implements vtkRenderWindow.

void* vtkGenericOpenGLRenderWindow::GetGenericDisplayId (  )  [virtual]

Dummy stubs for vtkWindow API.

Implements vtkRenderWindow.

void* vtkGenericOpenGLRenderWindow::GetGenericParentId (  )  [virtual]

Dummy stubs for vtkWindow API.

Implements vtkRenderWindow.

void* vtkGenericOpenGLRenderWindow::GetGenericContext (  )  [virtual]

Dummy stubs for vtkWindow API.

Implements vtkRenderWindow.

void* vtkGenericOpenGLRenderWindow::GetGenericDrawable (  )  [virtual]

Dummy stubs for vtkWindow API.

Implements vtkRenderWindow.

void vtkGenericOpenGLRenderWindow::SetWindowInfo ( char *   )  [virtual]

Dummy stubs for vtkWindow API.

Implements vtkRenderWindow.

void vtkGenericOpenGLRenderWindow::SetParentInfo ( char *   )  [virtual]

Dummy stubs for vtkWindow API.

Implements vtkRenderWindow.

int* vtkGenericOpenGLRenderWindow::GetScreenSize (  )  [virtual]

Get the current size of the screen in pixels.

Implements vtkWindow.

void vtkGenericOpenGLRenderWindow::Start (  )  [virtual]

Initialize the rendering process.

Implements vtkRenderWindow.

void vtkGenericOpenGLRenderWindow::HideCursor (  )  [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. Set cursor position in window (note that (0,0) is the lower left corner).

Implements vtkRenderWindow.

void vtkGenericOpenGLRenderWindow::ShowCursor (  )  [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. Set cursor position in window (note that (0,0) is the lower left corner).

Implements vtkRenderWindow.

void vtkGenericOpenGLRenderWindow::SetFullScreen ( int   )  [virtual]

Turn on/off rendering full screen window size.

Implements vtkRenderWindow.

void vtkGenericOpenGLRenderWindow::WindowRemap (  )  [virtual]

Remap the rendering window. This probably only works on UNIX right now. It is useful for changing properties that can't normally be changed once the window is up.

Implements vtkRenderWindow.

int vtkGenericOpenGLRenderWindow::GetEventPending (  )  [virtual]

Check to see if a mouse button has been pressed. All other events are ignored by this method. 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.

void vtkGenericOpenGLRenderWindow::SetNextWindowId ( void *   )  [virtual]

Dummy stubs for vtkWindow API.

Implements vtkRenderWindow.

void vtkGenericOpenGLRenderWindow::SetNextWindowInfo ( char *   )  [virtual]

Dummy stubs for vtkWindow API.

Implements vtkRenderWindow.

void vtkGenericOpenGLRenderWindow::CreateAWindow (  )  [virtual]

Create a not-off-screen window.

Implements vtkOpenGLRenderWindow.

void vtkGenericOpenGLRenderWindow::DestroyWindow (  )  [virtual]

Destroy a not-off-screen window.

Implements vtkOpenGLRenderWindow.


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

Generated on Wed Aug 24 11:37:29 2011 for VTK by  doxygen 1.5.6