SoQtGLWidget - Man Page

void setBorder (const SbBool enable)
SbBool isBorder (void) const
virtual void setDoubleBuffer (const SbBool enable)
SbBool isDoubleBuffer (void) const
void setDrawToFrontBufferEnable (const SbBool enable)
SbBool isDrawToFrontBufferEnable (void) const
void setQuadBufferStereo (const SbBool enable)
SbBool isQuadBufferStereo (void) const
void setAccumulationBuffer (const SbBool enable)
SbBool getAccumulationBuffer (void) const
void setStencilBuffer (const SbBool enable)
SbBool getStencilBuffer (void) const
void setAlphaChannel (const SbBool enable)
SbBool getAlphaChannel (void) const
void setOverlayRender (const SbBool onoff)
SbBool isOverlayRender (void) const
void setSampleBuffers (const int numsamples)
int getSampleBuffers (void) const
void setStealFocus (SbBool enable)
SbBool isStealFocus (void) const
QWidget * getGLWidget (void) const
QWidget * getNormalWidget (void) const
QWidget * getOverlayWidget (void) const
SbBool hasOverlayGLArea (void) const
SbBool hasNormalGLArea (void) const
unsigned long getOverlayTransparentPixel (void)
void getPointSizeLimits (SbVec2f &range, float &granularity)
void getLineWidthLimits (SbVec2f &range, float &granularity)

Public Member Functions inherited from SoQtComponent
virtual SoType getTypeId (void) const
virtual ~SoQtComponent ()
virtual void show (void)
virtual void hide (void)
virtual void setComponentCursor (const SoQtCursor &cursor)
SbBool isFullScreen (void) const
SbBool setFullScreen (const SbBool onoff)
SbBool isVisible (void)
SbBool isTopLevelShell (void) const
QWidget * getWidget (void) const
QWidget * getBaseWidget (void) const
QWidget * getShellWidget (void) const
QWidget * getParentWidget (void) const
void setSize (const SbVec2s size)
SbVec2s getSize (void) const
void setTitle (const char *const title)
const char * getTitle (void) const
void setIconTitle (const char *const title)
const char * getIconTitle (void) const
const char * getWidgetName (void) const
const char * getClassName (void) const
void setWindowCloseCallback (SoQtComponentCB *const func, void *const user=NULL)

Public Member Functions inherited from SoQtObject
SbBool isOfType (SoType type) const

SoQtGLWidget (QWidget *const parent=NULL, const char *const name=NULL, const SbBool embed=TRUE, const int glmodes=SO_GL_RGB, const SbBool build=TRUE)
~SoQtGLWidget ()
virtual void processEvent (QEvent *event)
QWidget * buildWidget (QWidget *parent)
virtual void redraw (void)=0
virtual void redrawOverlay (void)
virtual void initGraphic (void)
virtual void initOverlayGraphic (void)
virtual void sizeChanged (const SbVec2s &size)
virtual void widgetChanged (QWidget *w)
void setGLSize (const SbVec2s size)
SbVec2s getGLSize (void) const
float getGLAspectRatio (void) const
void setGlxSize (const SbVec2s size)
SbVec2s getGlxSize (void) const
float getGlxAspectRatio (void) const
void setStereoBuffer (SbBool flag)
SbBool isStereoBuffer (void) const
SbBool isRGBMode (void)
void glLockNormal (void)
void glUnlockNormal (void)
void glLockOverlay (void)
void glUnlockOverlay (void)
void glSwapBuffers (void)
void glFlushBuffer (void)
virtual SbBool glScheduleRedraw (void)

Protected Member Functions inherited from SoQtComponent
SoQtComponent (QWidget *const parent=NULL, const char *const name=NULL, const SbBool embed=TRUE)
virtual void afterRealizeHook (void)
void setClassName (const char *const name)
void setBaseWidget (QWidget *widget)
void registerWidget (QWidget *widget)
void unregisterWidget (QWidget *widget)
virtual const char * getDefaultWidgetName (void) const
virtual const char * getDefaultTitle (void) const
virtual const char * getDefaultIconTitle (void) const
void addVisibilityChangeCallback (SoQtComponentVisibilityCB *const func, void *const user=NULL)
void removeVisibilityChangeCallback (SoQtComponentVisibilityCB *const func, void *const user=NULL)

SbBool waitForExpose
SbBool drawToFrontBuffer

Static Public Member Functions inherited from SoQtComponent

static void initClass (void)
static SoType getClassTypeId (void)
static void setWidgetCursor (QWidget *w, const SoQtCursor &cursor)
static SoQtComponent * getComponent (QWidget *widget)
static void initClasses (void)

Static Public Member Functions inherited from SoQtObject
static void initClass (void)
static SoType getClassTypeId (void)
static void init (void)

