SoQtPlaneViewer(3)

📦

version 1.6.2 · 3 versions

1.6.2 · opensuse-leap 16.0 (latest)
1.6.4 · alpine 3.24
1.6.0 · fedora 43, fedora 44

💅 SoQtPlaneViewer(3) — the SoQt manual, bestie cut 🎀

okay so we're doing the SoQt manual page for SoQtPlaneViewer, and this is part 1 of 4. It's giving meet the viewer, then meet its entire inherited family tree. No cap, every signature is about to show up exactly as it should. ✨

🌸 NAME 🌸

SoQtPlaneViewer — the class for examining 3D models by moving the camera in orthogonal planes. That's the official vibe: camera movement goes all orthogonal-plane mode so you can inspect your model from those planes. Slay. 💅

✨ SYNOPSIS ✨

Include line, verbatim:

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

Inherits SoQtFullViewer. 🫶

🦋 Public Member Functions 🦋

Home-team roster, exact signatures, no edits:

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)

🌈 Public Member Functions inherited from SoQtFullViewer 🌈

Inherited hand-me-downs, still iconic:

void setDecoration (const SbBool on)
SbBool isDecoration (void) const
void setPopupMenuEnabled (const SbBool on)
SbBool isPopupMenuEnabled (void) const
QWidget * getAppPushButtonParent (void) const
void addAppPushButton (QWidget *newButton)
void insertAppPushButton (QWidget *newButton, int index)
void removeAppPushButton (QWidget *oldButton)
int findAppPushButton (QWidget *oldButton) const
int lengthAppPushButton (void) const
QWidget * getRenderAreaWidget (void) const
virtual void setComponentCursor (const SoQtCursor &cursor)

🐚 Public Member Functions inherited from SoQtViewer 🐚

More inherited main-character energy:

SoCamera * getCamera (void) const
virtual void setCameraType (SoType type)
SoType getCameraType (void) const
virtual void toggleCameraType (void)
virtual void viewAll (void)
virtual void saveHomePosition (void)
virtual void resetToHomePosition (void)
virtual void setHeadlight (SbBool enable)
SbBool isHeadlight (void) const
SoDirectionalLight * getHeadlight (void) const
virtual void setDrawStyle (SoQtViewer::DrawType type, SoQtViewer::DrawStyle style)
SoQtViewer::DrawStyle getDrawStyle (const SoQtViewer::DrawType type) const
virtual void setBufferingType (SoQtViewer::BufferType type)
SoQtViewer::BufferType getBufferingType (void) const
SbBool isViewing (void) const
SbBool isCursorEnabled (void) const
void setAutoClipping (SbBool enable)
SbBool isAutoClipping (void) const
void setAutoClippingStrategy (const AutoClippingStrategy strategy, const float value=0.6f, SoQtAutoClippingCB *cb=NULL, void *cbuserdata=NULL)
virtual void setStereoViewing (SbBool enable)
SbBool isStereoViewing (void) const
virtual void setStereoOffset (const float dist)
float getStereoOffset (void) const
SbBool setStereoType (SoQtViewer::StereoType s)
SoQtViewer::StereoType getStereoType (void) const
void setAnaglyphStereoColorMasks (const SbBool left[3], const SbBool right[3])
void getAnaglyphStereoColorMasks (SbBool left[3], SbBool right[3])
void setDetailSeek (const SbBool enable)
SbBool isDetailSeek (void) const
void setSeekTime (const float seconds)
float getSeekTime (void) const
void addStartCallback (SoQtViewerCB *func, void *data=NULL)
void addFinishCallback (SoQtViewerCB *func, void *data=NULL)
void removeStartCallback (SoQtViewerCB *func, void *data=NULL)
void removeFinishCallback (SoQtViewerCB *func, void *data=NULL)
void setWireframeOverlayColor (const SbColor &color)
const SbColor & getWireframeOverlayColor (void) const
virtual void setDoubleBuffer (const SbBool enable)
virtual void setSceneGraph (SoNode *root)
virtual SoNode * getSceneGraph (void)

🦋 Public Member Functions inherited from SoQtRenderArea 🦋

The render-area inheritance batch, periodt:

