SoWinFullViewer Class Reference
[Win]

VSG extension Base viewer class which adds a decoration around the rendering area. More...

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

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

List of all members.

Public Types

enum  BuildFlag {
  BUILD_NONE = 0x00,
  BUILD_DECORATION = 0x01,
  BUILD_POPUP = 0x02,
  BUILD_ALL = 0xff
}

Public Member Functions

void setDecoration (SbBool onOrOff)
SbBool isDecoration ()
void setPopupMenuEnabled (SbBool trueOrFalse)
SbBool isPopupMenuEnabled ()
void setClientPopupMenu (Hmenu hmenu)
SbBool isClientPopupMenuInstalled ()
SoWidget getAppPushButtonParent () const
void addAppPushButton (SoWidget newButton)
void insertAppPushButton (SoWidget newButton, int index)
void removeAppPushButton (SoWidget oldButton)
int findAppPushButton (SoWidget oldButton)
int lengthAppPushButton ()
SoWidget getRenderAreaWidget ()
virtual void setViewing (SbBool onOrOff)
virtual void setCamera (SoCamera *cam)
virtual void hide ()
virtual void setHeadlight (SbBool onOrOff)
virtual void setDrawStyle (SoWinViewer::DrawType type, SoWinViewer::DrawStyle style)
virtual void setBufferingType (SoWinViewer::BufferType type)
SoStereoDialoggetStereoDialog ()
void setStereoDialog (SoStereoDialog *newDialog)
void addPushAppButtonCallback (PushAppButtonCB *cb, void *data=NULL)
void addRedrawAppButtonCallback (RedrawAppButtonCB *cb, void *data=NULL)

Static Public Member Functions

static void setDoButtonBar (SbBool onOrOff)
static SbBool isDoButtonBar ()

Public Attributes

SoCallbackList popupPostCallback
SoCallbackList popupPreCallback
Hmenu rootPopup
Hmenu mainPopup
Hmenu funcPopup
Hmenu drawPopup
Hmenu prefPopup
UINT curPopupDrawItem
UINT curPopupMoveItem
UINT curPopupBufferItem
Hmenu hClientPopup

Detailed Description

VSG extension Base viewer class which adds a decoration around the rendering area.

This is a base class used by all viewer components. The class adds a decoration around the rendering area which includes thumb wheels, a zoom slider and push buttons. This base class also includes a viewer popup menu and a preference sheet with generic viewing functions. The constructors for the various subclasses of SoWinFullViewer provide a flag for specifying whether the decoration and popup menus should be built.

SEE ALSO

SoWinViewer, SoWinComponent, SoWinRenderArea, SoWinExaminerViewer, SoWinWalkViewer, SoWinFlyViewer, SoWinPlaneViewer


Member Enumeration Documentation

This specifies what should be build by default in the constructor.

Enumerator:
BUILD_NONE 

Doesn't build anything extra.

BUILD_DECORATION 

Build the decoration only.

BUILD_POPUP 

Build the popup menu only.

BUILD_ALL 

Build everything by default.


Member Function Documentation

void SoWinFullViewer::addAppPushButton ( SoWidget  newButton  ) 

Adds application push button, which will be placed in the left hand side decoration trim.

Buttons are appended to the end of the list.

Note: The button bitmaps should be 24-by-24 pixels to fit nicely into the decoration trim like the other viewer buttons.

void SoWinFullViewer::addPushAppButtonCallback ( PushAppButtonCB cb,
void *  data = NULL 
) [inline]
void SoWinFullViewer::addRedrawAppButtonCallback ( RedrawAppButtonCB cb,
void *  data = NULL 
) [inline]
int SoWinFullViewer::findAppPushButton ( SoWidget  oldButton  )  [inline]

Returns index of specified push button.

SoWidget SoWinFullViewer::getAppPushButtonParent (  )  const [inline]

Returns application push button parent.

SoWidget SoWinFullViewer::getRenderAreaWidget (  )  [inline]

Returns the render area window handle.

SoStereoDialog* SoWinFullViewer::getStereoDialog (  )  [inline]
virtual void SoWinFullViewer::hide (  )  [virtual]

This hides the component.

It calls the appropriate unrealize or unmanage routines.

Reimplemented from SoWinComponent.

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

Adds application push button, which will be placed in the left hand side decoration trim.

Buttons are inserted at the desired index.

Note: The button bitmaps should be 24-by-24 pixels to fit nicely into the decoration trim like the other viewer buttons.

SbBool SoWinFullViewer::isClientPopupMenuInstalled (  )  [inline]

Returns TRUE if an application-specific popup menu is installed.

SbBool SoWinFullViewer::isDecoration (  )  [inline]

Returns whether the viewer component trim is on or off.

static SbBool SoWinFullViewer::isDoButtonBar (  )  [inline, static]

Returns whether the buttonbar is enabled or disabled.

SbBool SoWinFullViewer::isPopupMenuEnabled (  )  [inline]

Returns whether the viewer popup menu is enabled or disabled.

int SoWinFullViewer::lengthAppPushButton (  )  [inline]

Returns number of application push buttons.

void SoWinFullViewer::removeAppPushButton ( SoWidget  oldButton  ) 

Removes specified application push button.

virtual void SoWinFullViewer::setBufferingType ( SoWinViewer::BufferType  type  )  [virtual]

Sets the current buffering type in the main view (default SoWinViewer::BUFFER_DOUBLE).

Reimplemented from SoWinViewer.

virtual void SoWinFullViewer::setCamera ( SoCamera cam  )  [virtual]

Sets the edited camera.

Setting the camera is only needed if the first camera found in the scene when setting the scene graph isn't the one the user really wants to edit.

Reimplemented from SoWinViewer.

