SoQtPlaneViewer(3)

NAME
SoQtPlaneViewer - The SoQtPlaneViewer class is for examining 3D models by moving the camera in orthogonal planes.

The SoQtPlaneViewer is a viewer that is useful for 'CAD-style' applications, where you want the end-user to examine your model with the viewpoint set from one of the three principal axes.

SYNOPSIS

#include <Inventor/Qt/viewers/SoQtPlaneViewer.h>

Inherits SoQtFullViewer.

  Public Member Functions
SoQtPlaneViewer (QWidget *parent=NULL, const char *const name=NULL, SbBool embed=TRUE, SoQtFullViewer::BuildFlag flag=BUILD_ALL, SoQtViewer::Type type=BROWSER)
~SoQtPlaneViewer ()
virtual void setViewing (SbBool enable)
virtual void setCamera (SoCamera *camera)
virtual void setCursorEnabled (SbBool enable)

  Protected Member Functions
SoQtPlaneViewer (QWidget *parent, const char *const name, SbBool embed, SoQtFullViewer::BuildFlag flag, SoQtViewer::Type type, SbBool build)
QWidget * buildWidget (QWidget *parent)
virtual const char * getDefaultWidgetName (void) const
virtual const char * getDefaultTitle (void) const
virtual const char * getDefaultIconTitle (void) const
virtual SbBool processSoEvent (const SoEvent *const event)
virtual void setSeekMode (SbBool enable)
virtual void actualRedraw (void)
virtual void bottomWheelStart (void)
virtual void bottomWheelMotion (float value)
virtual void bottomWheelFinish (void)
virtual void leftWheelStart (void)
virtual void leftWheelMotion (float value)
virtual void leftWheelFinish (void)
virtual void rightWheelStart (void)
virtual void rightWheelMotion (float value)
virtual void rightWheelFinish (void)
virtual void createViewerButtons (QWidget *parent, SbPList *buttons)
virtual void afterRealizeHook (void)
virtual void computeSeekFinalOrientation (void)

  Friends
class SoGuiPlaneViewerP
class SoQtPlaneViewerP

  Additional Inherited Members

Detailed Description

The SoQtPlaneViewer class is for examining 3D models by moving the camera in orthogonal planes.

The SoQtPlaneViewer is a viewer that is useful for 'CAD-style' applications, where you want the end-user to examine your model with the viewpoint set from one of the three principal axes.

Controls:
•   hold down left mousebutton and move mouse pointer to dolly (or hold both left and middle mousebuttons)
•   hold middle mousebutton to pan (or a CTRL-key plus left mousebutton, or a SHIFT-key plus left mousebutton)
•   hold down CTRL + middle mousebutton to rotate (or CTRL + SHIFT + the left mousebutton)
•   click 's', then pick with the left mousebutton to seek
•   right mousebutton open the popup menu
•   click 'ESC' key to switch to and from 'view' mode and 'scenegraph interaction' mode (see setViewing() documentation)
Hitting any of the X, Y or Z buttons in the panel on the right side of the render canvas will 'flip' the current camera direction around it's focal point to point along the selected axis (towards negative infinity).
The SoQtPlaneViewer also provides a user decoration's button for toggling between orthographic or perspective camera view volumes and projection methods. This is the bottom-most click button on the right decoration border.
It also inherits the decoration buttons from the SoQtFullViewer: the arrow for switching to 'scenegraph interaction' mode, the hand for setting back to 'camera interaction' mode, the house for 'reset
  camera to home position', the blueprint house for 'set new camera
  home position', the eye for 'zoom camera out to view full scene' and the flashlight for setting 'click to seek' mode.
Note that a common faulty assumption about all the viewer-classes is that user interaction (in the 'examine'-mode, not the scenegraph-interaction mode) influences the model or 3D-scene in the view. This is not correct, as it is always the viewer's camera that is translated and rotated.
The initial position of the camera is placed such that all of the scenegraph's geometry fits within it's view.

Constructor & Destructor Documentation

  SoQtPlaneViewer::SoQtPlaneViewer (QWidget * parent = NULL, const char *const name = NULL, SbBool embed = TRUE, SoQtFullViewer::BuildFlag flag = BUILD_ALL, SoQtViewer::Type type = BROWSER)
The public constructor, to be used by application programmers who want to instantiate the plain, standard SoQtPlaneViewer.

  SoQtPlaneViewer::~SoQtPlaneViewer ()