SoQtRenderArea (QWidget *parent=NULL, const char *name=NULL, SbBool embed=TRUE, SbBool mouseInput=TRUE, SbBool keyboardInput=TRUE)
~SoQtRenderArea ()
void setOverlaySceneGraph (SoNode *scene)
SoNode * getOverlaySceneGraph (void)
void setBackgroundColor (const SbColor &color)
const SbColor & getBackgroundColor (void) const
void setBackgroundIndex (int idx)
int getBackgroundIndex (void) const
void setOverlayBackgroundIndex (int idx)
int getOverlayBackgroundIndex (void) const
void setColorMap (int start, int num, const SbColor *colors)
void setOverlayColorMap (int start, int num, const SbColor *colors)
void setViewportRegion (const SbViewportRegion &newRegion)
const SbViewportRegion & getViewportRegion (void) const
void setTransparencyType (SoGLRenderAction::TransparencyType type)
SoGLRenderAction::TransparencyType getTransparencyType (void) const
void setAntialiasing (SbBool smoothing, int numPasses)
void getAntialiasing (SbBool &smoothing, int &numPasses) const
void setClearBeforeRender (SbBool enable, SbBool zbEnable=TRUE)
SbBool isClearBeforeRender (void) const
SbBool isClearZBufferBeforeRender (void) const
void setClearBeforeOverlayRender (SbBool enable)
SbBool isClearBeforeOverlayRender (void) const
void setAutoRedraw (SbBool enable)
SbBool isAutoRedraw (void) const
void setRedrawPriority (uint32_t priority)
uint32_t getRedrawPriority (void) const
void render (void)
void renderOverlay (void)
void scheduleRedraw (void)
void scheduleOverlayRedraw (void)
void redrawOnSelectionChange (SoSelection *selection)
void redrawOverlayOnSelectionChange (SoSelection *selection)
void setEventCallback (SoQtRenderAreaEventCB *func, void *user=NULL)
void setSceneManager (SoSceneManager *manager)
SoSceneManager * getSceneManager (void) const
void setOverlaySceneManager (SoSceneManager *manager)
SoSceneManager * getOverlaySceneManager (void) const
void setGLRenderAction (SoGLRenderAction *action)
SoGLRenderAction * getGLRenderAction (void) const
void setOverlayGLRenderAction (SoGLRenderAction *action)
SoGLRenderAction * getOverlayGLRenderAction (void) const
SbBool sendSoEvent (const SoEvent *event)
void registerDevice (SoQtDevice *device)
void unregisterDevice (SoQtDevice *device)

💜 Public Member Functions inherited from SoQtGLWidget 💜

GL widget family, lowkey essential:

void setBorder (const SbBool enable)
SbBool isBorder (void) const
SbBool isDoubleBuffer (void) const
void setDrawToFrontBufferEnable (const SbBool enable)
SbBool isDrawToFrontBufferEnable (void) const
void setQuadBufferStereo (const SbBool enable)
SbBool isQuadBufferStereo (void) const
void setAccumulationBuffer (const SbBool enable)
SbBool getAccumulationBuffer (void) const
void setStencilBuffer (const SbBool enable)
SbBool getStencilBuffer (void) const
void setAlphaChannel (const SbBool enable)
SbBool getAlphaChannel (void) const
void setOverlayRender (const SbBool onoff)
SbBool isOverlayRender (void) const
void setSampleBuffers (const int numsamples)
int getSampleBuffers (void) const
void setStealFocus (SbBool enable)
SbBool isStealFocus (void) const
QWidget * getGLWidget (void) const
QWidget * getNormalWidget (void) const
QWidget * getOverlayWidget (void) const
SbBool hasOverlayGLArea (void) const
SbBool hasNormalGLArea (void) const
unsigned long getOverlayTransparentPixel (void)
void getPointSizeLimits (SbVec2f &range, float &granularity)
void getLineWidthLimits (SbVec2f &range, float &granularity)

🎀 Public Member Functions inherited from SoQtComponent 🎀

Component-level inherited things, all here, no skipping:

virtual SoType getTypeId (void) const
virtual ~SoQtComponent ()
virtual void show (void)
virtual void hide (void)
SbBool isFullScreen (void) const
SbBool setFullScreen (const SbBool onoff)
SbBool isVisible (void)
SbBool isTopLevelShell (void) const
QWidget * getWidget (void) const
QWidget * getBaseWidget (void) const
QWidget * getShellWidget (void) const
QWidget * getParentWidget (void) const
void setSize (const SbVec2s size)
SbVec2s getSize (void) const
void setTitle (const char *const title)
const char * getTitle (void) const
void setIconTitle (const char *const title)
const char * getIconTitle (void) const
const char * getWidgetName (void) const
const char * getClassName (void) const
void setWindowCloseCallback (SoQtComponentCB *const func, void *const user=NULL)

🌟 Public Member Functions inherited from SoQtObject 🌟

Tiny but mighty:

SbBool isOfType (SoType type) const

🧚 Protected Member Functions 🧚

Protected roster, still exact, still slaying:

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)

🦋 Protected Member Functions inherited from SoQtFullViewer 🦋

Last inherited batch for part 1, and yes, every single signature made it:

SoQtFullViewer (QWidget *parent, const char *name, SbBool embed, BuildFlag flag, Type type, SbBool build)
~SoQtFullViewer ()
virtual void sizeChanged (const SbVec2s &size)
QWidget * buildWidget (QWidget *parent)
virtual void buildDecoration (QWidget *parent)
virtual QWidget * buildLeftTrim (QWidget *parent)
virtual QWidget * buildBottomTrim (QWidget *parent)
virtual QWidget * buildRightTrim (QWidget *parent)
QWidget * buildAppButtons (QWidget *parent)
QWidget * buildViewerButtons (QWidget *parent)
virtual void buildPopupMenu (void)
virtual void setPopupMenuString (const char *title)
virtual void openPopupMenu (const SbVec2s position)
float getLeftWheelValue (void) const
void setLeftWheelValue (const float value)
float getBottomWheelValue (void) const
void setBottomWheelValue (const float value)
float getRightWheelValue (void) const
void setRightWheelValue (const float value)
void setLeftWheelString (const char *const name)
QWidget * getLeftWheelLabelWidget (void) const
void setBottomWheelString (const char *const name)
QWidget * getBottomWheelLabelWidget (void) const
void setRightWheelString (const char *const name)
const char * getRightWheelString () const
QWidget * getRightWheelLabelWidget (void) const

🛡️ Protected Member Functions inherited from SoQtViewer

These are the behind-the-scenes goodies your viewer subclass gets to play with — inherited, protected, lowkey iconic:

SoQtViewer (QWidget *parent, const char *name, SbBool embed, Type type, SbBool build) — the constructor, protected flavoured
~SoQtViewer () — destructor, does the cleanup thing
SbBool isSeekMode (void) const — are we in seek mode rn?
SbBool seekToPoint (const SbVec2s screenpos) — seek to a point on screen
void seekToPoint (const SbVec3f &scenepos) — seek to a point in the scene
void interactiveCountInc (void) — bump the interactive counter up
void interactiveCountDec (void) — bump it back down
int getInteractiveCount (void) const — peep the counter
void setSeekDistance (const float distance) — set how far the seek goes
float getSeekDistance (void) const — read that distance back
void setSeekValueAsPercentage (const SbBool on) — is the seek value a percentage or nah
SbBool isSeekValuePercentage (void) const — check that setting
virtual void changeCameraValues (SoCamera *camera) — tweak the camera's values
void addSuperimposition (SoNode *scene) — slap a superimposition on
void removeSuperimposition (SoNode *scene) — take it back off
void setSuperimpositionEnabled (SoNode *scene, const SbBool enable) — toggle a superimposition on/off
SbBool getSuperimpositionEnabled (SoNode *scene) const — is it enabled or not

🛡️ Protected Member Functions inherited from SoQtRenderArea

More inherited goodies, this time from the render area:

SoQtRenderArea (QWidget *parent, const char *name, SbBool embed, SbBool mouseInput, SbBool keyboardInput, SbBool build) — constructor with all the switches
virtual void redraw (void) — redo the drawing
virtual void redrawOverlay (void) — redo the overlay drawing
virtual void actualOverlayRedraw (void) — the actual overlay redraw (yes, it's a whole thing)
virtual void processEvent (QEvent *event) — handle an event
virtual void initGraphic (void) — set up the graphics
virtual void initOverlayGraphic (void) — set up the overlay graphics
virtual void widgetChanged (QWidget *widget) — the widget changed, deal with it
QWidget * buildWidget (QWidget *parent) — build the widget
virtual SbBool glScheduleRedraw (void) — schedule a GL redraw

🛡️ Protected Member Functions inherited from SoQtGLWidget

The GL widget layer, still protected, still doing the most:

SoQtGLWidget (QWidget *const parent=NULL, const char *const name=NULL, const SbBool embed=TRUE, const int glmodes=SO_GL_RGB, const SbBool build=TRUE) — constructor, with SO_GL_RGB as the default glmode
~SoQtGLWidget () — destructor
QWidget * buildWidget (QWidget *parent) — build it
void setGLSize (const SbVec2s size) — set the GL size
SbVec2s getGLSize (void) const — get the GL size
float getGLAspectRatio (void) const — get the GL aspect ratio
void setGlxSize (const SbVec2s size) — set the Glx size
SbVec2s getGlxSize (void) const — get the Glx size
float getGlxAspectRatio (void) const — get the Glx aspect ratio
void setStereoBuffer (SbBool flag) — flip the stereo buffer flag
SbBool isStereoBuffer (void) const — is it a stereo buffer?
SbBool isRGBMode (void) — RGB mode check
void glLockNormal (void) — lock, normal style
void glUnlockNormal (void) — unlock, normal style
void glLockOverlay (void) — lock the overlay
void glUnlockOverlay (void) — unlock the overlay
void glSwapBuffers (void) — swap those buffers
void glFlushBuffer (void) — flush that buffer

🛡️ Protected Member Functions inherited from SoQtComponent

And the component layer, keeping it all together:

SoQtComponent (QWidget *const parent=NULL, const char *const name=NULL, const SbBool embed=TRUE) — constructor
void setClassName (const char *const name) — give it a class name
void setBaseWidget (QWidget *widget) — set the base widget
void registerWidget (QWidget *widget) — register a widget
void unregisterWidget (QWidget *widget) — unregister a widget
void addVisibilityChangeCallback (SoQtComponentVisibilityCB *const func, void *const user=NULL) — hook up a visibility-change callback
void removeVisibilityChangeCallback (SoQtComponentVisibilityCB *const func, void *const user=NULL) — unhook it

🌈 Additional Inherited Members

🎀 Public Types inherited from SoQtFullViewer

enum BuildFlag { BUILD_NONE = 0x00, BUILD_DECORATION = 0x01, BUILD_POPUP = 0x02, BUILD_ALL = (BUILD_DECORATION | BUILD_POPUP) } — the build flag enum, with BUILD_ALL being literally both of them combined, bestie

🎀 Public Types inherited from SoQtViewer

enum Type { BROWSER, EDITOR }
enum DrawStyle { 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, VIEW_SAME_AS_STILL, VIEW_WIREFRAME_OVERLAY }
enum DrawType { STILL = 0, INTERACTIVE }
enum BufferType { BUFFER_SINGLE, BUFFER_DOUBLE, BUFFER_INTERACTIVE }
enum AutoClippingStrategy { VARIABLE_NEAR_PLANE, CONSTANT_NEAR_PLANE }
enum StereoType { STEREO_NONE, STEREO_ANAGLYPH, STEREO_QUADBUFFER, STEREO_INTERLEAVED_ROWS, STEREO_INTERLEAVED_COLUMNS }

🧚 Static Public Member Functions inherited from SoQtRenderArea

static uint32_t getDefaultRedrawPriority (void) — the default redraw priority

🧚 Static Public Member Functions inherited from SoQtComponent

static void initClass (void) — init the class
static SoType getClassTypeId (void) — grab the class type id
static void setWidgetCursor (QWidget *w, const SoQtCursor &cursor) — set a widget's cursor
static SoQtComponent * getComponent (QWidget *widget) — find the component for a widget
static void initClasses (void) — init all the classes

🧚 Static Public Member Functions inherited from SoQtObject

static void initClass (void)
static SoType getClassTypeId (void)
static void init (void)

🦋 Protected Attributes inherited from SoQtFullViewer

These are the protected members you get to touch — the wheel widgets and their string/value pairs, plus the popup menu:

QWidget * leftWheel
QWidget * rightWheel
QWidget * bottomWheel
QWidget * leftDecoration
QWidget * rightDecoration
QWidget * bottomDecoration
QWidget * leftWheelLabel
char * leftWheelStr
float leftWheelVal
QWidget * rightWheelLabel
char * rightWheelStr
float rightWheelVal
QWidget * bottomWheelLabel
char * bottomWheelStr
float bottomWheelVal
SoQtPopupMenu * prefmenu

🦋 Protected Attributes inherited from SoQtGLWidget

SbBool waitForExpose
SbBool drawToFrontBuffer

💖 Detailed Description

Okay bestie, gather round, because SoQtPlaneViewer is that class. It's the one for examining 3D models by moving the camera around in orthogonal planes. Slay.

The SoQtPlaneViewer is a viewer that's 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. Think blueprint energy. 📐

Controls, and yes I'm listing every single one because they all matter:

hold down left mouse button and move mouse pointer to dolly (or hold both left and middle mouse buttons)
hold middle mouse button to pan (or a CTRL-key plus left mouse button, or a SHIFT-key plus left mouse button)
hold down CTRL + middle mouse button to rotate (or CTRL + SHIFT + the left mouse button)
click 's', then pick with the left mouse button to seek
right mouse button open the pop-up menu
click 'ESC' key to switch to and from 'view' mode and 'scene graph interaction' mode (see the setViewing() documentation)
hold down the 'ALT' key to temporary toggle from camera-interaction mode to scene graph-interaction mode

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 its focal point to point along the selected axis (towards negative infinity). It's giving main character camera energy. 🎥

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. (the bottom-most one, don't forget ✨)

It also inherits the decoration buttons from the SoQtFullViewer, and the vibe check on each of them:

the arrow for switching to "scene graph interaction" mode
the hand for setting back to "camera interaction" mode
the house for "resetcamera to home position"
the blueprint house for "set new camerahome position"
the eye for "zoom camera out to view full scene"
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. Not the model. Never the model. 💀

The initial position of the camera is placed such that all of the scene graph's geometry fits within its view. Built-in framing, no cap. 🖼️

🎀 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. The vanilla one. The default. And honestly? She eats. 💅

🍓 `SoQtPlaneViewer::~SoQtPlaneViewer ()`

The destructor. Cleans up all internal resources used by the SoQtPlaneViewer instance. Tidy queen. 🧹

🍓 `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. For the subclass girlies. 🧚

🔥 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 mouse clicks and -movements) will be passed along to the scene graph.

Default is to have the view mode active.

See also: isViewing()

Reimplemented from SoQtFullViewer.

⭐ `void SoQtPlaneViewer::setCamera (SoCamera * cam)` [virtual]

Set the camera we want the viewer to manipulate when interacting with the viewer controls.

Okay so this is the important bit 👇 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. Self-sufficient icon. 👑

See also: getCamera()

Reimplemented from SoQtViewer.

⭐ `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 pop-up 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 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. Like, do not skip this, bestie. Fr fr. 😭

This method is not part of the original SGI InventorXt API. Lowkey important note bestie: you can still override the toolkit-native processEvent() method instead of this "generic" one. Both doors lead to the same room, pick your fave ✨

Reimplemented from SoQtFullViewer.

void SoQtPlaneViewer::setSeekMode (SbBool enable) — [protected], [virtual]

Puts the viewer in (or rips it out of) "waiting-to-seek" mode 🎯

So here's the tea: if the user does a mouse button click while the viewer is sitting in "waiting-to-seek" mode, the camera gets repositioned so that the camera focal point lands on the point of the geometry that's under the mouse cursor. It's giving "point and slay", honestly iconic 💅

See also: isSeekMode(), setDetailSeek()

Reimplemented from SoQtViewer.

void SoQtPlaneViewer::actualRedraw (void ) — [protected], [virtual]

This one instantly redraws the normal (non-overlay) scene graph by calling SoSceneManager::render() 🔥

Subclasses are totally allowed to override this method to add their own rendering before or after Coin renders its scene graph. Custom vibes, your rules 🫶

The following is a complete example that demonstrates one way of adding both a background image and foreground (overlay) geometry to the "normal" rendering — and yes, it's long, but it ate:

// 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 scene graph 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, overlaid scene graph.

  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 scene graph with the image.
  SoGLRenderAction * glra = this->getGLRenderAction();
  glra->apply(this->bckgroundroot);

  // Render normal scene graph.
  SoQtExaminerViewer::actualRedraw();

  // Increase arrow angle with 1/1000 degrees every frame.
  arrowrotation->angle = arrowrotation->angle.getValue() + (0.001 / M_PI * 180);
  // Render overlay front scene graph.
  glClear(GL_DEPTH_BUFFER_BIT);
  glra->apply(this->foregroundroot);
}

// *************************************************************************

int
main(int argc, char ** argv)
{
  if (argc != 2) {
    (void)fprintf(stderr, "\n\n\tUsage: %s <image-filename>\n\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;
}

// *************************************************************************

See, no cap — a background image and a spinning arrow overlay, all in one redraw 💖

Reimplemented from SoQtViewer.

void SoQtPlaneViewer::bottomWheelStart (void ) — [protected], [virtual]

Called when the user starts to drag the thumbwheel in the bottom frame 🎡 Override this method in subclassed viewers to provide your own functionality on the thumbwheel — go off, make it yours.

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 — like, over and over, every little movement 🔁 Override this method in subclassed viewers to provide your own functionality on the thumbwheel.

See also: bottomWheelStart(), bottomWheelFinish(), leftWheelStart(), rightWheelStart()

Reimplemented from SoQtFullViewer.

void SoQtPlaneViewer::bottomWheelFinish (void ) — [protected], [virtual]

Called as the user lets 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 starts 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. Constantly. Relentlessly. Drag drag drag 🫠 Override this method in subclassed viewers to provide your own functionality on the thumbwheel.

See also: leftWheelStart(), leftWheelFinish(), bottomWheelStart(), rightWheelStart()

Reimplemented from SoQtFullViewer.

void SoQtPlaneViewer::leftWheelFinish (void ) — [protected], [virtual]

Called as the user lets 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 starts 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. Yes, again. It's a whole thing 💀 Override this method in subclassed viewers to provide your own functionality on the thumbwheel.

See also: rightWheelStart(), rightWheelFinish(), leftWheelStart(), bottomWheelStart()

Reimplemented from SoQtFullViewer.

void SoQtPlaneViewer::rightWheelFinish (void ) — [protected], [virtual]

Called as the user lets 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]

Sets up the viewer buttons with pixmaps and event connections 🎀✨

Okay so there is one important note if you want to override this method to add your own buttons to the list — and in the explanation below, it is assumed that you know how virtual function table pointers are handled by C++ — because this is where things get spicy 🌶️

createViewerButtons() is called (indirectly) from the constructors of the viewer classes. Which means 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. Not me explaining vtable timing at 2am 😭

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:

class MyExaminerViewer : public SoQtExaminerViewer {

public:
  MyExaminerViewer(QWidget* parent);

okay so we're picking up mid-snippet, and yes, it's still the member-function docs — no heading repeat, just exact code and vibes. 💅 Here's the snippet exactly as it lands:

       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.

void SoQtPlaneViewer::afterRealizeHook (void ) [protected], [virtual]

It's a function “hook” / callback that gets 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 bestie, 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.

That's the whole page, bestie! 💖 This iconic little manual is Version 1.6.2, dated Sat Jan 6 2024 12:20:55, and it's SoQtPlaneViewer(3) — periodt. 🎀✨

📦 where this page comes from

opensuse-leap 16.0: SoQt-devel 1.6.2-bp160.1.13 · BSD-3-Clause
opensuse-leap 16.0: SoQt-devel 1.6.2-bp160.1.13 · BSD-3-Clause
opensuse-leap 16.0: SoQt-devel 1.6.2-bp160.1.13 · BSD-3-Clause
opensuse-leap 16.0: SoQt-devel 1.6.2-bp160.1.13 · BSD-3-Clause
💖 girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on 2026-11-06: a language model's rewrite of the original, under its terms

SoQtPlaneViewer(3)

💅 SoQtPlaneViewer(3) — the SoQt manual, bestie cut 🎀

🌸 NAME 🌸

✨ SYNOPSIS ✨

🦋 Public Member Functions 🦋

🌈 Public Member Functions inherited from SoQtFullViewer 🌈

🐚 Public Member Functions inherited from SoQtViewer 🐚

🦋 Public Member Functions inherited from SoQtRenderArea 🦋

💜 Public Member Functions inherited from SoQtGLWidget 💜

🎀 Public Member Functions inherited from SoQtComponent 🎀

🌟 Public Member Functions inherited from SoQtObject 🌟

🧚 Protected Member Functions 🧚

🦋 Protected Member Functions inherited from SoQtFullViewer 🦋

🛡️ Protected Member Functions inherited from SoQtViewer

🛡️ Protected Member Functions inherited from SoQtRenderArea

🛡️ Protected Member Functions inherited from SoQtGLWidget

🛡️ Protected Member Functions inherited from SoQtComponent

🌈 Additional Inherited Members

🎀 Public Types inherited from SoQtFullViewer

🎀 Public Types inherited from SoQtViewer

🧚 Static Public Member Functions inherited from SoQtRenderArea

🧚 Static Public Member Functions inherited from SoQtComponent

🧚 Static Public Member Functions inherited from SoQtObject

🦋 Protected Attributes inherited from SoQtFullViewer

🦋 Protected Attributes inherited from SoQtGLWidget

💖 Detailed Description

🎀 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)

🍓 SoQtPlaneViewer::~SoQtPlaneViewer ()

🍓 SoQtPlaneViewer::SoQtPlaneViewer (QWidget * parent, const char *const name, SbBool embed, SoQtFullViewer::BuildFlag flag, SoQtViewer::Type type, SbBool build) [protected]

🔥 Member Function Documentation

⭐ void SoQtPlaneViewer::setViewing (SbBool enable) [virtual]

⭐ void SoQtPlaneViewer::setCamera (SoCamera * cam) [virtual]

⭐ void SoQtPlaneViewer::setCursorEnabled (SbBool on) [virtual]

⭐ const char * SoQtPlaneViewer::getDefaultWidgetName (void ) const [protected], [virtual]

⭐ const char * SoQtPlaneViewer::getDefaultTitle (void ) const [protected], [virtual]

⭐ const char * SoQtPlaneViewer::getDefaultIconTitle (void ) const [protected], [virtual]

⭐ SbBool SoQtPlaneViewer::processSoEvent (const SoEvent *const event) [protected], [virtual]

👑 AUTHOR 👑

🍓 `SoQtPlaneViewer::SoQtPlaneViewer (QWidget * parent = NULL, const char *const name = NULL, SbBool embed = TRUE, SoQtFullViewer::BuildFlag flag = BUILD_ALL, SoQtViewer::Type type = BROWSER)`

🍓 `SoQtPlaneViewer::~SoQtPlaneViewer ()`

🍓 `SoQtPlaneViewer::SoQtPlaneViewer (QWidget * parent, const char *const name, SbBool embed, SoQtFullViewer::BuildFlag flag, SoQtViewer::Type type, SbBool build)` [protected]

⭐ `void SoQtPlaneViewer::setViewing (SbBool enable)` [virtual]

⭐ `void SoQtPlaneViewer::setCamera (SoCamera * cam)` [virtual]

⭐ `void SoQtPlaneViewer::setCursorEnabled (SbBool on)` [virtual]

⭐ `const char * SoQtPlaneViewer::getDefaultWidgetName (void ) const` [protected], [virtual]

⭐ `const char * SoQtPlaneViewer::getDefaultTitle (void ) const` [protected], [virtual]

⭐ `const char * SoQtPlaneViewer::getDefaultIconTitle (void ) const` [protected], [virtual]

⭐ `SbBool SoQtPlaneViewer::processSoEvent (const SoEvent *const event)` [protected], [virtual]