Coin Logo Coin3D is Free Software,
published under the BSD 3-clause license.
https://bitbucket.org/Coin3D/
http://www.kongsberg.com/kogt/
SoWinFullViewer Class Reference

The SoWinFullViewer class adds some user interface components to the viewer canvas. More...

#include <Inventor/Win/viewers/SoWinFullViewer.h>

Inheritance diagram for SoWinFullViewer:
SoWinViewer SoWinRenderArea SoWinGLWidget SoWinComponent SoWinObject SoWinConstrainedViewer SoWinExaminerViewer SoWinPlaneViewer SoWinFlyViewer

Public Types

enum  BuildFlag { BUILD_NONE = 0x00, BUILD_DECORATION = 0x01, BUILD_POPUP = 0x02, BUILD_ALL = (BUILD_DECORATION | BUILD_POPUP) }
 
- Public Types inherited from SoWinViewer
enum  Type { BROWSER, EDITOR }
 
enum  DrawStyle {
  VIEW_AS_IS, VIEW_HIDDEN_LINE, VIEW_NO_TEXTURE, VIEW_LOW_COMPLEXITY,
  VIEW_LINE, VIEW_POINT, VIEW_BBOX, VIEW_LOW_RES_LINE,
  VIEW_LOW_RES_POINT, VIEW_SAME_AS_STILL, VIEW_WIREFRAME_OVERLAY
}
 
enum  DrawType { STILL = 0, INTERACTIVE }
 
enum  BufferType { BUFFER_SINGLE, BUFFER_DOUBLE, BUFFER_INTERACTIVE }
 
enum  AutoClippingStrategy { VARIABLE_NEAR_PLANE, CONSTANT_NEAR_PLANE }
 
enum  StereoType {
  STEREO_NONE, STEREO_ANAGLYPH, STEREO_QUADBUFFER, STEREO_INTERLEAVED_ROWS,
  STEREO_INTERLEAVED_COLUMNS
}
 

Public Member Functions

void setDecoration (const SbBool on)
 
SbBool isDecoration (void) const
 
void setPopupMenuEnabled (const SbBool on)
 
SbBool isPopupMenuEnabled (void) const
 
HWND getAppPushButtonParent (void) const
 
void addAppPushButton (HWND newButton)
 
void insertAppPushButton (HWND newButton, int index)
 
void removeAppPushButton (HWND oldButton)
 
int findAppPushButton (HWND oldButton) const
 
int lengthAppPushButton (void) const
 
HWND getRenderAreaWidget (void) const
 
virtual void setViewing (SbBool on)
 
virtual void setComponentCursor (const SoWinCursor &cursor)
 
- Public Member Functions inherited from SoWinViewer
virtual void setCamera (SoCamera *camera)
 
SoCameragetCamera (void) const
 
virtual void setCameraType (SoType type)
 
SoType getCameraType (void) const
 
virtual void toggleCameraType (void)
 
virtual void viewAll (void)
 
virtual void saveHomePosition (void)
 
virtual void resetToHomePosition (void)
 
virtual void setHeadlight (SbBool enable)
 
SbBool isHeadlight (void) const
 
SoDirectionalLightgetHeadlight (void) const
 
virtual void setDrawStyle (SoWinViewer::DrawType type, SoWinViewer::DrawStyle style)
 
SoWinViewer::DrawStyle getDrawStyle (const SoWinViewer::DrawType type) const
 
virtual void setBufferingType (SoWinViewer::BufferType type)
 
SoWinViewer::BufferType getBufferingType (void) const
 
SbBool isViewing (void) const
 
virtual void setCursorEnabled (SbBool enable)
 
SbBool isCursorEnabled (void) const
 
void setAutoClipping (SbBool enable)
 
SbBool isAutoClipping (void) const
 
void setAutoClippingStrategy (const AutoClippingStrategy strategy, const float value=0.6f, SoWinAutoClippingCB *cb=NULL, void *cbuserdata=NULL)
 
virtual void setStereoViewing (SbBool enable)
 
SbBool isStereoViewing (void) const
 
virtual void setStereoOffset (const float dist)
 
float getStereoOffset (void) const
 
SbBool setStereoType (SoWinViewer::StereoType s)
 
