VTK
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
vtkGenericOpenGLRenderWindow Class Reference

platform independent render window More...

#include <vtkGenericOpenGLRenderWindow.h>

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

Public Types

typedef vtkOpenGLRenderWindow Superclass
- Public Types inherited from vtkOpenGLRenderWindow
typedef vtkRenderWindow Superclass
- Public Types inherited from vtkRenderWindow
typedef vtkWindow Superclass
- Public Types inherited from vtkWindow
typedef vtkObject Superclass
- Public Types inherited from vtkObject
typedef vtkObjectBase 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 ()
- Public Member Functions inherited from vtkOpenGLRenderWindow
virtual void StereoUpdate ()
void RegisterTextureResource (GLuint id)
int GetDepthBufferSize ()
int GetColorBufferSizes (int *rgba)
virtual void OpenGLInit ()
unsigned int GetBackLeftBuffer ()
unsigned int GetBackRightBuffer ()
unsigned int GetFrontLeftBuffer ()
unsigned int GetFrontRightBuffer ()
unsigned int GetBackBuffer ()
unsigned int GetFrontBuffer ()
virtual void CheckGraphicError ()
virtual int HasGraphicError ()
virtual const char * GetLastGraphicErrorString ()
vtkOpenGLExtensionManagerGetExtensionManager ()
vtkOpenGLHardwareSupportGetHardwareSupport ()
virtual void WaitForCompletion ()
virtual unsigned char * GetPixelData (int x, int y, int x2, int y2, int front)
virtual int GetPixelData (int x, int y, int x2, int y2, int front, vtkUnsignedCharArray *data)
virtual int SetPixelData (int x, int y, int x2, int y2, unsigned char *data, int front)
virtual int SetPixelData (int x, int y, int x2, int y2, vtkUnsignedCharArray *data, int front)
virtual float * GetRGBAPixelData (int x, int y, int x2, int y2, int front)
virtual int GetRGBAPixelData (int x, int y, int x2, int y2, int front, vtkFloatArray *data)
virtual int SetRGBAPixelData (int x, int y, int x2, int y2, float *data, int front, int blend=0)
virtual int SetRGBAPixelData (int x, int y, int x2, int y2, vtkFloatArray *data, int front, int blend=0)
virtual void ReleaseRGBAPixelData (float *data)
virtual unsigned char * GetRGBACharPixelData (int x, int y, int x2, int y2, int front)
virtual int GetRGBACharPixelData (int x, int y, int x2, int y2, int front, vtkUnsignedCharArray *data)
virtual int SetRGBACharPixelData (int x, int y, int x2, int y2, unsigned char *data, int front, int blend=0)
virtual int SetRGBACharPixelData (int x, int y, int x2, int y2, vtkUnsignedCharArray *data, int front, int blend=0)
virtual float * GetZbufferData (int x1, int y1, int x2, int y2)
virtual int GetZbufferData (int x1, int y1, int x2, int y2, float *z)
virtual int GetZbufferData (int x1, int y1, int x2, int y2, vtkFloatArray *z)
virtual int SetZbufferData (int x1, int y1, int x2, int y2, float *buffer)
virtual int SetZbufferData (int x1, int y1, int x2, int y2, vtkFloatArray *buffer)
virtual vtkTimeStamp GetContextCreationTime ()
vtkTextureUnitManagerGetTextureUnitManager ()
- Public Member Functions inherited from vtkRenderWindow
virtual void AddRenderer (vtkRenderer *)
void RemoveRenderer (vtkRenderer *)
int HasRenderer (vtkRenderer *)
vtkRendererCollectionGetRenderers ()
virtual void Render ()
virtual void CopyResultFrame ()
virtual vtkRenderWindowInteractorMakeRenderWindowInteractor ()
const char * GetStereoTypeAsString ()
virtual void StereoMidpoint ()
virtual void StereoRenderComplete ()
virtual int GetIsPicking ()
virtual void SetIsPicking (int)
virtual void IsPickingOn ()
virtual void IsPickingOff ()
virtual int CheckInRenderStatus ()
virtual void ClearInRenderStatus ()
void SetInteractor (vtkRenderWindowInteractor *)
virtual void UnRegister (vtkObjectBase *o)
virtual void SetForceMakeCurrent ()
virtual const char * ReportCapabilities ()
virtual void SetCursorPosition (int, int)
virtual void SetCurrentCursor (int)
virtual int GetCurrentCursor ()
virtual int GetFullScreen ()
virtual void FullScreenOn ()
virtual void FullScreenOff ()
virtual void SetBorders (int)
virtual int GetBorders ()
virtual void BordersOn ()
virtual void BordersOff ()
virtual int GetStereoCapableWindow ()
virtual void StereoCapableWindowOn ()
virtual void StereoCapableWindowOff ()
virtual void SetStereoCapableWindow (int capable)
virtual int GetStereoRender ()
void SetStereoRender (int stereo)
virtual void StereoRenderOn ()
virtual void StereoRenderOff ()
virtual void SetAlphaBitPlanes (int)
virtual int GetAlphaBitPlanes ()
virtual void AlphaBitPlanesOn ()
virtual void AlphaBitPlanesOff ()
virtual void SetPointSmoothing (int)
virtual int GetPointSmoothing ()
virtual void PointSmoothingOn ()
virtual void PointSmoothingOff ()
virtual void SetLineSmoothing (int)
virtual int GetLineSmoothing ()
virtual void LineSmoothingOn ()
virtual void LineSmoothingOff ()
virtual void SetPolygonSmoothing (int)
virtual int GetPolygonSmoothing ()
virtual void PolygonSmoothingOn ()
virtual void PolygonSmoothingOff ()
virtual int GetStereoType ()
virtual void SetStereoType (int)
void SetStereoTypeToCrystalEyes ()
void SetStereoTypeToRedBlue ()
void SetStereoTypeToInterlaced ()
void SetStereoTypeToLeft ()
void SetStereoTypeToRight ()
void SetStereoTypeToDresden ()
void SetStereoTypeToAnaglyph ()
void SetStereoTypeToCheckerboard ()
virtual void SetAnaglyphColorSaturation (float)
virtual float GetAnaglyphColorSaturation ()
virtual void SetAnaglyphColorMask (int, int)
void SetAnaglyphColorMask (int[2])
virtual int * GetAnaglyphColorMask ()
virtual void GetAnaglyphColorMask (int data[2])
virtual void SetSwapBuffers (int)
virtual int GetSwapBuffers ()
virtual void SwapBuffersOn ()
virtual void SwapBuffersOff ()
float GetZbufferDataAtPoint (int x, int y)
virtual int GetAAFrames ()
virtual void SetAAFrames (int)
virtual int GetFDFrames ()
virtual void SetFDFrames (int)
virtual int GetSubFrames ()
virtual void SetSubFrames (int subFrames)
virtual int GetNeverRendered ()
virtual int GetAbortRender ()
virtual void SetAbortRender (int)
virtual int GetInAbortCheck ()
virtual void SetInAbortCheck (int)
virtual int CheckAbortStatus ()
virtual void SetDesiredUpdateRate (double)
virtual double GetDesiredUpdateRate ()
virtual int GetNumberOfLayers ()
virtual void SetNumberOfLayers (int)
virtual vtkRenderWindowInteractorGetInteractor ()
virtual vtkPainterDeviceAdapterGetPainterDeviceAdapter ()
virtual void SetMultiSamples (int)
virtual int GetMultiSamples ()
virtual void SetStencilCapable (int)
virtual int GetStencilCapable ()
virtual void StencilCapableOn ()
virtual void StencilCapableOff ()
virtual void SetReportGraphicErrors (int)
virtual int GetReportGraphicErrors ()
virtual void ReportGraphicErrorsOn ()
virtual void ReportGraphicErrorsOff ()
- Public Member Functions inherited from vtkWindow
int * GetActualSize ()
virtual int * GetPosition ()
virtual void SetPosition (int, int)
virtual void SetPosition (int a[2])
virtual int * GetSize ()
virtual void SetSize (int, int)
virtual void SetSize (int a[2])
virtual void SetMapped (int)
virtual int GetMapped ()
virtual void MappedOn ()
virtual void MappedOff ()
virtual void SetErase (int)
virtual int GetErase ()
virtual void EraseOn ()
virtual void EraseOff ()
virtual void SetDoubleBuffer (int)
virtual int GetDoubleBuffer ()
virtual void DoubleBufferOn ()
virtual void DoubleBufferOff ()
virtual char * GetWindowName ()
virtual void SetWindowName (const char *)
virtual int GetDPI ()
virtual void SetDPI (int)
virtual void SetOffScreenRendering (int)
virtual int GetOffScreenRendering ()
virtual void OffScreenRenderingOn ()
virtual void OffScreenRenderingOff ()
virtual void SetTileScale (int, int)
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])
- Public Member Functions inherited from vtkObject
virtual void DebugOn ()
virtual void DebugOff ()
unsigned char GetDebug ()
void SetDebug (unsigned char debugFlag)
virtual void Modified ()
virtual unsigned long GetMTime ()
unsigned long AddObserver (unsigned long event, vtkCommand *, float priority=0.0f)
unsigned long AddObserver (const char *event, vtkCommand *, float priority=0.0f)
vtkCommandGetCommand (unsigned long tag)
void RemoveObserver (vtkCommand *)
void RemoveObservers (unsigned long event, vtkCommand *)
void RemoveObservers (const char *event, vtkCommand *)
int HasObserver (unsigned long event, vtkCommand *)
int HasObserver (const char *event, vtkCommand *)
void RemoveObserver (unsigned long tag)
void RemoveObservers (unsigned long event)
void RemoveObservers (const char *event)
void RemoveAllObservers ()
int HasObserver (unsigned long event)
int HasObserver (const char *event)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(), float priority=0.0f)
template<class U , class T >
unsigned long AddObserver (unsigned long event, U observer, void(T::*callback)(vtkObject *, unsigned long, void *), float priority=0.0f)
int InvokeEvent (unsigned long event, void *callData)
int InvokeEvent (const char *event, void *callData)
int InvokeEvent (unsigned long event)
int InvokeEvent (const char *event)
- Public Member Functions inherited from vtkObjectBase
const char * GetClassName () const
virtual void Delete ()
virtual void FastDelete ()
void Print (ostream &os)
virtual void Register (vtkObjectBase *o)
void SetReferenceCount (int)
void PrintRevisions (ostream &os)
virtual void PrintHeader (ostream &os, vtkIndent indent)
virtual void PrintTrailer (ostream &os, vtkIndent indent)
int GetReferenceCount ()