Reimplemented in SoWinConstrainedViewer, SoWinExaminerViewer, SoWinFlyViewer, SoWinPlaneViewer, and SoWinWalkViewer.

void SoWinFullViewer::setClientPopupMenu ( Hmenu  hmenu  ) 

Enables application-specific popup menu.

void SoWinFullViewer::setDecoration ( SbBool  onOrOff  ) 

Shows/hides the viewer component trim (default on).

See the viewer constructor to prevent the decoration from being built.

The default value can be set using the environment variable OIV_VIEWER_DECORATION (0 = OFF, 1 = ON).

static void SoWinFullViewer::setDoButtonBar ( SbBool  onOrOff  )  [static]

Create the next instance of fullviewer w/wo the buttonbar.

virtual void SoWinFullViewer::setDrawStyle ( SoWinViewer::DrawType  type,
SoWinViewer::DrawStyle  style 
) [virtual]

Sets the current drawing style in the main view.

The user can specify the INTERACTIVE draw style (draw style used when the scene changes) independently from the STILL style. Default is VIEW_AS_IS draw style for STILL and VIEW_SAME_AS_STILL for INTERACTIVE.

The default value can be set using the environment variables OIV_STILL_DRAW_STYLE and OIV_INTERACTIVE_DRAW_STYLE. Valid values are 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 for OIV_STILL_DRAW_STYLE and the same plus VIEW_SAME_AS_STILL for OIV_INTERACTIVE_DRAW_STYLE.

Possible draw styles are: VIEW_AS_IS - Leaves the objects unchanged.

VIEW_HIDDEN_LINE - Renders the object as wireframe, but only shows the object front faces. This is accomplished using a two-pass rendering. In the first pass, the objects are rendered as FILLED using the background BASE_COLOR (this sets up the wanted z-buffer values). The second pass then renders the objects as LINES, while adjusting the z-buffer range to limit overlapping polygons problems.

VIEW_NO_TEXTURE - Renders the objects without any textures. This is done by setting the override flag on an empty SoTexture2 node.

VIEW_LOW_COMPLEXITY - Renders the objects without any textures and with a low complexity. This is done by setting the override flag on an empty SoTexture2 node, and by setting a low complexity value on an SoComplexity node with override set to TRUE.

VIEW_LINE - Renders the objects as LINES (no texture) with lighting model set to BASE_COLOR.

VIEW_LOW_RES_LINE - Renders the objects as LINES (no texture) using a low complexity, with lighting model set to BASE_COLOR and no depth comparison.

VIEW_POINT - Renders the objects as POINTS (no texture) with lighting model set to BASE_COLOR.

VIEW_LOW_RES_POINT - Renders the objects as POINTS (no texture) using a low complexity, with lighting model set to BASE_COLOR and no depth comparison.

VIEW_BBOX - Renders the objects with complexity BOUNDING_BOX, lighting model set to BASE_COLOR and drawing style LINES (no texture) with no depth comparison.

VIEW_SAME_AS_STILL - This only applies to INTERACTIVE draw type. It enables the interactive draw style mode to match the regular draw style mode without having to set it explicitly.

Reimplemented from SoWinViewer.

virtual void SoWinFullViewer::setHeadlight ( SbBool  onOrOff  )  [virtual]

Turns the headlight on/off (default on).



The default value can be set using the environment variable OIV_USE_HEADLIGHT (0 = FALSE, 1 = TRUE).

Reimplemented from SoWinViewer.

void SoWinFullViewer::setPopupMenuEnabled ( SbBool  trueOrFalse  ) 

Enables/disables the viewer popup menu (default enabled).

See the viewer constructor to prevent the popup menu from being built.

The default value can be set using the environment variable OIV_VIEWER_POPUP_MENU (0 = OFF, 1 = ON).

Description or equivalent function for each submenu of this popup menu:

void SoWinFullViewer::setStereoDialog ( SoStereoDialog newDialog  )  [inline]
virtual void SoWinFullViewer::setViewing ( SbBool  onOrOff  )  [virtual]

Sets whether the viewer is turned on or off.

When turned on, messages are consumed by the viewer. When viewing is off, messages are processed by the viewer's render area. This means messages will be sent down to the scene graph for processing (i.e. picking can occur). Note that if the application has registered a message callback , it will be invoked on every message, whether viewing is turned on or not. However, the return value of this callback (which specifies whether the callback handled the message or not) is ignored when viewing is on. That is, the viewer will process the message even if the callback already did. This is to ensure that the viewing paradigm is not broken (default viewing is on).

Reimplemented from SoWinViewer.

Reimplemented in SoWinExaminerViewer, SoWinFlyViewer, SoWinPlaneViewer, and SoWinWalkViewer.


Member Data Documentation

In this version we track the currently "check marked" menu item in the Draw Style submenu (only one checked at a time).

Tracks the checkmark for "Still" draw style.

Pointer to the Draw Style submenu.

Pointer to the Functions submenu.

Popup menu provided by a client (i.e.

application program) of the viewer.

Pointer to the root of the popup menu.

The callbacks in this list will be invoked after the action selected from the viewer popup has been performed.

This applies to actions selected from only from the viewer popup, not from the clients popup. Note that it is possible to add the viewer's pre-defined popup as a submenu of the client's popup. In this case the callbacks in this list are still invoked after actions selected from the viewer popup are performed. The callback data for the callback is a pointer to the SoWinFullViewer object.

The callbacks in this list are invoked immediately prior to display of the popup menu, regardless of whether it is the pre-defined viewer menu or a menu installed by the client application.

The callback data for the callback is a pointer to the SoWinFullViewer object.

Pointer to the Preferences submenu.

Pointer to the popup menu container.


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

Open Inventor Toolkit reference manual, generated on 22 Sep 2021
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/