SoWinViewer::StereoType getStereoType (void) const
 
void setAnaglyphStereoColorMasks (const SbBool left[3], const SbBool right[3])
 
void getAnaglyphStereoColorMasks (SbBool left[3], SbBool right[3])
 
void setDetailSeek (const SbBool enable)
 
SbBool isDetailSeek (void) const
 
void setSeekTime (const float seconds)
 
float getSeekTime (void) const
 
void addStartCallback (SoWinViewerCB *func, void *data=NULL)
 
void addFinishCallback (SoWinViewerCB *func, void *data=NULL)
 
void removeStartCallback (SoWinViewerCB *func, void *data=NULL)
 
void removeFinishCallback (SoWinViewerCB *func, void *data=NULL)
 
void setWireframeOverlayColor (const SbColor &color)
 
const SbColorgetWireframeOverlayColor (void) const
 
virtual void setDoubleBuffer (const SbBool enable)
 
virtual void setSceneGraph (SoNode *root)
 
virtual SoNodegetSceneGraph (void)
 
- Public Member Functions inherited from SoWinRenderArea
 SoWinRenderArea (HWND parent=NULL, const char *name=NULL, SbBool embed=TRUE, SbBool mouseInput=TRUE, SbBool keyboardInput=TRUE)
 
 ~SoWinRenderArea ()
 
void setOverlaySceneGraph (SoNode *scene)
 
SoNodegetOverlaySceneGraph (void)
 
void setBackgroundColor (const SbColor &color)
 
const SbColorgetBackgroundColor (void) const
 
void setBackgroundIndex (int idx)
 
int getBackgroundIndex (void) const
 
void setOverlayBackgroundIndex (int idx)
 
int getOverlayBackgroundIndex (void) const
 
void setColorMap (int start, int num, const SbColor *colors)
 
void setOverlayColorMap (int start, int num, const SbColor *colors)
 
void setViewportRegion (const SbViewportRegion &newRegion)
 
const SbViewportRegiongetViewportRegion (void) const
 
void setTransparencyType (SoGLRenderAction::TransparencyType type)
 
SoGLRenderAction::TransparencyType getTransparencyType (void) const
 
void setAntialiasing (SbBool smoothing, int numPasses)
 
void getAntialiasing (SbBool &smoothing, int &numPasses) const
 
void setClearBeforeRender (SbBool enable, SbBool zbEnable=TRUE)
 
SbBool isClearBeforeRender (void) const
 
SbBool isClearZBufferBeforeRender (void) const
 
void setClearBeforeOverlayRender (SbBool enable)
 
SbBool isClearBeforeOverlayRender (void) const
 
void setAutoRedraw (SbBool enable)
 
SbBool isAutoRedraw (void) const
 
void setRedrawPriority (uint32_t priority)
 
uint32_t getRedrawPriority (void) const
 
void render (void)
 
void renderOverlay (void)
 
void scheduleRedraw (void)
 
void scheduleOverlayRedraw (void)
 
void redrawOnSelectionChange (SoSelection *selection)
 
void redrawOverlayOnSelectionChange (SoSelection *selection)
 
void setEventCallback (SoWinRenderAreaEventCB *func, void *user=NULL)
 
void setSceneManager (SoSceneManager *manager)
 
SoSceneManagergetSceneManager (void) const
 
void setOverlaySceneManager (SoSceneManager *manager)
 
SoSceneManagergetOverlaySceneManager (void) const
 
void setGLRenderAction (SoGLRenderAction *action)
 
SoGLRenderActiongetGLRenderAction (void) const
 
void setOverlayGLRenderAction (SoGLRenderAction *action)
 
SoGLRenderActiongetOverlayGLRenderAction (void) const
 
SbBool sendSoEvent (const SoEvent *event)
 
void registerDevice (SoWinDevice *device)
 
void unregisterDevice (SoWinDevice *device)
 
- Public Member Functions inherited from SoWinGLWidget
void setBorder (const SbBool enable)
 
SbBool isBorder (void) const
 
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
 
HWND getGLWidget (void) const
 
HWND getNormalWidget (void) const
 
HWND 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 SoWinComponent
virtual ~SoWinComponent ()
 