The destructor. Cleans up all internal resources used by the SoQtPlaneViewer instance.

  SoQtPlaneViewer::SoQtPlaneViewer (QWidget * parent, const char *const name, SbBool embed, SoQtFullViewer::BuildFlag flag, SoQtViewer::Type type, SbBool build) [protected]
A protected constructor, to be used by application programmers who want to extend the SoQtPlaneViewer.

Member Function Documentation

  void SoQtPlaneViewer::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 SoQtFullViewer.
References SoQtViewer::isViewing().

  void SoQtPlaneViewer::setCamera (SoCamera * cam) [virtual]
Set the camera we want the viewer to manipulate when interacting with the viewer controls.
The camera passed in as an argument to this method must already be part of the viewer's scenegraph. You do not inject viewpoint cameras to the viewer with this method.
You should rather insert a camera into the scene graph first (if necessary, often one will be present already), then register it as the camera used by the viewer controls with this method.
If the application code doesn't explicitly set up a camera through this method, the viewer will automatically scan through the scenegraph to find a camera to use. If no camera is available in the scenegraph at all, it will set up it's own camera.
See also:
    getCamera()
Reimplemented from SoQtViewer.
References SoQtFullViewer::setRightWheelString().

  void SoQtPlaneViewer::setCursorEnabled (SbBool on) [virtual]
Set whether or not the mouse cursor representation should be visible in the viewer canvas.
Default value is on.
See also:
    isCursorEnabled()
Reimplemented from SoQtViewer.

  const char * SoQtPlaneViewer::getDefaultWidgetName (void) const [protected], [virtual]
This method returns the default name of a component widget class.
It should be overridden by derived non-abstract classes for the topmost widget in the component to have a proper name.
Reimplemented from SoQtRenderArea.

  const char * SoQtPlaneViewer::getDefaultTitle (void) const [protected], [virtual]
This method returns the default window caption string of the component.
It should be overridden by derived non-abstract classes so the window and popup menu will get a proper title.
Reimplemented from SoQtRenderArea.

  const char * SoQtPlaneViewer::getDefaultIconTitle (void) const [protected], [virtual]
This method returns the default icon title of the component.
It should be overridden by derived non-abstract classes so icons will get proper titles.
Reimplemented from SoQtRenderArea.

  SbBool SoQtPlaneViewer::processSoEvent (const SoEvent *const event) [protected], [virtual]
Toolkit-native events are attempted converted to Coin-generic events in the SoQtRenderArea::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 SoQtFullViewer.
References SoQtViewer::getCamera(), SoQtGLWidget::getGLAspectRatio(), SoQtGLWidget::getGLSize(), SoQtFullViewer::getRightWheelValue(), SoQtViewer::isSeekMode(), SoQtViewer::isViewing(), rightWheelMotion(), SoQtViewer::seekToPoint(), and SoQtFullViewer::setRightWheelValue().

  void SoQtPlaneViewer::setSeekMode (SbBool enable) [protected], [virtual]
Put the viewer in or out of 'waiting-to-seek' mode.
If the user performs a mouse button click when the viewer is in 'waiting-to-seek' mode, the camera will be repositioned so the camera focal point lies on the point of the geometry under the mouse cursor.
See also:
    isSeekMode(), setDetailSeek()
Reimplemented from SoQtViewer.
References SoQtViewer::isSeekMode(), and SoQtViewer::isViewing().

  void SoQtPlaneViewer::actualRedraw (void) [protected], [virtual]
