SoWinMPGLWidget Class Reference

ScaleViz MultiPipe component for OpenGL rendering. More...

#include <Inventor/MP/Win/SoWinMPGLWidget.h>

Inheritance diagram for SoWinMPGLWidget:
SoWinComponent SoWinMPRenderArea SoWinMPViewer SoWinMPFullViewer SoWinMPExaminerViewer

List of all members.

Public Member Functions

virtual Window getNormalWindow ()
SoGLContextgetNormalContext ()
Hdc getNormalDC ()
void setStealFocus (SbBool onOrOff)
SoWidget getNormalWidget ()
virtual void setNormalVisual (XVisualInfo *vis)
XVisualInfo * getNormalVisual ()
virtual void setPixelFormat (int format)
int getPixelFormat ()
void setDoubleBuffer (SbBool onOrOff)
SbBool isDoubleBuffer ()
void setBorder (SbBool onOrOff)
int getBorderSize ()
SbBool isBorder () const
void setDrawToFrontBufferEnable (SbBool enableFlag)
SbBool isDrawToFrontBufferEnable () const
void setCursor (Cursor newCursor)
Cursor getCursor ()
SbBool bindNormalContext ()
SbBool unbindNormalContext ()
SbBool swapNormalBuffers ()

Deprecated



SoDEPRECATED Window getOverlayWindow ()
SoDEPRECATED SoGLContextgetOverlayContext ()
SoDEPRECATED Hdc getOverlayDC ()
SoDEPRECATED SoWidget getOverlayWidget ()
virtual SoDEPRECATED void setOverlayVisual (XVisualInfo *vis)
SoDEPRECATED XVisualInfo * getOverlayVisual ()
SoDEPRECATED SbBool swapOverlayBuffers ()
SoDEPRECATED SbBool makeNormalCurrent ()

Detailed Description

ScaleViz MultiPipe component for OpenGL rendering.

This is the MultiPipe version of SoWinGLWidget.

NOTE: This class does not exist in Open Inventor 10.0 and later.


Member Function Documentation

SbBool SoWinMPGLWidget::bindNormalContext (  ) 

Makes the normal rendering context the current context.

Equivalent to makeNormalCurrent() call.

int SoWinMPGLWidget::getBorderSize (  )  [inline]

Included for portability only.

Cursor SoWinMPGLWidget::getCursor (  ) 

Returns the current cursor.

SoGLContext* SoWinMPGLWidget::getNormalContext (  )  [inline]

Gets the normal context, which is needed as an argument to SbGlContextHelper::makeCurrent() when drawing in the normal planes.

Note: This should not be cached by users because it will change as single/double buffering changes.

Hdc SoWinMPGLWidget::getNormalDC (  )  [inline]

Returns the normal device context (which is needed for SbGlContextHelper::makeCurrent).

Same as getNormalDC(0).

XVisualInfo* SoWinMPGLWidget::getNormalVisual (  ) 

Returns the pixel format descriptor for the normal window.

SoWidget SoWinMPGLWidget::getNormalWidget (  )  [inline]

Gets the normal window handle, which is needed as an argument to SbGlContextHelper::makeCurrent() when drawing in the normal planes.

Note: This should not be cached by users because it will change as single/double buffering changes.

virtual Window SoWinMPGLWidget::getNormalWindow (  )  [virtual]

Gets the normal GL window, which is needed as an argument to SbGlContextHelper::makeCurrent() when drawing in the normal planes.

Note: This should not be cached by users because it will change as single/double buffering changes.

SoDEPRECATED SoGLContext* SoWinMPGLWidget::getOverlayContext (  )  [inline]

Gets the overlay context, which is needed as an argument to SbGlContextHelper::makeCurrent() when drawing in the overlay planes.

Note1: This should not be cached by users because it will change as single/double buffering changes.

Note2: Overlay planes are supported only if the graphics board supports overlay planes.

Deprecated:

Deprecated since Open Inventor 9610
Overlay feature is legacy, and no longer makes sense with current hardware.
SoDEPRECATED Hdc SoWinMPGLWidget::getOverlayDC (  )  [inline]

Returns the overlay device context (which is needed for SbGlContextHelper::makeCurrent).

Same as getOverlayDC(0).

Deprecated:

Deprecated since Open Inventor 9610
Overlay feature is legacy, and no longer makes sense with current hardware.
SoDEPRECATED XVisualInfo* SoWinMPGLWidget::getOverlayVisual (  ) 

Returns the pixel format descriptor for the overlay window.

Deprecated:

Deprecated since Open Inventor 9610
Overlay feature is legacy, and no longer makes sense with current hardware.
SoDEPRECATED SoWidget SoWinMPGLWidget::getOverlayWidget (  )  [inline]

Gets the overlay window handle, which is needed as an argument to SbGlContextHelper::makeCurrent() when drawing in the overlay planes.

Note1: This should not be cached by users because it will change as single/double buffering changes.

Note2: Overlay planes are supported only if the graphics board supports overlay planes.

Deprecated:

Deprecated since Open Inventor 9610
Overlay feature is legacy, and no longer makes sense with current hardware.
SoDEPRECATED Window SoWinMPGLWidget::getOverlayWindow (  ) 

Gets the overlay GL window, which is needed as an argument to SbGlContextHelper::makeCurrent() when drawing in overlay planes.

Note1: This should not be cached by users because it will change as single/double buffering changes.

Note2: Overlay planes are supported only if the graphics board supports overlay planes.

Deprecated:

Deprecated since Open Inventor 9610
Overlay feature is legacy, and no longer makes sense with current hardware.
int SoWinMPGLWidget::getPixelFormat (  ) 

Returns the current pixel format.

This method allow an application to query a pixel format that has extended attributes that can't be specified in a PFD struct.

SbBool SoWinMPGLWidget::isBorder (  )  const [inline]

Included for portability only.

SbBool SoWinMPGLWidget::isDoubleBuffer (  )  [inline]

Returns whether double buffering is on or off.

SbBool SoWinMPGLWidget::isDrawToFrontBufferEnable (  )  const [inline]

Returns whether drawing to the front buffer is enabled.

SoDEPRECATED SbBool SoWinMPGLWidget::makeNormalCurrent (  ) 

Makes the normal rendering context the current context.

Deprecated:

Deprecated since Open Inventor 8100
Use bindNormalContext and unbindNormalContext instead.
void SoWinMPGLWidget::setBorder ( SbBool  onOrOff  ) 

Included for portability only.

void SoWinMPGLWidget::setCursor ( Cursor  newCursor  ) 

Sets the current cursor.

If you are using a viewer class, the viewer will automatically change the cursor depending on the viewer mode. These changes will override the cursor set with this method unless you also call SoWinViewer::setCursorEnabled(FALSE).

void SoWinMPGLWidget::setDoubleBuffer ( SbBool  onOrOff  ) 

Routine that dynamically changes between single and double buffering.

Default is double buffer off. (The SoWinRenderArea subclass makes it double buffer by default.)

Reimplemented in SoWinMPViewer.

void SoWinMPGLWidget::setDrawToFrontBufferEnable ( SbBool  enableFlag  ) 

Sets drawing to the front buffer.

Controls drawing to the front buffer when an obscured portion of the window is exposed. Default: FALSE.

virtual void SoWinMPGLWidget::setNormalVisual ( XVisualInfo *  vis  )  [virtual]

Specifies the exact pixel format descriptor for the normal window.

This allows the user to create all possible pixel format descriptors supported by OpenGL. The PIXELFORMATDESCRIPTOR structure should be a valid OpenGL pixel format descriptor returned by ChoosePixelFormat(). (The methods for setting the pixel format descriptor are virtual so that derived classes can know when the pixel format descriptor is changing.)

Reimplemented in SoWinMPViewer.

virtual SoDEPRECATED void SoWinMPGLWidget::setOverlayVisual ( XVisualInfo *  vis  )  [virtual]

Specifies the exact pixel format descriptor for the overlay window.

This allows the user to create all possible pixel format descriptors supported by OpenGL. The PIXELFORMATDESCRIPTOR structure should be a valid OpenGL pixel format descriptor returned by ChoosePixelFormat(). (The methods for setting the pixel format descriptor are virtual so that derived classes can know when the pixel format descriptor is changing.)

Note: Overlay planes are supported only if the graphics board supports overlay planes.

Deprecated:

Deprecated since Open Inventor 9610
Overlay feature is legacy, and no longer makes sense with current hardware.
virtual void SoWinMPGLWidget::setPixelFormat ( int  format  )  [virtual]

Sets the current pixel format.

This method allows an application to set a pixel format that has extended attributes that can't be specified in a PFD struct. The specified format must support OpenGL and drawing to a window. There are not separate methods for normal and overlay windows because the overlay is not a separate window on Win32 computers.

You can also use environment variable OIV_FORCE_PIXEL_FORMAT to request a pixel format.

void SoWinMPGLWidget::setStealFocus ( SbBool  onOrOff  )  [inline]

By default the GLWidget "steals" focus whenever the cursor moves over it.

This roughly simulates the UNIX/X "focusFollowsCursor" behavior (which has no equivalent in Win32) and allows the Ctrl and Shift keys to be detected for 1-button mouse behaviors. Sometimes you want to this off however, like when you're typing in the zoom field.

SbBool SoWinMPGLWidget::swapNormalBuffers (  ) 

Swaps the normal front and back buffers.

SoDEPRECATED SbBool SoWinMPGLWidget::swapOverlayBuffers (  ) 

Swaps the overlay front and back buffers.

Deprecated:

Deprecated since Open Inventor 9610
Overlay feature is legacy, and no longer makes sense with current hardware.
SbBool SoWinMPGLWidget::unbindNormalContext (  ) 

unbind the current context (previously bind with bindNormalContext );


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

Open Inventor by FEI reference manual, generated on 19 Aug 2019
Copyright © FEI S.A.S. All rights reserved.
http://www.openinventor.com/