virtual void show (void)
 
virtual void hide (void)
 
SbBool isFullScreen (void) const
 
SbBool setFullScreen (const SbBool onoff)
 
SbBool isVisible (void)
 
SbBool isTopLevelShell (void) const
 
HWND getWidget (void) const
 
HWND getBaseWidget (void) const
 
HWND getShellWidget (void) const
 
HWND 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 (SoWinComponentCB *const func, void *const user=NULL)
 
- Public Member Functions inherited from SoWinObject
virtual SoType getTypeId (void) const =0
 
SbBool isOfType (SoType type) const
 

Protected Member Functions

 SoWinFullViewer (HWND parent, const char *name, SbBool embed, BuildFlag flag, Type type, SbBool build)
 
 ~SoWinFullViewer ()
 
virtual void sizeChanged (const SbVec2s &size)
 
HWND buildWidget (HWND parent)
 
virtual void buildDecoration (HWND parent)
 
virtual HWND buildLeftTrim (HWND parent)
 
virtual HWND buildBottomTrim (HWND parent)
 
virtual HWND buildRightTrim (HWND parent)
 
HWND buildAppButtons (HWND parent)
 
HWND buildViewerButtons (HWND parent)
 
virtual void createViewerButtons (HWND parent, SbPList *buttonlist)
 
virtual void buildPopupMenu (void)
 
virtual void setPopupMenuString (const char *title)
 
virtual void openPopupMenu (const SbVec2s position)
 
virtual void leftWheelStart (void)
 
virtual void leftWheelMotion (float)
 
virtual void leftWheelFinish (void)
 
float getLeftWheelValue (void) const
 
void setLeftWheelValue (const float value)
 
virtual void bottomWheelStart (void)
 
virtual void bottomWheelMotion (float)
 
virtual void bottomWheelFinish (void)
 
float getBottomWheelValue (void) const
 
void setBottomWheelValue (const float value)
 
virtual void rightWheelStart (void)
 
virtual void rightWheelMotion (float)
 
virtual void rightWheelFinish (void)
 
float getRightWheelValue (void) const
 
void setRightWheelValue (const float value)
 
void setLeftWheelString (const char *const name)
 
HWND getLeftWheelLabelWidget (void) const
 
void setBottomWheelString (const char *const name)
 
HWND getBottomWheelLabelWidget (void) const
 
void setRightWheelString (const char *const name)
 
const char * getRightWheelString () const
 
HWND getRightWheelLabelWidget (void) const
 
virtual SbBool processSoEvent (const SoEvent *const event)
 
- Protected Member Functions inherited from SoWinViewer
 SoWinViewer (HWND parent, const char *name, SbBool embed, Type type, SbBool build)
 
 ~SoWinViewer ()
 
virtual void setSeekMode (SbBool enable)
 
SbBool isSeekMode (void) const
 
SbBool seekToPoint (const SbVec2s screenpos)
 
void seekToPoint (const SbVec3f &scenepos)
 
virtual void computeSeekFinalOrientation (void)
 
virtual void actualRedraw (void)
 
void interactiveCountInc (void)
 
void interactiveCountDec (void)
 
int getInteractiveCount (void) const
 
void setSeekDistance (const float distance)
 
float getSeekDistance (void) const
 
void setSeekValueAsPercentage (const SbBool on)
 
SbBool isSeekValuePercentage (void) const
 
virtual void changeCameraValues (SoCamera *camera)
 
void addSuperimposition (SoNode *scene)
 
void removeSuperimposition (SoNode *scene)
 
void setSuperimpositionEnabled (SoNode *scene, const SbBool enable)
 
SbBool getSuperimpositionEnabled (SoNode *scene) const
 
- Protected Member Functions inherited from SoWinRenderArea
 SoWinRenderArea (HWND parent, const char *name, SbBool embed, SbBool mouseInput, SbBool keyboardInput, SbBool build)
 
virtual void redraw (void)
 
virtual void redrawOverlay (void)
 
virtual void actualOverlayRedraw (void)
 
virtual void processEvent (MSG *event)
 
virtual void initGraphic (void)
 
virtual void initOverlayGraphic (void)
 