This method instantly redraws the normal (non-overlay) scenegraph by calling SoSceneManager::render().
Subclasses may override this method to add their own rendering before or after Coin renders it's scenegraph.
The following is a complete example that demonstrates one way of adding both a background image and foreground (overlay) geometry to the 'normal' rendering:
// This example shows how to put a permanent background image on
// your viewer canvas, below the 3D graphics, plus overlay
// foreground geometry.  Written by mortene.
// Copyright Kongsberg Oil & Gas Technologies 2002.
// *************************************************************************
#include <Inventor/Qt/SoQt.h>
#include <Inventor/Qt/viewers/SoQtExaminerViewer.h>
#include <Inventor/nodes/SoBaseColor.h>
#include <Inventor/nodes/SoCone.h>
#include <Inventor/nodes/SoCube.h>
#include <Inventor/nodes/SoImage.h>
#include <Inventor/nodes/SoLightModel.h>
#include <Inventor/nodes/SoOrthographicCamera.h>
#include <Inventor/nodes/SoRotationXYZ.h>
#include <Inventor/nodes/SoSeparator.h>
#include <Inventor/nodes/SoTranslation.h>
#include <GL/gl.h>
// *************************************************************************
class MyExaminerViewer : public SoQtExaminerViewer {
public:
  MyExaminerViewer(QWidget * parent, const char * filename);
  ~MyExaminerViewer();
protected:
  virtual void actualRedraw(void);
private:
  SoSeparator * bckgroundroot;
  SoSeparator * foregroundroot;
  SoRotationXYZ * arrowrotation;
};
MyExaminerViewer::MyExaminerViewer(QWidget * parent, const char * filename)
  : SoQtExaminerViewer(parent)
{
  // Coin should not clear the pixel-buffer, so the background image
  // is not removed.
  this->setClearBeforeRender(FALSE, TRUE);
  // Set up background scenegraph with image in it.
  this->bckgroundroot = new SoSeparator;
  this->bckgroundroot->ref();
  SoOrthographicCamera * cam = new SoOrthographicCamera;
  cam->position = SbVec3f(0, 0, 1);
  cam->height = 1;
  // SoImage will be at z==0.0.
  cam->nearDistance = 0.5;
  cam->farDistance = 1.5;
  SoImage * img = new SoImage;
  img->vertAlignment = SoImage::HALF;
  img->horAlignment = SoImage::CENTER;
  img->filename = filename;
  this->bckgroundroot->addChild(cam);
  this->bckgroundroot->addChild(img);
  // Set up foreground, overlayed scenegraph.
  this->foregroundroot = new SoSeparator;
  this->foregroundroot->ref();
  SoLightModel * lm = new SoLightModel;
  lm->model = SoLightModel::BASE_COLOR;
  SoBaseColor * bc = new SoBaseColor;
  bc->rgb = SbColor(1, 1, 0);
  cam = new SoOrthographicCamera;
  cam->position = SbVec3f(0, 0, 5);
  cam->height = 10;
  cam->nearDistance = 0;
  cam->farDistance = 10;
  const double ARROWSIZE = 2.0;
  SoTranslation * posit = new SoTranslation;
  posit->translation = SbVec3f(-2.5 * ARROWSIZE, 1.5 * ARROWSIZE, 0);
  arrowrotation = new SoRotationXYZ;
  arrowrotation->axis = SoRotationXYZ::Z;
  SoTranslation * offset = new SoTranslation;
  offset->translation = SbVec3f(ARROWSIZE/2.0, 0, 0);
  SoCube * cube = new SoCube;
  cube->width = ARROWSIZE;
  cube->height = ARROWSIZE/15.0;
  this->foregroundroot->addChild(cam);
  this->foregroundroot->addChild(lm);
  this->foregroundroot->addChild(bc);
  this->foregroundroot->addChild(posit);
  this->foregroundroot->addChild(arrowrotation);
  this->foregroundroot->addChild(offset);
  this->foregroundroot->addChild(cube);
}
MyExaminerViewer::~MyExaminerViewer()
{
  this->bckgroundroot->unref();
  this->foregroundroot->unref();
}
void
MyExaminerViewer::actualRedraw(void)
{
  // Must set up the OpenGL viewport manually, as upon resize
  // operations, Coin won't set it up until the SoGLRenderAction is
  // applied again. And since we need to do glClear() before applying
  // the action..
  const SbViewportRegion vp = this->getViewportRegion();
  SbVec2s origin = vp.getViewportOriginPixels();
  SbVec2s size = vp.getViewportSizePixels();
  glViewport(origin[0], origin[1], size[0], size[1]);
  const SbColor col = this->getBackgroundColor();
  glClearColor(col[0], col[1], col[2], 0.0f);
  glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
  // Render our scenegraph with the image.
  SoGLRenderAction * glra = this->getGLRenderAction();
  glra->apply(this->bckgroundroot);
  // Render normal scenegraph.
  SoQtExaminerViewer::actualRedraw();
  // Increase arrow angle with 1/1000 ° every frame.
  arrowrotation->angle = arrowrotation->angle.getValue() + (0.001 / M_PI * 180);
  // Render overlay front scenegraph.
  glClear(GL_DEPTH_BUFFER_BIT);
  glra->apply(this->foregroundroot);
}
// *************************************************************************
int
main(int argc, char ** argv)
{
  if (argc != 2) {
    (void)fprintf(stderr, "n	Usage: %s <image-filename>n", argv[0]);
    exit(1);
  }
  QWidget * window = SoQt::init(argv[0]);
  MyExaminerViewer * viewer = new MyExaminerViewer(window, argv[1]);
  viewer->setSceneGraph(new SoCone);
  viewer->show();
  SoQt::show(window);
  SoQt::mainLoop();
  delete viewer;
  return 0;
}
// *************************************************************************

