SoWx
0.1.0
Coin3D GUI toolkit binding
|
The SoWxGLWidget class manages OpenGL contexts. More...
#include <Inventor/Wx/SoWxGLWidget.h>
Public Member Functions | |
SbBool | getAccumulationBuffer (void) const |
SbBool | getAlphaChannel (void) const |
wxWindow * | getGLWidget (void) const |
void | getLineWidthLimits (SbVec2f &range, float &granularity) |
wxWindow * | getNormalWidget (void) const |
unsigned long | getOverlayTransparentPixel (void) |
wxWindow * | getOverlayWidget (void) const |
void | getPointSizeLimits (SbVec2f &range, float &granularity) |
int | getSampleBuffers (void) const |
SbBool | getStencilBuffer (void) const |
SbBool | hasNormalGLArea (void) const |
SbBool | hasOverlayGLArea (void) const |
SbBool | isBorder (void) const |
SbBool | isDoubleBuffer (void) const |
SbBool | isDrawToFrontBufferEnable (void) const |
SbBool | isOverlayRender (void) const |
SbBool | isQuadBufferStereo (void) const |
SbBool | isStealFocus (void) const |
void | setAccumulationBuffer (const SbBool enable) |
void | setAlphaChannel (const SbBool enable) |
void | setBorder (const SbBool enable) |
virtual void | setDoubleBuffer (const SbBool enable) |
void | setDrawToFrontBufferEnable (const SbBool enable) |
void | setOverlayRender (const SbBool onoff) |
void | setQuadBufferStereo (const SbBool enable) |
void | setSampleBuffers (const int numsamples) |
void | setStealFocus (SbBool enable) |
void | setStencilBuffer (const SbBool enable) |
Public Member Functions inherited from SoWxComponent | |
virtual | ~SoWxComponent () |
wxWindow * | getBaseWidget (void) const |
const char * | getClassName (void) const |
const char * | getIconTitle (void) const |
wxWindow * | getParentWidget (void) const |
wxWindow * | getShellWidget (void) const |
SbVec2s | getSize (void) const |
const char * | getTitle (void) const |
wxWindow * | getWidget (void) const |
const char * | getWidgetName (void) const |
virtual void | hide (void) |
SbBool | isFullScreen (void) const |
SbBool | isTopLevelShell (void) const |
SbBool | isVisible (void) |
virtual void | setComponentCursor (const SoWxCursor &cursor) |
SbBool | setFullScreen (const SbBool onoff) |
void | setIconTitle (const char *const title) |
void | setSize (const SbVec2s size) |
void | setTitle (const char *const title) |
void | setWindowCloseCallback (SoWxComponentCB *const func, void *const user=NULL) |
virtual void | show (void) |
Public Member Functions inherited from SoWxObject | |
virtual SoType | getTypeId (void) const =0 |
SbBool | isOfType (SoType type) const |
Protected Member Functions | |
SoWxGLWidget (wxWindow *const parent=NULL, const char *const name=NULL, const SbBool embed=TRUE, const int glmodes=SO_GL_RGB, const SbBool build=TRUE) | |
~SoWxGLWidget () | |
wxWindow * | buildWidget (wxWindow *parent) |
float | getGLAspectRatio (void) const |
SbVec2s | getGLSize (void) const |
float | getGlxAspectRatio (void) const |
SbVec2s | getGlxSize (void) const |
void | glFlushBuffer (void) |
void | glLockNormal (void) |
void | glLockOverlay (void) |
virtual SbBool | glScheduleRedraw (void) |
void | glSwapBuffers (void) |
void | glUnlockNormal (void) |
void | glUnlockOverlay (void) |
virtual void | initGraphic (void) |
virtual void | initOverlayGraphic (void) |
SbBool | isRGBMode (void) |
SbBool | isStereoBuffer (void) const |
virtual void | processEvent (wxEvent &event) |
virtual void | redraw (void)=0 |
virtual void | redrawOverlay (void) |
void | setGLSize (const SbVec2s size) |
void | setGlxSize (const SbVec2s size) |
void | setStereoBuffer (SbBool flag) |
virtual void | sizeChanged (const SbVec2s &size) |
virtual void | widgetChanged (wxWindow *w) |
Protected Member Functions inherited from SoWxComponent | |
SoWxComponent (wxWindow *const parent=NULL, const char *const name=NULL, const SbBool embed=TRUE) | |
void | addVisibilityChangeCallback (SoWxComponentVisibilityCB *const func, void *const user=NULL) |
virtual void | afterRealizeHook (void) |
virtual const char * | getDefaultIconTitle (void) const |
virtual const char * | getDefaultTitle (void) const |
virtual const char * | getDefaultWidgetName (void) const |
void | registerWidget (wxWindow *widget) |
void | removeVisibilityChangeCallback (SoWxComponentVisibilityCB *const func, void *const user=NULL) |
void | setBaseWidget (wxWindow *widget) |
void | setClassName (const char *const name) |
void | unregisterWidget (wxWindow *widget) |
Protected Attributes | |
SbBool | drawToFrontBuffer |
SbBool | waitForExpose |
Protected Attributes inherited from SoWxComponent | |
SbBool | firstRealize |
Additional Inherited Members | |
Static Public Member Functions inherited from SoWxComponent | |
static SoWxComponent * | getComponent (wxWindow *widget) |
static void | initClasses (void) |
static void | setWidgetCursor (wxWindow *w, const SoWxCursor &cursor) |
Static Public Member Functions inherited from SoWxObject | |
static SoType | getClassTypeId (void) |
static void | init (void) |
static void | initClass (void) |
The SoWxGLWidget class manages OpenGL contexts.
This is the basic, abstract component class which sets up an OpenGL canvas for its subclasses.
Application programmers will normally not use this class directly, but rather through the interface of either its direct descendent, SoWxRenderArea, or through one of the "rapid application development"-style viewer subclasses.
|
protected |
The constructor is protected, as this is an abstract class to only be used by its subclasses.
|
protected |
Clean up all use of internal resources.
The destructor is protected, as this is an abstract class to only be used by its subclasses.
|
protected |
This method builds the component contents in the given parent widget. For subclasses adding new user interface items, this method is typically overridden in the following manner:
SbBool SoWxGLWidget::getAccumulationBuffer | ( | void | ) | const |
Returns whether the OpenGL accumulation buffer is enabled.
The returned flag will indicate whether or not accumulation buffers are actually present, and not just parrot the input value to SoWxGLWidget::setAccumulationBuffer(). See documentation of that function for more information.
SbBool SoWxGLWidget::getAlphaChannel | ( | void | ) | const |
Returns whether the alpha channel is enabled for the OpenGL context.
|
protected |
Return the aspect ratio of the OpenGL canvas.
|
protected |
Return the dimensions of the OpenGL canvas.
wxWindow * SoWxGLWidget::getGLWidget | ( | void | ) | const |
Returns a pointer to the toolkit-native GL widget.
|
inlineprotected |
This function has been renamed to the more appropriate getGLAspectRatio.
|
inlineprotected |
This function has been renamed to the more appropriate getGLSize.
void SoWxGLWidget::getLineWidthLimits | ( | SbVec2f & | range, |
float & | granularity ) |
This function is provided as a convenience for the application programmer to help with acquiring the OpenGL implementation limits for rendering lines.
For robust application code, one needs to consider the range limits when setting the SoDrawStyle::lineWidth field.
wxWindow * SoWxGLWidget::getNormalWidget | ( | void | ) | const |
unsigned long SoWxGLWidget::getOverlayTransparentPixel | ( | void | ) |
Returns the overlay transparent pixel.
wxWindow * SoWxGLWidget::getOverlayWidget | ( | void | ) | const |
Returns widget associated with overlay planes, or NULL
if no overlay planes are available.
void SoWxGLWidget::getPointSizeLimits | ( | SbVec2f & | range, |
float & | granularity ) |
This function is provided as a convenience for the application programmer to help with acquiring the OpenGL implementation limits for rendering points.
For robust application code, one needs to consider the range limits when setting the SoDrawStyle::pointSize field.
int SoWxGLWidget::getSampleBuffers | ( | void | ) | const |
Returns the number of samples used for multisampling. Returns 1 if multisampling is disabled.
SbBool SoWxGLWidget::getStencilBuffer | ( | void | ) | const |
Returns whether the OpenGL stencil buffer is enabled.
The returned flag will indicate whether or not stencil buffers are actually present, in the same manner as for SoWxGLWidget::getAccumulationBuffer(). See documentation of SoWxGLWidget::setStencilBuffer().
|
protected |
Flush the current GL buffer. Simply calls glFlush().
|
protected |
This method calls make-current on the correct context and increases the lock level.
|
protected |
This method calls make-current on the correct context and increases the lock level.
|
protectedvirtual |
Will be called whenever scene graph needs to be redrawn. If this method return FALSE
, redraw() will be called immediately.
Default method simply returns FALSE
. Override this method to schedule a redraw and return TRUE
if you're trying to do The Right Thing.
Reimplemented in SoWxRenderArea.
|
protected |
Swap back buffer to front and vice versa.
|
protected |
This method decreases the lock level.
|
protected |
This method decreases the lock level.
SbBool SoWxGLWidget::hasNormalGLArea | ( | void | ) | const |
Will return TRUE
if a normal GL drawing area exists.
SbBool SoWxGLWidget::hasOverlayGLArea | ( | void | ) | const |
Will return TRUE
if an overlay GL drawing area exists.
|
protectedvirtual |
Will be called when GL widget should initialize graphic, after the widget has been created. Default method enabled GL_DEPTH_TEST.
Reimplemented in SoWxRenderArea.
|
protectedvirtual |
Will be called after the overlay widget has been created, and subclasses should override this to initialize overlay stuff.
Default method does nothing.
Reimplemented in SoWxRenderArea.
SbBool SoWxGLWidget::isBorder | ( | void | ) | const |
Returns whether or not there's a border framing the OpenGL canvas.
SbBool SoWxGLWidget::isDoubleBuffer | ( | void | ) | const |
Returns the status of the buffer mode.
SbBool SoWxGLWidget::isDrawToFrontBufferEnable | ( | void | ) | const |
SbBool SoWxGLWidget::isOverlayRender | ( | void | ) | const |
Returns a flag indicating whether or not overplay planes are currently used.
SbBool SoWxGLWidget::isQuadBufferStereo | ( | void | ) | const |
Returns TRUE
if quad buffer stereo is enabled for this widget.
|
protected |
Returns TRUE
if the normal GL context is in RGBA mode. Return FALSE
if color index mode is used.
SbBool SoWxGLWidget::isStealFocus | ( | void | ) | const |
Returns whether focus stealing policy is on (TRUE
) or off (FALSE
).
Default is TRUE
.
|
protected |
Returns whether OpenGL stereo buffers are being used.
|
protectedvirtual |
Any events from the native window system that goes to the OpenGL canvas gets piped through this method.
It is overridden in the subclasses to catch user interaction with the render canvas in the viewers, as well as forwarding relevant events to the scene graph.
Reimplemented in SoWxRenderArea.
|
protectedpure virtual |
This method is invoked when the GL buffer needs to be redrawn.
Implemented in SoWxRenderArea.
|
protectedvirtual |
Renders the overlay scene graph. Default method is empty. Subclasses should override this method.
Reimplemented in SoWxRenderArea.
void SoWxGLWidget::setAccumulationBuffer | ( | const SbBool | enable | ) |
Enables/disables the OpenGL accumulation buffer.
For general information about accumulation buffers, confer with your OpenGL reference documentation.
By default, the accumulation buffer will be attempted disabled. Whether or not it will actually be disabled depends on what OpenGL contexts are available on the system. It is perfectly possible that the only usable contexts with regard to the other settings (like double buffering and RGBA mode versus color index mode) causes the context selection to choose an OpenGL format that contains an accumulation buffer, even though it was not requested.
Vice versa, one is not guaranteed to get accumulation buffers even when requested through this function, either because they are not available, or because they are only available in combination with other OpenGL context settings that are not wanted (like single buffers, non-accelerated rendering, etc).
If you try to enable accumulation buffers by using this function, you should therefore in succession use the SoWxGLWidget::getAccumulationBuffer() to query whether or not an accumulation buffer could actually be set up.
void SoWxGLWidget::setAlphaChannel | ( | const SbBool | enable | ) |
Enables/disables the alpha channel for the OpenGL context.
void SoWxGLWidget::setBorder | ( | const SbBool | enable | ) |
Specify whether or not there should be a border framing the OpenGL canvas. The border will be 2 pixels wide.
The default is to display the OpenGL canvas with no border.
|
virtual |
Switch between single and double buffer mode for the OpenGL canvas. The default is to use a single buffer canvas.
Reimplemented in SoWxViewer.
void SoWxGLWidget::setDrawToFrontBufferEnable | ( | const SbBool | enable | ) |
If this is set to TRUE
, rendering will happen in the front buffer even if the current rendering mode is double buffered.
|
protected |
Sets the size of the GL canvas.
|
inlineprotected |
This function has been renamed to the more appropriate setGLSize.
void SoWxGLWidget::setOverlayRender | ( | const SbBool | onoff | ) |
Turn on or off the use of overlay planes.
void SoWxGLWidget::setQuadBufferStereo | ( | const SbBool | enable | ) |
Enables or disables OpenGL quad buffer stereo.
void SoWxGLWidget::setSampleBuffers | ( | const int | numsamples | ) |
Set the number of samples use when enabling multisample buffer contexts. Multisampling will be enabled when numsamples > 1.
void SoWxGLWidget::setStealFocus | ( | SbBool | enable | ) |
Sets whether the GL widget should steal keyboard focus when the mouse is over the GL view.
Default is TRUE
.
void SoWxGLWidget::setStencilBuffer | ( | const SbBool | enable | ) |
Enables/disables the OpenGL stencil buffer.
For general information about stencil buffers, confer with your OpenGL reference documentation.
By default, the stencil buffer will be attempted disabled, but the same notes apply for stencil buffers as for accumulation buffers. For an explanation on the issue of stencil and accumulation buffer availability, see the function documentation of SoWxGLWidget::setAccumulationBuffer().
|
protected |
Sets whether OpenGL stereo buffers (quad buffer stereo) should be used.
|
protectedvirtual |
Called internally from within the SoWx library when the widget embedded in a component changes its size, which is usually triggered by end-user interaction.
This method is then invoked to notify the component that the size has changed. It is called from the top and all the way down to the bottom, the size being adjusted to take into account extra decorations having been added at each level in the component class hierarchy.
Reimplemented from SoWxComponent.
Reimplemented in SoWxRenderArea, SoWxFullViewer, and SoWxViewer.
|
protectedvirtual |
This is the method which gets called whenever we change which OpenGL widget is used.
Should be overridden in subclasses which directly or indirectly store the return value from the SoWxGLWidget::getGLWidget() method.
Reimplemented in SoWxRenderArea.
|
protected |
If this is TRUE
, rendering will happen in the front buffer even if the current rendering mode is double buffered.
|
protected |
If this is TRUE
, rendering should not be done yet. Upon the first expose event of a newly created OpenGL widget, this variable will be set to FALSE
.