virtual void widgetChanged (HWND widget)
 
virtual void afterRealizeHook (void)
 
HWND buildWidget (HWND parent)
 
virtual const char * getDefaultWidgetName (void) const
 
virtual const char * getDefaultTitle (void) const
 
virtual const char * getDefaultIconTitle (void) const
 
virtual SbBool glScheduleRedraw (void)
 
- Protected Member Functions inherited from SoWinGLWidget
 SoWinGLWidget (HWND const parent=NULL, const char *const name=NULL, const SbBool embed=TRUE, const int glmodes=SO_GL_RGB, const SbBool build=TRUE)
 
 ~SoWinGLWidget ()
 
HWND buildWidget (HWND parent)
 
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)
 
- Protected Member Functions inherited from SoWinComponent
 SoWinComponent (HWND const parent=NULL, const char *const name=NULL, const SbBool embed=TRUE)
 
void setClassName (const char *const name)
 
void setBaseWidget (HWND widget)
 
void registerWidget (HWND widget)
 
void unregisterWidget (HWND widget)
 
void addVisibilityChangeCallback (SoWinComponentVisibilityCB *const func, void *const user=NULL)
 
void removeVisibilityChangeCallback (SoWinComponentVisibilityCB *const func, void *const user=NULL)
 

Protected Attributes

HWND leftWheel
 
HWND rightWheel
 
HWND bottomWheel
 
HWND leftDecoration
 
HWND rightDecoration
 
HWND bottomDecoration
 
HWND leftWheelLabel
 
char * leftWheelStr
 
float leftWheelVal
 
HWND rightWheelLabel
 
char * rightWheelStr
 
float rightWheelVal
 
HWND bottomWheelLabel
 
char * bottomWheelStr
 
float bottomWheelVal
 
SoWinPopupMenu * prefmenu
 
- Protected Attributes inherited from SoWinGLWidget
SbBool waitForExpose
 
SbBool drawToFrontBuffer
 
- Protected Attributes inherited from SoWinComponent
SbBool firstRealize
 

Additional Inherited Members

- Static Public Member Functions inherited from SoWinRenderArea
static uint32_t getDefaultRedrawPriority (void)
 
- Static Public Member Functions inherited from SoWinComponent
static void setWidgetCursor (HWND w, const SoWinCursor &cursor)
 
static SoWinComponentgetComponent (HWND widget)
 
static void initClasses (void)
 
- Static Public Member Functions inherited from SoWinObject
static void initClass (void)
 
static SoType getClassTypeId (void)
 
static void init (void)
 

Detailed Description

The SoWinFullViewer class adds some user interface components to the viewer canvas.

The SoWinFullViewer is an abstract viewer class which extends it's superclass (the basic SoWinViewer class) with two major user interface additions:

  • decorations around the render canvas, with buttons and thumbwheels to control camera interaction and various other aspects of model / scene viewing

  • a popup menu, invoked with the right mouse button, which controls yet more aspects of the rendering and the viewer

The user interface features listed above are the common parts of the user interfaces of the SoWinFullViewer's non-abstract subclasses.

For "real" application programs, the viewers / components from this class onwards and further down in the inheritance hierarchy is usually not all that interesting, as they enforces too much extra user interface cruft not compatible with the look and feel of the other parts of the application user interface. So most "real" applications will use either the SoWinViewer or the SoWinRenderArea as their base-level component, and then inherit one of these down into one's own "proper" viewer classes.

The non-abstract subclasses of the SoWinFullViewer class are viewer components often used as a test-bed for prototyping / rapid application development when doing quick testing of scenes, stand-alone 3D-models, animation techniques, etc etc.

See also
SoWinConstrainedViewer, SoWinExaminerViewer, SoWinPlaneViewer

Member Enumeration Documentation

◆ BuildFlag

Valid values for the constructor argument that decides how much of the user interface features to set up. The enum values are bitflags that can be OR'ed together.

Enumerator
BUILD_NONE 

Do not add any of the user interface components.

BUILD_DECORATION 

Only build and set up the decorations around the OpenGL canvas.

BUILD_POPUP 

Only build the popup menu. (Activated with the right mousebutton.)

BUILD_ALL 