Static Public Member Functions

static
vtkGenericOpenGLRenderWindow
New ()
static int IsTypeOf (const char *type)
static
vtkGenericOpenGLRenderWindow
SafeDownCast (vtkObject *o)
- Static Public Member Functions inherited from vtkOpenGLRenderWindow
static void SetGlobalMaximumNumberOfMultiSamples (int val)
static int GetGlobalMaximumNumberOfMultiSamples ()
- Static Public Member Functions inherited from vtkRenderWindow
static const char * GetRenderLibrary ()

Protected Member Functions

 vtkGenericOpenGLRenderWindow ()
 ~vtkGenericOpenGLRenderWindow ()
- Protected Member Functions inherited from vtkOpenGLRenderWindow
 vtkOpenGLRenderWindow ()
 ~vtkOpenGLRenderWindow ()
int GetPixelData (int x, int y, int x2, int y2, int front, unsigned char *data)
int GetRGBAPixelData (int x, int y, int x2, int y2, int front, float *data)
int GetRGBACharPixelData (int x, int y, int x2, int y2, int front, unsigned char *data)
int CreateHardwareOffScreenWindow (int width, int height)
void DestroyHardwareOffScreenWindow ()
void SetTextureUnitManager (vtkTextureUnitManager *textureUnitManager)
- Protected Member Functions inherited from vtkRenderWindow
 vtkRenderWindow ()
 ~vtkRenderWindow ()