Reimplemented from SoQtViewer.

  void SoQtPlaneViewer::bottomWheelStart (void) [protected], [virtual]
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 from SoQtFullViewer.

  void SoQtPlaneViewer::bottomWheelMotion (float value) [protected], [virtual]
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 from SoQtFullViewer.
References SoQtFullViewer::getBottomWheelValue(), SoQtViewer::getCamera(), and SoQtGLWidget::getGLAspectRatio().

  void SoQtPlaneViewer::bottomWheelFinish (void) [protected], [virtual]
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 from SoQtFullViewer.

  void SoQtPlaneViewer::leftWheelStart (void) [protected], [virtual]
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 from SoQtFullViewer.

  void SoQtPlaneViewer::leftWheelMotion (float value) [protected], [virtual]
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 from SoQtFullViewer.
References SoQtViewer::getCamera(), SoQtGLWidget::getGLAspectRatio(), and SoQtFullViewer::getLeftWheelValue().

  void SoQtPlaneViewer::leftWheelFinish (void) [protected], [virtual]
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 from SoQtFullViewer.

  void SoQtPlaneViewer::rightWheelStart (void) [protected], [virtual]
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 from SoQtFullViewer.

  void SoQtPlaneViewer::rightWheelMotion (float value) [protected], [virtual]
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 from SoQtFullViewer.
References SoQtViewer::getCamera(), and SoQtFullViewer::getRightWheelValue().
Referenced by processSoEvent().

  void SoQtPlaneViewer::rightWheelFinish (void) [protected], [virtual]
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 from SoQtFullViewer.

  void SoQtPlaneViewer::createViewerButtons (QWidget * parent, SbPList * buttonlist) [protected], [virtual]
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 SoQtExaminerViewer:
class MyExaminerViewer : public SoQtExaminerViewer {
public:
  MyExaminerViewer(QWidget * parent);
protected:
  virtual void createViewerButtons(QWidget * parent, SbPList * buttonlist);
};
MyExaminerViewer::MyExaminerViewer(QWidget * parent)
  : SoQtExaminerViewer(parent, NULL, TRUE,
                          SoQtFullViewer::BUILD_ALL, SoQtFullViewer::BROWSER,
                          // build == FALSE, to delay creation of decorations
                          FALSE)
{
  // Explicitly trigger the construction of viewer decorations.
  QWidget * widget = this->buildWidget(this->getParentWidget());
  this->setBaseWidget(widget);
}
void
MyExaminerViewer::createViewerButtons(QWidget * parent, SbPList * buttonlist)
{
  SoQtExaminerViewer::createViewerButtons(parent, buttonlist);
  // [now add your own button(s) to the buttonlist]
}

Reimplemented from SoQtFullViewer.
References SoQtViewer::getCameraType().

  void SoQtPlaneViewer::afterRealizeHook (void) [protected], [virtual]
A function 'hook' / callback invoked just after the window for the component has been realized.
Override this if you need specific initialization for your own component or viewer class to happen right after it has been made visible, but remember to call upwards in the inheritance hierarchy:
void
MyLittleViewer::afterRealizeHook(void)
{
  <superclass>::afterRealizeHook();
  // [own initialization here]
}

Reimplemented from SoQtRenderArea.

  virtual void SoQtPlaneViewer::computeSeekFinalOrientation (void) [protected], [virtual]
This method can be overridden in subclasses if the final orientation of the camera after a seek should be something other than what is computed in SoQtViewer::seekToPoint(const SbVec3f & scenepos)
Reimplemented from SoQtViewer.

Author
Generated automatically by Doxygen for SoQt from the source code.