Build all user interface components of the SoWinFullViewer.

Constructor & Destructor Documentation

◆ SoWinFullViewer()

SoWinFullViewer::SoWinFullViewer ( HWND  parent,
const char *  name,
SbBool  embed,
SoWinFullViewer::BuildFlag  buildFlag,
SoWinViewer::Type  type,
SbBool  build 
)
protected

Constructor. See parent class for explanation of arguments.

Subclasses will probably usually call with the buildNow flag set to FALSE to be able to do delayed building of the OpenGL canvas after other setup tasks has been performed.

◆ ~SoWinFullViewer()

SoWinFullViewer::~SoWinFullViewer ( )
protected

Destructor.

Member Function Documentation

◆ setDecoration()

void SoWinFullViewer::setDecoration ( const SbBool  enable)

Turn the viewer decorations on or off.

See also
isDecoration()

◆ isDecoration()

SbBool SoWinFullViewer::isDecoration ( void  ) const

Return TRUE if the viewer decorations are on, otherwise FALSE.

See also
setDecoration()

◆ setPopupMenuEnabled()

void SoWinFullViewer::setPopupMenuEnabled ( const SbBool  enable)

Decide whether or not if clicking with the right mouse button on the OpenGL canvas should reveal a preferences popup menu when in viewing mode.

See also
isPopupMenuEnabled()

◆ isPopupMenuEnabled()

SbBool SoWinFullViewer::isPopupMenuEnabled ( void  ) const

Return TRUE if the popup preferences menu is enabled, otherwise FALSE.

See also
setPopupMenuEnabled()

◆ getAppPushButtonParent()

HWND SoWinFullViewer::getAppPushButtonParent ( void  ) const

Returns the widget which is used as the parent of application specified buttons. The row of application buttons (if any) will be placed in the upper left corner.

See also
addAppPushButton(), insertAppPushButton(), removeAppPushButton()

◆ addAppPushButton()

void SoWinFullViewer::addAppPushButton ( HWND  newButton)

Add an application specific push button to the viewer decorations. Application buttons will be laid out in a vertical row from the upper left corner.

The button will be added bottom-most.

See also
insertAppPushButton(), removeAppPushButton(), getAppPushButtonParent()

◆ insertAppPushButton()

void SoWinFullViewer::insertAppPushButton ( HWND  newButton,
int  index 
)

Insert an application specific push button to the viewer decorations at the given index.

See also
addAppPushButton(), removeAppPushButton(), getAppPushButtonParent()

◆ removeAppPushButton()

void SoWinFullViewer::removeAppPushButton ( HWND  oldButton)

Remove one of the application specific buttons.

See also
addAppPushButton(), insertAppPushButton()

◆ findAppPushButton()

int SoWinFullViewer::findAppPushButton ( HWND  oldButton) const

Return the index of a particular button that has been specified by the application, or -1 of the button has not been added.

See also
addAppPushButton()

◆ lengthAppPushButton()

int SoWinFullViewer::lengthAppPushButton ( void  ) const

Return number of application specific buttons added.

See also
addAppPushButton(), insertAddAppPushButton()

◆ getRenderAreaWidget()

HWND SoWinFullViewer::getRenderAreaWidget ( void  ) const

Returns the render area OpenGL canvas widget.

◆ setViewing()

void SoWinFullViewer::setViewing ( SbBool  enable)
virtual

Set view mode.

If the view mode is on, user events will be caught and used to influence the camera position / orientation. If view mode is off, all events in the viewer canvas (like for instance keypresses or mouseclicks and -movements) will be passed along to the scene graph.

Default is to have the view mode active.

See also
isViewing()

Reimplemented from SoWinViewer.

Reimplemented in SoWinExaminerViewer, SoWinFlyViewer, and SoWinPlaneViewer.

◆ setComponentCursor()

void SoWinFullViewer::setComponentCursor ( const SoWinCursor cursor)
virtual

Sets the cursor for this component.

Note: not part of the original SGI InventorXt API.

Reimplemented from SoWinComponent.

◆ sizeChanged()

void SoWinFullViewer::sizeChanged ( const SbVec2s size)
protectedvirtual

Called internally from within the SoWin library when the widget embedded in a component changes it 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 SoWinViewer.

