SoQt
1.6.3
Coin3D GUI toolkit binding
|
The SoQtExaminerViewer class is a 3D-model examination viewer. More...
#include <Inventor/Qt/viewers/SoQtExaminerViewer.h>
Public Member Functions | |
SoQtExaminerViewer (QWidget *parent=NULL, const char *name=NULL, SbBool embed=TRUE, SoQtFullViewer::BuildFlag flag=BUILD_ALL, SoQtViewer::Type type=BROWSER) | |
int | getFeedbackSize (void) const |
SbBool | isAnimating (void) const |
SbBool | isAnimationEnabled (void) const |
SbBool | isFeedbackVisible (void) const |
void | setAnimationEnabled (const SbBool enable) |
virtual void | setCamera (SoCamera *camera) |
virtual void | setCursorEnabled (SbBool enable) |
void | setFeedbackSize (const int size) |
void | setFeedbackVisibility (const SbBool enable) |
virtual void | setViewing (SbBool enable) |
void | stopAnimating (void) |
Public Member Functions inherited from SoQtFullViewer | |
void | addAppPushButton (QWidget *newButton) |
int | findAppPushButton (QWidget *oldButton) const |
QWidget * | getAppPushButtonParent (void) const |
QWidget * | getRenderAreaWidget (void) const |
void | insertAppPushButton (QWidget *newButton, int index) |
SbBool | isDecoration (void) const |
SbBool | isPopupMenuEnabled (void) const |
int | lengthAppPushButton (void) const |
void | removeAppPushButton (QWidget *oldButton) |
virtual void | setComponentCursor (const SoQtCursor &cursor) |
void | setDecoration (const SbBool on) |
void | setPopupMenuEnabled (const SbBool on) |
Public Member Functions inherited from SoQtViewer | |
void | addFinishCallback (SoQtViewerCB *func, void *data=NULL) |
void | addStartCallback (SoQtViewerCB *func, void *data=NULL) |
void | getAnaglyphStereoColorMasks (SbBool left[3], SbBool right[3]) |
SoQtViewer::BufferType | getBufferingType (void) const |
SoCamera * | getCamera (void) const |
SoType | getCameraType (void) const |
SoQtViewer::DrawStyle | getDrawStyle (const SoQtViewer::DrawType type) const |
SoDirectionalLight * | getHeadlight (void) const |
virtual SoNode * | getSceneGraph (void) |
float | getSeekTime (void) const |
float | getStereoOffset (void) const |
SoQtViewer::StereoType | getStereoType (void) const |
const SbColor & | getWireframeOverlayColor (void) const |
SbBool | isAutoClipping (void) const |
SbBool | isCursorEnabled (void) const |
SbBool | isDetailSeek (void) const |
SbBool | isHeadlight (void) const |
SbBool | isStereoViewing (void) const |
SbBool | isViewing (void) const |
void | removeFinishCallback (SoQtViewerCB *func, void *data=NULL) |
void | removeStartCallback (SoQtViewerCB *func, void *data=NULL) |
virtual void | resetToHomePosition (void) |
virtual void | saveHomePosition (void) |
void | setAnaglyphStereoColorMasks (const SbBool left[3], const SbBool right[3]) |
void | setAutoClipping (SbBool enable) |
void | setAutoClippingStrategy (const AutoClippingStrategy strategy, const float value=0.6f, SoQtAutoClippingCB *cb=NULL, void *cbuserdata=NULL) |
virtual void | setBufferingType (SoQtViewer::BufferType type) |
virtual void | setCameraType (SoType type) |
void | setDetailSeek (const SbBool enable) |
virtual void | setDoubleBuffer (const SbBool enable) |
virtual void | setDrawStyle (SoQtViewer::DrawType type, SoQtViewer::DrawStyle style) |
virtual void | setHeadlight (SbBool enable) |
virtual void | setSceneGraph (SoNode *root) |
void | setSeekTime (const float seconds) |
virtual void | setStereoOffset (const float dist) |
SbBool | setStereoType (SoQtViewer::StereoType s) |
virtual void | setStereoViewing (SbBool enable) |
void | setWireframeOverlayColor (const SbColor &color) |
virtual void | toggleCameraType (void) |
virtual void | viewAll (void) |
Public Member Functions inherited from SoQtRenderArea | |
SoQtRenderArea (QWidget *parent=NULL, const char *name=NULL, SbBool embed=TRUE, SbBool mouseInput=TRUE, SbBool keyboardInput=TRUE) | |
~SoQtRenderArea () | |
void | getAntialiasing (SbBool &smoothing, int &numPasses) const |
const SbColor & | getBackgroundColor (void) const |
int | getBackgroundIndex (void) const |
SoGLRenderAction * | getGLRenderAction (void) const |
int | getOverlayBackgroundIndex (void) const |
SoGLRenderAction * | getOverlayGLRenderAction (void) const |
SoNode * | getOverlaySceneGraph (void) |
SoSceneManager * | getOverlaySceneManager (void) const |
uint32_t | getRedrawPriority (void) const |
SoSceneManager * | getSceneManager (void) const |
SoGLRenderAction::TransparencyType | getTransparencyType (void) const |
const SbViewportRegion & | getViewportRegion (void) const |
SbBool | isAutoRedraw (void) const |
SbBool | isClearBeforeOverlayRender (void) const |
SbBool | isClearBeforeRender (void) const |
SbBool | isClearZBufferBeforeRender (void) const |
void | redrawOnSelectionChange (SoSelection *selection) |
void | redrawOverlayOnSelectionChange (SoSelection *selection) |
void | registerDevice (SoQtDevice *device) |
void | render (void) |
void | renderOverlay (void) |
void | scheduleOverlayRedraw (void) |
void | scheduleRedraw (void) |
SbBool | sendSoEvent (const SoEvent *event) |
void | setAntialiasing (SbBool smoothing, int numPasses) |
void | setAutoRedraw (SbBool enable) |
void | setBackgroundColor (const SbColor &color) |
void | setBackgroundIndex (int idx) |
void | setClearBeforeOverlayRender (SbBool enable) |
void | setClearBeforeRender (SbBool enable, SbBool zbEnable=TRUE) |
void | setColorMap (int start, int num, const SbColor *colors) |
void | setEventCallback (SoQtRenderAreaEventCB *func, void *user=NULL) |
void | setGLRenderAction (SoGLRenderAction *action) |
void | setOverlayBackgroundIndex (int idx) |
void | setOverlayColorMap (int start, int num, const SbColor *colors) |
void | setOverlayGLRenderAction (SoGLRenderAction *action) |
void | setOverlaySceneGraph (SoNode *scene) |
void | setOverlaySceneManager (SoSceneManager *manager) |
void | setRedrawPriority (uint32_t priority) |
void | setSceneManager (SoSceneManager *manager) |
void | setTransparencyType (SoGLRenderAction::TransparencyType type) |
void | setViewportRegion (const SbViewportRegion &newRegion) |
void | unregisterDevice (SoQtDevice *device) |
Public Member Functions inherited from SoQtGLWidget | |
SbBool | getAccumulationBuffer (void) const |
SbBool | getAlphaChannel (void) const |
QWidget * | getGLWidget (void) const |
void | getLineWidthLimits (SbVec2f &range, float &granularity) |
QWidget * | getNormalWidget (void) const |
unsigned long | getOverlayTransparentPixel (void) |
QWidget * | getOverlayWidget (void) const |
void | getPointSizeLimits (SbVec2f &range, float &granularity) |
int | getSampleBuffers (void) const |
SbBool | getStencilBuffer (void) const |
SbBool | hasNormalGLArea (void) const |
SbBool | hasOverlayGLArea (void) const |
SbBool | isBorder (void) const |
SbBool | isDoubleBuffer (void) const |
SbBool | isDrawToFrontBufferEnable (void) const |
SbBool | isOverlayRender (void) const |
SbBool | isQuadBufferStereo (void) const |
SbBool | isStealFocus (void) const |
void | setAccumulationBuffer (const SbBool enable) |
void | setAlphaChannel (const SbBool enable) |
void | setBorder (const SbBool enable) |
void | setDrawToFrontBufferEnable (const SbBool enable) |
void | setOverlayRender (const SbBool onoff) |
void | setQuadBufferStereo (const SbBool enable) |
void | setSampleBuffers (const int numsamples) |
void | setStealFocus (SbBool enable) |
void | setStencilBuffer (const SbBool enable) |
Public Member Functions inherited from SoQtComponent | |
virtual | ~SoQtComponent () |
QWidget * | getBaseWidget (void) const |
const char * | getClassName (void) const |
const char * | getIconTitle (void) const |
QWidget * | getParentWidget (void) const |
QWidget * | getShellWidget (void) const |
SbVec2s | getSize (void) const |
const char * | getTitle (void) const |
QWidget * | getWidget (void) const |
const char * | getWidgetName (void) const |
virtual void | hide (void) |
SbBool | isFullScreen (void) const |
SbBool | isTopLevelShell (void) const |
SbBool | isVisible (void) |
SbBool | setFullScreen (const SbBool onoff) |
void | setIconTitle (const char *const title) |
void | setSize (const SbVec2s size) |
void | setTitle (const char *const title) |
void | setWindowCloseCallback (SoQtComponentCB *const func, void *const user=NULL) |
virtual void | show (void) |
Public Member Functions inherited from SoQtObject | |
virtual SoType | getTypeId (void) const =0 |
SbBool | isOfType (SoType type) const |
Protected Member Functions | |
SoQtExaminerViewer (QWidget *parent, const char *name, SbBool embed, SoQtFullViewer::BuildFlag flag, SoQtViewer::Type type, SbBool build) | |
virtual void | actualRedraw (void) |
virtual void | afterRealizeHook (void) |
virtual void | bottomWheelMotion (float val) |
virtual void | createViewerButtons (QWidget *parent, SbPList *buttonlist) |
virtual const char * | getDefaultIconTitle (void) const |
virtual const char * | getDefaultTitle (void) const |
virtual const char * | getDefaultWidgetName (void) const |
virtual void | leftWheelMotion (float val) |
virtual SbBool | processSoEvent (const SoEvent *const event) |
virtual void | rightWheelMotion (float val) |
virtual void | setSeekMode (SbBool enable) |
Protected Member Functions inherited from SoQtFullViewer | |
SoQtFullViewer (QWidget *parent, const char *name, SbBool embed, BuildFlag flag, Type type, SbBool build) | |
~SoQtFullViewer () | |
virtual void | bottomWheelFinish (void) |
virtual void | bottomWheelStart (void) |
QWidget * | buildAppButtons (QWidget *parent) |
virtual QWidget * | buildBottomTrim (QWidget *parent) |
virtual void | buildDecoration (QWidget *parent) |
virtual QWidget * | buildLeftTrim (QWidget *parent) |
virtual void | buildPopupMenu (void) |
virtual QWidget * | buildRightTrim (QWidget *parent) |
QWidget * | buildViewerButtons (QWidget *parent) |
QWidget * | buildWidget (QWidget *parent) |
QWidget * | getBottomWheelLabelWidget (void) const |
float | getBottomWheelValue (void) const |
QWidget * | getLeftWheelLabelWidget (void) const |
float | getLeftWheelValue (void) const |
QWidget * | getRightWheelLabelWidget (void) const |
const char * | getRightWheelString () const |
float | getRightWheelValue (void) const |
virtual void | leftWheelFinish (void) |
virtual void | leftWheelStart (void) |
virtual void | openPopupMenu (const SbVec2s position) |
virtual void | rightWheelFinish (void) |
virtual void | rightWheelStart (void) |
void | setBottomWheelString (const char *const name) |
void | setBottomWheelValue (const float value) |
void | setLeftWheelString (const char *const name) |
void | setLeftWheelValue (const float value) |
virtual void | setPopupMenuString (const char *title) |
void | setRightWheelString (const char *const name) |
void | setRightWheelValue (const float value) |
virtual void | sizeChanged (const SbVec2s &size) |
Protected Member Functions inherited from SoQtViewer | |
SoQtViewer (QWidget *parent, const char *name, SbBool embed, Type type, SbBool build) | |
~SoQtViewer () | |
void | addSuperimposition (SoNode *scene) |
virtual void | changeCameraValues (SoCamera *camera) |
virtual void | computeSeekFinalOrientation (void) |
int | getInteractiveCount (void) const |
float | getSeekDistance (void) const |
SbBool | getSuperimpositionEnabled (SoNode *scene) const |
void | interactiveCountDec (void) |
void | interactiveCountInc (void) |
SbBool | isSeekMode (void) const |
SbBool | isSeekValuePercentage (void) const |
void | removeSuperimposition (SoNode *scene) |
SbBool | seekToPoint (const SbVec2s screenpos) |
void | seekToPoint (const SbVec3f &scenepos) |
void | setSeekDistance (const float distance) |
void | setSeekValueAsPercentage (const SbBool on) |
void | setSuperimpositionEnabled (SoNode *scene, const SbBool enable) |
Protected Member Functions inherited from SoQtRenderArea | |
SoQtRenderArea (QWidget *parent, const char *name, SbBool embed, SbBool mouseInput, SbBool keyboardInput, SbBool build) | |
virtual void | actualOverlayRedraw (void) |
QWidget * | buildWidget (QWidget *parent) |
virtual SbBool | glScheduleRedraw (void) |
virtual void | initGraphic (void) |
virtual void | initOverlayGraphic (void) |
virtual void | processEvent (QEvent *event) |
virtual void | redraw (void) |
virtual void | redrawOverlay (void) |
virtual void | widgetChanged (QWidget *widget) |
Protected Member Functions inherited from SoQtGLWidget | |
SoQtGLWidget (QWidget *const parent=NULL, const char *const name=NULL, const SbBool embed=TRUE, const int glmodes=SO_GL_RGB, const SbBool build=TRUE) | |
~SoQtGLWidget () | |
QWidget * | buildWidget (QWidget *parent) |
float | getGLAspectRatio (void) const |
SbVec2s | getGLSize (void) const |
float | getGlxAspectRatio (void) const |
SbVec2s | getGlxSize (void) const |
void | glFlushBuffer (void) |
void | glLockNormal (void) |
void | glLockOverlay (void) |
void | glSwapBuffers (void) |
void | glUnlockNormal (void) |
void | glUnlockOverlay (void) |
SbBool | isRGBMode (void) |
SbBool | isStereoBuffer (void) const |
void | setGLSize (const SbVec2s size) |
void | setGlxSize (const SbVec2s size) |
void | setStereoBuffer (SbBool flag) |
Protected Member Functions inherited from SoQtComponent | |
SoQtComponent (QWidget *const parent=NULL, const char *const name=NULL, const SbBool embed=TRUE) | |
void | addVisibilityChangeCallback (SoQtComponentVisibilityCB *const func, void *const user=NULL) |
void | registerWidget (QWidget *widget) |
void | removeVisibilityChangeCallback (SoQtComponentVisibilityCB *const func, void *const user=NULL) |
void | setBaseWidget (QWidget *widget) |
void | setClassName (const char *const name) |
void | unregisterWidget (QWidget *widget) |
The SoQtExaminerViewer class is a 3D-model examination viewer.
This class is the viewer considered to be the most "general purpose" viewer, and it is often used in rapid prototyping to examine simple models as well as complete scenes (although for the latter, you might be better off with one of the other viewer classes).
Here is a complete, stand-alone example that shows how to set up an SoQtExaminerViewer as a model viewer that loads Inventor and VRML files from disk and places them inside the viewer for the end-user to examine:
SoQtExaminerViewer has a convenient interface for repositioning and reorientation of the camera, by panning, rotating and zooming its position. The following controls can be used:
hold down left mouse button and move mouse pointer to rotate the camera around its current focal point (the focal point can be changed by doing a seek operation)
hold middle mouse button to pan (or a CTRL-key plus left mouse button, or a SHIFT-key plus left mouse button)
hold down left + middle mouse button to zoom / dolly, or CTRL + middle mouse button, or CTRL + SHIFT + the left mouse button
click 's', then pick with the left mouse button to seek
right mouse button opens the pop-up menu
click 'ESC' key to switch to and from 'camera interaction' mode and 'scene graph interaction' mode (see setViewing() documentation)
hold down the 'ALT' key to temporary toggle from camera-interaction mode to scene graph-interaction mode
The SoQtExaminerViewer 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 "scene graph 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 scene graph-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 scene graph's geometry fits within its view.
SoQtExaminerViewer::SoQtExaminerViewer | ( | QWidget * | parent = NULL, |
const char * | name = NULL, | ||
SbBool | embed = TRUE, | ||
SoQtFullViewer::BuildFlag | flag = BUILD_ALL, | ||
SoQtViewer::Type | type = BROWSER ) |
Constructor. See parent class for explanation of arguments. Calling this constructor will make sure the examiner viewer widget will be built immediately.
|
protected |
Constructor. See parent class for explanation of arguments.
|
protectedvirtual |
This method instantly redraws the normal (non-overlay) scene graph by calling SoSceneManager::render().
Subclasses may override this method to add their own rendering before or after Coin renders its scene graph.
The following is a complete example that demonstrates one way of adding both a background image and foreground (overlay) geometry to the "normal" rendering:
Reimplemented from SoQtViewer.
|
protectedvirtual |
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:
Reimplemented from SoQtRenderArea.
|
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.
Reimplemented from SoQtFullViewer.
|
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 its 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 its 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:
Reimplemented from SoQtFullViewer.
|
protectedvirtual |
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.
|
protectedvirtual |
This method returns the default window caption string of the component.
It should be overridden by derived non-abstract classes so the window and pop-up menu will get a proper title.
Reimplemented from SoQtRenderArea.
|
protectedvirtual |
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.
int SoQtExaminerViewer::getFeedbackSize | ( | void | ) | const |
Return the size of the feedback axis cross. Default is 25.
SbBool SoQtExaminerViewer::isAnimating | ( | void | ) | const |
Query if the model in the viewer is currently in spinning mode after a user drag.
SbBool SoQtExaminerViewer::isAnimationEnabled | ( | void | ) | const |
Query whether or not it is possible to start a spinning animation by releasing the left mouse button while dragging the mouse.
SbBool SoQtExaminerViewer::isFeedbackVisible | ( | void | ) | const |
Check if the feedback axis cross is visible.
|
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.
Reimplemented from SoQtFullViewer.
|
protectedvirtual |
Toolkit-native events are tried to convert 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 its subclasses to catch events of particular interest to the viewer classes, for instance.
Return TRUE
if 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.
|
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.
Reimplemented from SoQtFullViewer.
void SoQtExaminerViewer::setAnimationEnabled | ( | const SbBool | enable | ) |
Decide if it should be possible to start a spin animation of the model in the viewer by releasing the mouse button while dragging.
If the enable flag is FALSE
and we're currently animating, the spin will be stopped.
|
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 scene graph. 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 scene graph to find a camera to use. If no camera is available in the scene graph at all, it will set up its own camera.
Reimplemented from SoQtViewer.
|
virtual |
Decide whether or not the mouse pointer cursor should be visible in the rendering canvas.
Reimplemented from SoQtViewer.
void SoQtExaminerViewer::setFeedbackSize | ( | const int | size | ) |
Set the size of the feedback axis cross. The value is interpreted as an approximate percentage chunk of the dimensions of the total canvas.
void SoQtExaminerViewer::setFeedbackVisibility | ( | const SbBool | enable | ) |
Set the flag deciding whether or not to show the axis cross.
|
protectedvirtual |
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.
Reimplemented from SoQtViewer.
|
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 mouse clicks and -movements) will be passed along to the scene graph.
Default is to have the view mode active.
Reimplemented from SoQtFullViewer.
void SoQtExaminerViewer::stopAnimating | ( | void | ) |
Stop the model from spinning.