SoWinFullViewer Class Reference
[Win]
Base viewer class which adds a decoration around the rendering area.
More...
#include <Inventor/Win/viewers/SoWinFullViewer.h>
Detailed Description
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
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::setCamera | ( | SoCamera * | cam | ) | [virtual] |
Sets the camera that will be controlled by the viewer.
Setting the camera is only needed if the first camera found in the scene when setting the scene graph isn't the one that should be controlled.
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.
| 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:
- Functions: Manage the position of the camera:
- Home see resetToHomePosition()
- Set home see saveHomePosition()
- View all see viewAll()
- Seek see seekToPoint(const SbVec2s& mouseLocation)
- DrawStyle: Manage the draw style and buffering style:
- Viewing: see setViewing()
- Decorations: see setDecoration()
- FullScreen: see setFullScreen()
- HeadLight: see setHeadlight()
- Preferences:
- Seek to point: Enables/disables seek mode (like the 'S' key)
- Auto clip planes: Enables/disables automatic clipping
- Automatic interactive mode: Enables/disables automatic interactive mode
- Stereo: Opens the stereo dialog
- Anti-aliasing: see setAntialiasing()
- Record: Opens the recording dialog
- Rotation axes: Shows/hides the rotation axes
| 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:
- Inventor/Win/viewers/SoWinFullViewer.h