◆ buildDecoration()

void SoWinFullViewer::buildDecoration ( HWND  parent)
protectedvirtual

Build viewer decorations.

◆ buildLeftTrim()

HWND SoWinFullViewer::buildLeftTrim ( HWND  parent)
protectedvirtual

Build decorations on the left of the render canvas. Override this method in subclasses if you want your own decorations on the viewer window.

The decoration will be 30 pixels wide.

◆ buildBottomTrim()

HWND SoWinFullViewer::buildBottomTrim ( HWND  parent)
protectedvirtual

Build decorations on the bottom of the render canvas. Override this method in subclasses if you want your own decorations on the viewer window.

◆ buildRightTrim()

HWND SoWinFullViewer::buildRightTrim ( HWND  parent)
protectedvirtual

Build decorations on the right side of the render canvas. Override this method in subclasses if you want your own decorations on the viewer window.

◆ buildAppButtons()

HWND SoWinFullViewer::buildAppButtons ( HWND  parent)
protected

Build the application specified button row (if any buttons were set up).

◆ buildViewerButtons()

HWND SoWinFullViewer::buildViewerButtons ( HWND  parent)
protected

Build and layout viewer specified button row.

◆ createViewerButtons()

void SoWinFullViewer::createViewerButtons ( HWND  parent,
SbPList buttonlist 
)
protectedvirtual

Set up the viewer buttons with pixmaps and event connections.

One important note if you want to override this method to add your own buttons to the list (in the explanation below, it is assumed that you know how virtual function table pointers are handled by C++):

createViewerButtons() is called (indirectly) from the constructors of the viewer classes. This means that you need to delay it's invocation until your own subclass's constructor is run, because otherwise your re-implementation won't have been added to the internal virtual function table yet.

Delaying a superclass viewer from building it's decorations is done by passing build==FALSE as the last argument of the protected constructors. You will then have to explicitly trigger the building in your own constructor.

Here's a minimal example that shows the steps needed to be able to override createViewerButtons() from SoWinExaminerViewer:

class MyExaminerViewer : public SoWinExaminerViewer {
public:
MyExaminerViewer(HWND parent);
protected:
virtual void createViewerButtons(HWND parent, SbPList * buttonlist);
};
MyExaminerViewer::MyExaminerViewer(HWND parent)
: SoWinExaminerViewer(parent, NULL, TRUE,
// build == FALSE, to delay creation of decorations
FALSE)
{
// Explicitly trigger the construction of viewer decorations.
HWND widget = this->buildWidget(this->getParentWidget());
this->setBaseWidget(widget);
}
void
MyExaminerViewer::createViewerButtons(HWND parent, SbPList * buttonlist)
{
// [now add your own button(s) to the buttonlist]
}

Reimplemented in SoWinExaminerViewer, and SoWinPlaneViewer.

◆ buildPopupMenu()

void SoWinFullViewer::buildPopupMenu ( void  )
protectedvirtual

Make a popup menu with preferences settings.

One important note as for when you want to override this function in a subclass: be aware that it will usually be invoked (indirectly) from this class's constructor. That is before the table of virtual function pointers has been set up for the subclass, and because of this, the function will not be called in the subclass even though it is virtual.

To make the overriding actually be in effect, you need to delay building the widgets of this class. For information on how to do that, see the documentation of SoWinFullViewer::createViewerButtons().

◆ setPopupMenuString()

void SoWinFullViewer::setPopupMenuString ( const char *  name)
protectedvirtual

Set title of popup menu.

◆ openPopupMenu()

void SoWinFullViewer::openPopupMenu ( const SbVec2s  position)
protectedvirtual

NOTE: This method is not part of the original InventorXt API.

◆ leftWheelStart()

void SoWinFullViewer::leftWheelStart ( void  )
protectedvirtual

Called when the user start to drag the thumbwheel in the left frame. Override this method in subclassed viewers to provide your own functionality on the thumbwheel.

See also
leftWheelMotion(), leftWheelFinish()
bottomWheelStart(), rightWheelStart()

Reimplemented in SoWinPlaneViewer.

◆ leftWheelMotion()