virtual void DoStereoRender ()
virtual void DoFDRender ()
virtual void DoAARender ()
- Protected Member Functions inherited from vtkWindow
 vtkWindow ()
 ~vtkWindow ()
- Protected Member Functions inherited from vtkObject
 vtkObject ()
virtual ~vtkObject ()
virtual void RegisterInternal (vtkObjectBase *, int check)
virtual void UnRegisterInternal (vtkObjectBase *, int check)
void InternalGrabFocus (vtkCommand *mouseEvents, vtkCommand *keypressEvents=NULL)
void InternalReleaseFocus ()
- Protected Member Functions inherited from vtkObjectBase
 vtkObjectBase ()
virtual ~vtkObjectBase ()
virtual void CollectRevisions (ostream &os)
virtual void ReportReferences (vtkGarbageCollector *)
 vtkObjectBase (const vtkObjectBase &)
void operator= (const vtkObjectBase &)

Additional Inherited Members

- Protected Attributes inherited from vtkOpenGLRenderWindow
long OldMonitorSetting
vtkIdListTextureResourceIds
int OffScreenUseFrameBuffer
unsigned int BackLeftBuffer
unsigned int BackRightBuffer
unsigned int FrontLeftBuffer
unsigned int FrontRightBuffer
unsigned int FrontBuffer
unsigned int BackBuffer
unsigned int LastGraphicError
vtkTimeStamp ContextCreationTime
vtkTextureUnitManagerTextureUnitManager
int NumberOfFrameBuffers
unsigned int TextureObjects [4]
unsigned int FrameBufferObject
unsigned int DepthRenderBufferObject
- Friends inherited from vtkObject

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.

Member Typedef Documentation

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: