SoXtFullViewer Class Reference
[Xt]

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

#include <Inventor/Xt/viewers/SoXtFullViewer.h>

Inheritance diagram for SoXtFullViewer:
SoXtViewer SoXtRenderArea SoStereoViewer SoXtGLWidget SoXtComponent SoXtConstrainedViewer SoXtExaminerViewer SoXtPlaneViewer SoTVizViewer SoXtFlyViewer SoXtWalkViewer

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 ()
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 setHeadlight (SbBool onOrOff)
virtual void setDrawStyle (SoXtViewer::DrawType type, SoXtViewer::DrawStyle style)
virtual void setBufferingType (SoXtViewer::BufferType type)
virtual void setCamera (SoCamera *cam)
virtual void hide ()
SoStereoDialoggetStereoDialog ()
void setStereoDialog (SoStereoDialog *newDialog)

Public Attributes

SoStereoDialogm_stereoDialogBox

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 that 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 SoXtFullViewer provide a flag for specifying whether the decoration and popup menus should be built.

RESOURCES

SEE ALSO

SoXtViewer, SoXtComponent, SoXtRenderArea, SoXtExaminerViewer, SoXtWalkViewer, SoXtFlyViewer, SoXtPlaneViewer


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 SoXtFullViewer::addAppPushButton ( SoWidget  newButton  ) 

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

Adding buttons appends them to the end of the list.

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

int SoXtFullViewer::findAppPushButton ( SoWidget  oldButton  )  [inline]

Returns index of specified push button.

SoWidget SoXtFullViewer::getAppPushButtonParent (  )  const [inline]

Returns the parent widget, which is needed when creating new buttons.


Note that if the decoration is not created in the constructor, this will be NULL until the decoration is shown.

SoWidget SoXtFullViewer::getRenderAreaWidget (  )  [inline]

Returns the render area widget.

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

This hides the component.

Reimplemented from SoXtComponent.

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

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

Inserting buttons places them at the desired index.

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

SbBool SoXtFullViewer::isDecoration (  )  [inline]

Returns whether the viewer component trim is on or off.

SbBool SoXtFullViewer::isPopupMenuEnabled (  )  [inline]

Returns whether the viewer popup menu is enabled or disabled.

int SoXtFullViewer::lengthAppPushButton (  )  [inline]

Returns number of application push buttons.

void SoXtFullViewer::removeAppPushButton ( SoWidget  oldButton  ) 

Removes specified application push button.

virtual void SoXtFullViewer::setBufferingType ( SoXtViewer::BufferType  type  )  [virtual]

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

Reimplemented from SoXtViewer.

virtual void SoXtFullViewer::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 SoXtViewer.

Reimplemented in SoXtConstrainedViewer, SoXtExaminerViewer, SoXtFlyViewer, SoXtPlaneViewer, SoXtWalkViewer, and SoTVizViewer.

void SoXtFullViewer::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).

virtual void SoXtFullViewer::setDrawStyle ( SoXtViewer::DrawType  type,
SoXtViewer::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 SoXtViewer.

virtual void SoXtFullViewer::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 SoXtViewer.

Reimplemented in SoTVizViewer.

void SoXtFullViewer::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 SoXtFullViewer::setStereoDialog ( SoStereoDialog newDialog  )  [inline]
virtual void SoXtFullViewer::setViewing ( SbBool  onOrOff  )  [virtual]

Sets whether the viewer is turned on or off.

When turned on, events are consumed by the viewer. When viewing is off, events are processed by the viewer's render area. This means events will be sent down to the scene graph for processing (i.e. picking can occur). Note that if the application has registered an event 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 event or not) is ignored when viewing is on. That is, the viewer will process the event even if the callback already did. This is to ensure that the viewing paradigm is not broken (default viewing is on).

Reimplemented from SoXtViewer.

Reimplemented in SoXtExaminerViewer, SoXtFlyViewer, SoXtPlaneViewer, SoXtWalkViewer, and SoTVizViewer.


Member Data Documentation

Pointer to the stereo dialog.


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

Open Inventor Toolkit reference manual, generated on 16 Jul 2020
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/