void SoWinFullViewer::leftWheelMotion ( float  value)
protectedvirtual

Called repeatedly as the user drags the thumbwheel in the left frame. Override this method in subclassed viewers to provide your own functionality on the thumbwheel.

See also
leftWheelStart(), leftWheelFinish()
bottomWheelStart(), rightWheelStart()

Reimplemented in SoWinExaminerViewer, SoWinPlaneViewer, and SoWinConstrainedViewer.

◆ leftWheelFinish()

void SoWinFullViewer::leftWheelFinish ( void  )
protectedvirtual

Called as the user let go of the thumbwheel in the left frame after a drag operation. Override this method in subclassed viewers to provide your own functionality on the thumbwheel.

See also
leftWheelStart(), leftWheelMotion()
bottomWheelStart(), rightWheelStart()

Reimplemented in SoWinPlaneViewer.

◆ getLeftWheelValue()

float SoWinFullViewer::getLeftWheelValue ( void  ) const
protected

Get current value of the left thumbwheel.

See also
leftWheelMotion()

◆ setLeftWheelValue()

void SoWinFullViewer::setLeftWheelValue ( const float  value)
protected

Set a new value for the left thumbwheel.

◆ bottomWheelStart()

void SoWinFullViewer::bottomWheelStart ( void  )
protectedvirtual

Called when the user start to drag the thumbwheel in the bottom frame. Override this method in subclassed viewers to provide your own functionality on the thumbwheel.

See also
bottomWheelMotion(), bottomWheelFinish()
leftWheelStart(), rightWheelStart()

Reimplemented in SoWinPlaneViewer.

◆ bottomWheelMotion()

void SoWinFullViewer::bottomWheelMotion ( float  value)
protectedvirtual

Called repeatedly as the user drags the thumbwheel in the bottom frame. Override this method in subclassed viewers to provide your own functionality on the thumbwheel.

See also
bottomWheelStart(), bottomWheelFinish()
leftWheelStart(), rightWheelStart()

Reimplemented in SoWinExaminerViewer, SoWinPlaneViewer, and SoWinConstrainedViewer.

◆ bottomWheelFinish()

void SoWinFullViewer::bottomWheelFinish ( void  )
protectedvirtual

Called as the user let go of the thumbwheel in the bottom frame after a drag operation. Override this method in subclassed viewers to provide your own functionality on the thumbwheel.

See also
bottomWheelStart(), bottomWheelMotion()
leftWheelStart(), rightWheelStart()

Reimplemented in SoWinPlaneViewer.

◆ getBottomWheelValue()

float SoWinFullViewer::getBottomWheelValue ( void  ) const
protected

Get current value of the bottom thumbwheel.

See also
bottomWheelMotion()

◆ setBottomWheelValue()

void SoWinFullViewer::setBottomWheelValue ( const float  value)
protected

Set a new value for the bottom thumbwheel.

◆ rightWheelStart()

void SoWinFullViewer::rightWheelStart ( void  )
protectedvirtual

Called when the user start to drag the thumbwheel in the right frame. Override this method in subclassed viewers to provide your own functionality on the thumbwheel.

See also
rightWheelMotion(), rightWheelFinish()
leftWheelStart(), bottomWheelStart()

Reimplemented in SoWinPlaneViewer.

◆ rightWheelMotion()

void SoWinFullViewer::rightWheelMotion ( float  value)
protectedvirtual

Called repeatedly as the user drags the thumbwheel in the right frame. Override this method in subclassed viewers to provide your own functionality on the thumbwheel.

See also
rightWheelStart(), rightWheelFinish()
leftWheelStart(), bottomWheelStart()

Reimplemented in SoWinExaminerViewer, SoWinPlaneViewer, and SoWinFlyViewer.

◆ rightWheelFinish()

void SoWinFullViewer::rightWheelFinish ( void  )
protectedvirtual

Called as the user let go of the thumbwheel in the right frame after a drag operation. Override this method in subclassed viewers to provide your own functionality on the thumbwheel.

See also
rightWheelStart(), rightWheelMotion()
leftWheelStart(), bottomWheelStart()

Reimplemented in SoWinPlaneViewer.

◆ getRightWheelValue()