The constructor is protected, as this is an abstract class to only be used by its subclasses.

Clean up all use of internal resources.

The destructor is protected, as this is an abstract class to only be used by its subclasses.

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.

See also

isBorder()

Returns whether or not there's a border framing the OpenGL canvas.

See also

setBorder()

Switch between single and double buffer mode for the OpenGL canvas. The default is to use a single buffer canvas.

See also

isDoubleBuffer()

Reimplemented in SoQtViewer.

Returns the status of the buffer mode.

See also

setDoubleBuffer()

If this is set to TRUE, rendering will happen in the front buffer even if the current rendering mode is double buffered.

See also

setDrawToFrontBufferEnable()

Enables or disables OpenGL quad buffer stereo.

Returns TRUE if quad buffer stereo is enabled for this widget.

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 SoQtGLWidget::getAccumulationBuffer() to query whether or not an accumulation buffer could actually be set up.

See also

SoQtRenderArea::setAntiAliasing()

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 SoQtGLWidget::setAccumulationBuffer(). See documentation of that function for more information.

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 SoQtGLWidget::setAccumulationBuffer().

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 SoQtGLWidget::getAccumulationBuffer(). See documentation of SoQtGLWidget::setStencilBuffer().

Enables/disables the alpha channel for the OpenGL context.

Returns whether the alpha channel is enabled for the OpenGL context.

Turn on or off the use of overlay planes.

See also

isOverlayRender()

Returns a flag indicating whether or not overplay planes are currently used.

See also

setOverlayRender()

Set the number of samples use when enabling multisample buffer contexts. Multisampling will be enabled when numsamples > 1.

Returns the number of samples used for multisampling. Returns 1 if multisampling is disabled.

Sets whether the GL widget should steal keyboard focus when the mouse is over the GL view.

Default is TRUE.

See also

isStealFocus

Since

SoQt 1.3.0

Returns whether focus stealing policy is on (TRUE) or off (FALSE).

Default is TRUE.

See also

setStealFocus

Since

SoQt 1.3.0

Returns a pointer to the toolkit-native GL widget.

For SoQt, this returns the same widget pointer as that of SoQtGLWidget::getGLWidget().  

Returns widget associated with overlay planes, or NULL if no overlay planes are available.

For the Qt toolkit, overlay planes is a feature of the QGLWidget, and not seen at a separate widget entity. So this call will just return the same widget reference as the SoQt::getGLWidget() call (if overlay planes are supported).

Returns widget associated with overlay planes, or NULL if no overlay planes are available.

For the Qt toolkit, overlay planes is a feature of the QGLWidget, and not seen at a separate widget entity. So this call will just return the same widget reference as the SoQt::getGLWidget() call (if overlay planes are supported).

Will return TRUE if an overlay GL drawing area exists.

Will return TRUE if a normal GL drawing area exists.

Returns the overlay transparent pixel.

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.

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.

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

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:

QWidget * MyOwnViewer::buildWidget(QWidget * parent)
{
   QWidget * superw = <superclass>::buildWidget(parent);
   // [then move superw within MyOwnViewer framework and add own
   // user interface components]
}

This method is invoked when the GL buffer needs to be redrawn.

Implemented in SoQtRenderArea.

Renders the overlay scene graph. Default method is empty. Subclasses should override this method.

Reimplemented in SoQtRenderArea.

Will be called when GL widget should initialize graphic, after the widget has been created. Default method enabled GL_DEPTH_TEST.

Reimplemented in SoQtRenderArea.

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

Called internally from within the SoQt 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 SoQtComponent.

Reimplemented in SoQtFullViewer, SoQtRenderArea, and SoQtViewer.

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 SoQtGLWidget::getGLWidget() method.

See also

sizeChanged()

Reimplemented in SoQtRenderArea.

Sets the size of the GL canvas.

Return the dimensions of the OpenGL canvas.

Return the aspect ratio of the OpenGL canvas.

This function has been renamed to the more appropriate setGLSize.

See also

setGLSize

This function has been renamed to the more appropriate getGLSize.

See also

getGLSize

This function has been renamed to the more appropriate getGLAspectRatio.

See also

getGLAspectRatio

Sets whether OpenGL stereo buffers (quad buffer stereo) should be used.

Returns whether OpenGL stereo buffers are being used.

Returns TRUE if the normal GL context is in RGBA mode. Return FALSE if color index mode is used.

This method calls make-current on the correct context and increases the lock level.

This method decreases the lock level.

This method calls make-current on the correct context and increases the lock level.

This method decreases the lock level.

Swap back buffer to front and vice versa.

Flush the current GL buffer. Simply calls glFlush().

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

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.

If this is TRUE, rendering will happen in the front buffer even if the current rendering mode is double buffered.