float SoWinFullViewer::getRightWheelValue ( void  ) const
protected

Get current value of the right thumbwheel.

See also
rightWheelMotion()

◆ setRightWheelValue()

void SoWinFullViewer::setRightWheelValue ( const float  value)
protected

Set a new value for the right thumbwheel.

◆ setLeftWheelString()

void SoWinFullViewer::setLeftWheelString ( const char *const  string)
protected

Set label of the left thumbwheel.

◆ getLeftWheelLabelWidget()

HWND SoWinFullViewer::getLeftWheelLabelWidget ( void  ) const
protected

This method returns the native widget for the label below the left thumb wheel.

◆ setBottomWheelString()

void SoWinFullViewer::setBottomWheelString ( const char *const  string)
protected

Set label of the bottom thumbwheel.

◆ getBottomWheelLabelWidget()

HWND SoWinFullViewer::getBottomWheelLabelWidget ( void  ) const
protected

This method returns the native widget for the label beside the bottom thumb wheel.

◆ setRightWheelString()

void SoWinFullViewer::setRightWheelString ( const char *const  string)
protected

Set label of the right thumbwheel.

◆ getRightWheelLabelWidget()

HWND SoWinFullViewer::getRightWheelLabelWidget ( void  ) const
protected

This method returns the native widget for the label below the right thumb wheel.

◆ processSoEvent()

SbBool SoWinFullViewer::processSoEvent ( const SoEvent *const  event)
protectedvirtual

Toolkit-native events are attempted converted to Coin-generic events in the SoWinRenderArea::processEvent() method. If this succeeds, they are forwarded to this method.

This is a virtual method, and is overridden in it's subclasses to catch events of particular interest to the viewer classes, for instance.

Return TRUE iff the event was processed. If not it should be passed on further up in the inheritance hierarchy by the caller. This last point is extremely important to take note of if you are expanding the toolkit with your own viewer class.

This method is not part of the original SGI InventorXt API. Note that you can still override the toolkit-native processEvent() method instead of this "generic" method.

Reimplemented from SoWinViewer.

Reimplemented in SoWinExaminerViewer, SoWinFlyViewer, and SoWinPlaneViewer.

Member Data Documentation

◆ leftWheel

HWND SoWinFullViewer::leftWheel
protected

The widget representing the thumbwheel left of the render canvas.

◆ rightWheel

HWND SoWinFullViewer::rightWheel
protected

The widget representing the thumbwheel on the right side of the render canvas.

◆ bottomWheel

HWND SoWinFullViewer::bottomWheel
protected

The widget representing the thumbwheel below the render canvas.

◆ leftDecoration

HWND SoWinFullViewer::leftDecoration
protected

The root widget for the left-side decorations.

◆ rightDecoration

HWND SoWinFullViewer::rightDecoration
protected

The root widget for the right-side decorations.

◆ bottomDecoration

HWND SoWinFullViewer::bottomDecoration
protected

The root widget for the bottom decorations.

◆ leftWheelLabel

HWND SoWinFullViewer::leftWheelLabel
protected

Label widget of left wheel.

◆ leftWheelStr

char * SoWinFullViewer::leftWheelStr
protected

Text of left thumbwheel's label.

◆ leftWheelVal

float SoWinFullViewer::leftWheelVal
protected

Current value of the left thumbwheel.

◆ rightWheelLabel

HWND SoWinFullViewer::rightWheelLabel
protected

Label widget of right wheel.

◆ rightWheelStr

char * SoWinFullViewer::rightWheelStr
protected

Text of right thumbwheel's label.

◆ rightWheelVal

float SoWinFullViewer::rightWheelVal
protected

Current value of the right-side thumbwheel.

◆ bottomWheelLabel

HWND SoWinFullViewer::bottomWheelLabel
protected

Label widget of bottom wheel.

◆ bottomWheelStr

char * SoWinFullViewer::bottomWheelStr
protected

Text of bottom thumbwheel's label.

◆ bottomWheelVal

float SoWinFullViewer::bottomWheelVal
protected

Current value of the bottom thumbwheel.

◆ prefmenu

SoWinPopupMenu * SoWinFullViewer::prefmenu
protected

Pointer to the popup menu instance.


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