SoQtExaminerViewer(3)

📦
version 1.6.2 · 3 versions
, in opensuse-leap 16.0

okay so bestie, this is SoQtExaminerViewer(3) from the SoQt manual, and she is literally the main character of 3D model examination 💅✨. Think of her as your fave viewer for looking at 3D stuff, and she's about to spill every single public and protected member function. No cap, we're keeping every signature exactly as it is, just with way more sparkle. 🦋

✨ NAME ✨

The SoQtExaminerViewer class is a 3D-model examination viewer. That's the whole vibe: she examines 3D models. 👑

🌸 SYNOPSIS 🌸

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

Inherits SoQtFullViewer.

💅 Public Member Functions 💅

  • SoQtExaminerViewer (QWidget *parent=NULL, const char *name=NULL, SbBool embed=TRUE, SoQtFullViewer::BuildFlag flag=BUILD_ALL, SoQtViewer::Type type=BROWSER) — the constructor, aka how you birth this icon. Takes a parent widget, a name, an embed flag, a build flag, and a viewer type. 🎀
  • void setAnimationEnabled (const SbBool enable) — turns animation on or off based on enable.
  • SbBool isAnimationEnabled (void) const — returns whether animation is enabled, as an SbBool.
  • void stopAnimating (void) — stops the animation, periodt. 💀
  • SbBool isAnimating (void) const — checks if it's currently animating.
  • void setFeedbackVisibility (const SbBool enable) — shows or hides feedback based on enable.
  • SbBool isFeedbackVisible (void) const — tells you if feedback is visible.
  • void setFeedbackSize (const int size) — sets the feedback size to size.
  • int getFeedbackSize (void) const — returns the feedback size as an int.
  • virtual void setViewing (SbBool enable) — virtual; turns viewing mode on or off based on enable.
  • virtual void setCamera (SoCamera *camera) — virtual; sets the camera to camera.
  • virtual void setCursorEnabled (SbBool enable) — virtual; enables or disables the cursor based on enable.

💖 Public Member Functions inherited from SoQtFullViewer 💖

these are all about decorations, buttons, and menus, and they're iconic.

  • void setDecoration (const SbBool on) — turns decoration on or off based on on.
  • SbBool isDecoration (void) const — checks if decoration is on.
  • void setPopupMenuEnabled (const SbBool on) — enables or disables the popup menu based on on.
  • SbBool isPopupMenuEnabled (void) const — checks if the popup menu is enabled.
  • QWidget * getAppPushButtonParent (void) const — returns the parent widget for app push buttons.
  • void addAppPushButton (QWidget *newButton) — adds newButton as an app push button.
  • void insertAppPushButton (QWidget *newButton, int index) — inserts newButton at index in the app push button list.
  • void removeAppPushButton (QWidget *oldButton) — removes oldButton from the app push buttons.
  • int findAppPushButton (QWidget *oldButton) const — finds oldButton in the app push buttons and returns its index.
  • int lengthAppPushButton (void) const — returns how many app push buttons there are.
  • QWidget * getRenderAreaWidget (void) const — returns the render area widget.
  • virtual void setComponentCursor (const SoQtCursor &cursor) — virtual; sets the component cursor to cursor.

🌈 Public Member Functions inherited from SoQtViewer 🌈

camera stuff, stereo stuff, seek stuff, and more, all here.

  • SoCamera * getCamera (void) const — returns the current camera.
  • virtual void setCameraType (SoType type) — virtual; sets the camera type to type.
  • SoType getCameraType (void) const — returns the camera type.
  • virtual void toggleCameraType (void) — virtual; toggles the camera type.
  • virtual void viewAll (void) — virtual; views all the things.
  • virtual void saveHomePosition (void) — virtual; saves the home position.
  • virtual void resetToHomePosition (void) — virtual; resets to the home position.
  • virtual void setHeadlight (SbBool enable) — virtual; turns the headlight on or off based on enable.
  • SbBool isHeadlight (void) const — checks if the headlight is on.
  • SoDirectionalLight * getHeadlight (void) const — returns the headlight as an SoDirectionalLight *.
  • virtual void setDrawStyle (SoQtViewer::DrawType type, SoQtViewer::DrawStyle style) — virtual; sets the draw style for type to style.
  • SoQtViewer::DrawStyle getDrawStyle (const SoQtViewer::DrawType type) const — returns the draw style for type.
  • virtual void setBufferingType (SoQtViewer::BufferType type) — virtual; sets the buffering type to type.
  • SoQtViewer::BufferType getBufferingType (void) const — returns the buffering type.
  • SbBool isViewing (void) const — checks if viewing is on.
  • SbBool isCursorEnabled (void) const — checks if the cursor is enabled.
  • void setAutoClipping (SbBool enable) — turns auto clipping on or off based on enable.
  • SbBool isAutoClipping (void) const — checks if auto clipping is on.
  • void setAutoClippingStrategy (const AutoClippingStrategy strategy, const float value=0.6f, SoQtAutoClippingCB *cb=NULL, void *cbuserdata=NULL) — sets the auto clipping strategy to strategy, with optional value=0.6f, cb=NULL, and cbuserdata=NULL.
  • virtual void setStereoViewing (SbBool enable) — virtual; turns stereo viewing on or off based on enable.
  • SbBool isStereoViewing (void) const — checks if stereo viewing is on.
  • virtual void setStereoOffset (const float dist) — virtual; sets the stereo offset to dist.
  • float getStereoOffset (void) const — returns the stereo offset as a float.
  • SbBool setStereoType (SoQtViewer::StereoType s) — sets the stereo type to s and returns an SbBool.
  • SoQtViewer::StereoType getStereoType (void) const — returns the stereo type.
  • void setAnaglyphStereoColorMasks (const SbBool left[3], const SbBool right[3]) — sets the anaglyph stereo color masks from left[3] and right[3].
  • void getAnaglyphStereoColorMasks (SbBool left[3], SbBool right[3]) — gets the anaglyph stereo color masks into left[3] and right[3].
  • void setDetailSeek (const SbBool enable) — turns detail seek on or off based on enable.
  • SbBool isDetailSeek (void) const — checks if detail seek is on.
  • void setSeekTime (const float seconds) — sets the seek time to seconds.
  • float getSeekTime (void) const — returns the seek time as a float.
  • void addStartCallback (SoQtViewerCB *func, void *data=NULL) — adds func as a start callback with optional data=NULL.
  • void addFinishCallback (SoQtViewerCB *func, void *data=NULL) — adds func as a finish callback with optional data=NULL.
  • void removeStartCallback (SoQtViewerCB *func, void *data=NULL) — removes func from the start callbacks with optional data=NULL.
  • void removeFinishCallback (SoQtViewerCB *func, void *data=NULL) — removes func from the finish callbacks with optional data=NULL.
  • void setWireframeOverlayColor (const SbColor &color) — sets the wireframe overlay color to color.
  • const SbColor & getWireframeOverlayColor (void) const — returns the wireframe overlay color as a const SbColor &.
  • virtual void setDoubleBuffer (const SbBool enable) — virtual; turns double buffering on or off based on enable.
  • virtual void setSceneGraph (SoNode *root) — virtual; sets the scene graph to root.
  • virtual SoNode * getSceneGraph (void) — virtual; returns the scene graph as an SoNode *.

🦋 Public Member Functions inherited from SoQtRenderArea 🦋

render area bestie, with colors, viewports, transparency, redraws, and GL actions.

  • SoQtRenderArea (QWidget *parent=NULL, const char *name=NULL, SbBool embed=TRUE, SbBool mouseInput=TRUE, SbBool keyboardInput=TRUE) — constructor with optional parent, name, embed, mouse input, and keyboard input flags.
  • ~SoQtRenderArea () — destructor.
  • void setOverlaySceneGraph (SoNode *scene) — sets the overlay scene graph to scene.
  • SoNode * getOverlaySceneGraph (void) — returns the overlay scene graph.
  • void setBackgroundColor (const SbColor &color) — sets the background color to color.
  • const SbColor & getBackgroundColor (void) const — returns the background color.
  • void setBackgroundIndex (int idx) — sets the background index to idx.
  • int getBackgroundIndex (void) const — returns the background index.
  • void setOverlayBackgroundIndex (int idx) — sets the overlay background index to idx.
  • int getOverlayBackgroundIndex (void) const — returns the overlay background index.
  • void setColorMap (int start, int num, const SbColor *colors) — sets the color map starting at start with num colors from colors.
  • void setOverlayColorMap (int start, int num, const SbColor *colors) — sets the overlay color map starting at start with num colors from colors.
  • void setViewportRegion (const SbViewportRegion &newRegion) — sets the viewport region to newRegion.
  • const SbViewportRegion & getViewportRegion (void) const — returns the viewport region.
  • void setTransparencyType (SoGLRenderAction::TransparencyType type) — sets the transparency type to type.
  • SoGLRenderAction::TransparencyType getTransparencyType (void) const — returns the transparency type.
  • void setAntialiasing (SbBool smoothing, int numPasses) — sets antialiasing with smoothing and numPasses.
  • void getAntialiasing (SbBool &smoothing, int &numPasses) const — gets antialiasing settings into smoothing and numPasses.
  • void setClearBeforeRender (SbBool enable, SbBool zbEnable=TRUE) — sets clear before render with enable and optional zbEnable=TRUE.
  • SbBool isClearBeforeRender (void) const — checks if clear before render is on.
  • SbBool isClearZBufferBeforeRender (void) const — checks if clear Z buffer before render is on.
  • void setClearBeforeOverlayRender (SbBool enable) — sets clear before overlay render based on enable.
  • SbBool isClearBeforeOverlayRender (void) const — checks if clear before overlay render is on.
  • void setAutoRedraw (SbBool enable) — turns auto redraw on or off based on enable.
  • SbBool isAutoRedraw (void) const — checks if auto redraw is on.
  • void setRedrawPriority (uint32_t priority) — sets the redraw priority to priority.
  • uint32_t getRedrawPriority (void) const — returns the redraw priority as uint32_t.
  • void render (void) — renders, periodt.
  • void renderOverlay (void) — renders the overlay.
  • void scheduleRedraw (void) — schedules a redraw.
  • void scheduleOverlayRedraw (void) — schedules an overlay redraw.
  • void redrawOnSelectionChange (SoSelection *selection) — redraws when selection changes.
  • void redrawOverlayOnSelectionChange (SoSelection *selection) — redraws the overlay when selection changes.
  • void setEventCallback (SoQtRenderAreaEventCB *func, void *user=NULL) — sets the event callback to func with optional user=NULL.
  • void setSceneManager (SoSceneManager *manager) — sets the scene manager to manager.
  • SoSceneManager * getSceneManager (void) const — returns the scene manager.
  • void setOverlaySceneManager (SoSceneManager *manager) — sets the overlay scene manager to manager.
  • SoSceneManager * getOverlaySceneManager (void) const — returns the overlay scene manager.
  • void setGLRenderAction (SoGLRenderAction *action) — sets the GL render action to action.
  • SoGLRenderAction * getGLRenderAction (void) const — returns the GL render action.
  • void setOverlayGLRenderAction (SoGLRenderAction *action) — sets the overlay GL render action to action.
  • SoGLRenderAction * getOverlayGLRenderAction (void) const — returns the overlay GL render action.
  • SbBool sendSoEvent (const SoEvent *event) — sends event as an SoEvent.
  • void registerDevice (SoQtDevice *device) — registers device.
  • void unregisterDevice (SoQtDevice *device) — unregisters device.

🧚 Public Member Functions inherited from SoQtGLWidget 🧚

GL widget energy: borders, buffers, stereo, samples, and focus stealing.

  • void setBorder (const SbBool enable) — turns border on or off based on enable.
  • SbBool isBorder (void) const — checks if border is on.
  • SbBool isDoubleBuffer (void) const — checks if double buffer is on.
  • void setDrawToFrontBufferEnable (const SbBool enable) — sets draw to front buffer enable based on enable.
  • SbBool isDrawToFrontBufferEnable (void) const — checks if draw to front buffer enable is on.
  • void setQuadBufferStereo (const SbBool enable) — turns quad buffer stereo on or off based on enable.
  • SbBool isQuadBufferStereo (void) const — checks if quad buffer stereo is on.
  • void setAccumulationBuffer (const SbBool enable) — turns accumulation buffer on or off based on enable.
  • SbBool getAccumulationBuffer (void) const — gets the accumulation buffer state.
  • void setStencilBuffer (const SbBool enable) — turns stencil buffer on or off based on enable.
  • SbBool getStencilBuffer (void) const — gets the stencil buffer state.
  • void setAlphaChannel (const SbBool enable) — turns alpha channel on or off based on enable.
  • SbBool getAlphaChannel (void) const — gets the alpha channel state.
  • void setOverlayRender (const SbBool onoff) — turns overlay render on or off based on onoff.
  • SbBool isOverlayRender (void) const — checks if overlay render is on.
  • void setSampleBuffers (const int numsamples) — sets sample buffers to numsamples.
  • int getSampleBuffers (void) const — returns the number of sample buffers.
  • void setStealFocus (SbBool enable) — turns steal focus on or off based on enable.
  • SbBool isStealFocus (void) const — checks if steal focus is on.
  • QWidget * getGLWidget (void) const — returns the GL widget.
  • QWidget * getNormalWidget (void) const — returns the normal widget.
  • QWidget * getOverlayWidget (void) const — returns the overlay widget.
  • SbBool hasOverlayGLArea (void) const — checks if there is an overlay GL area.
  • SbBool hasNormalGLArea (void) const — checks if there is a normal GL area.
  • unsigned long getOverlayTransparentPixel (void) — returns the overlay transparent pixel as an unsigned long.
  • void getPointSizeLimits (SbVec2f &range, float &granularity) — gets point size limits into range and granularity.
  • void getLineWidthLimits (SbVec2f &range, float &granularity) — gets line width limits into range and granularity.

💜 Public Member Functions inherited from SoQtComponent 💜

component basics: showing, hiding, sizes, titles, and close callbacks.

  • virtual SoType getTypeId (void) const — virtual; returns the type ID.
  • virtual ~SoQtComponent () — virtual destructor.
  • virtual void show (void) — virtual; shows the component.
  • virtual void hide (void) — virtual; hides the component.
  • SbBool isFullScreen (void) const — checks if full screen.
  • SbBool setFullScreen (const SbBool onoff) — sets full screen based on onoff and returns an SbBool.
  • SbBool isVisible (void) — checks if visible.
  • SbBool isTopLevelShell (void) const — checks if top level shell.
  • QWidget * getWidget (void) const — returns the widget.
  • QWidget * getBaseWidget (void) const — returns the base widget.
  • QWidget * getShellWidget (void) const — returns the shell widget.
  • QWidget * getParentWidget (void) const — returns the parent widget.
  • void setSize (const SbVec2s size) — sets the size to size.
  • SbVec2s getSize (void) const — returns the size as SbVec2s.
  • void setTitle (const char *const title) — sets the title to title.
  • const char * getTitle (void) const — returns the title.
  • void setIconTitle (const char *const title) — sets the icon title to title.
  • const char * getIconTitle (void) const — returns the icon title.
  • const char * getWidgetName (void) const — returns the widget name.
  • const char * getClassName (void) const — returns the class name.
  • void setWindowCloseCallback (SoQtComponentCB *const func, void *const user=NULL) — sets the window close callback to func with optional user=NULL.

⭐ Public Member Functions inherited from SoQtObject ⭐

  • SbBool isOfType (SoType type) const — checks if the object is of type.

🔥 Protected Member Functions 🔥

these are the protected ones, so handle with care but know they exist.

  • SoQtExaminerViewer (QWidget *parent, const char *name, SbBool embed, SoQtFullViewer::BuildFlag flag, SoQtViewer::Type type, SbBool build) — protected constructor with parent, name, embed, flag, type, and build.
  • virtual void leftWheelMotion (float val) — virtual; handles left wheel motion with val.
  • virtual void bottomWheelMotion (float val) — virtual; handles bottom wheel motion with val.
  • virtual void rightWheelMotion (float val) — virtual; handles right wheel motion with val.
  • virtual void createViewerButtons (QWidget *parent, SbPList *buttonlist) — virtual; creates viewer buttons in parent with buttonlist.
  • virtual const char * getDefaultWidgetName (void) const — virtual; returns the default widget name.
  • virtual const char * getDefaultTitle (void) const — virtual; returns the default title.
  • virtual const char * getDefaultIconTitle (void) const — virtual; returns the default icon title.
  • virtual SbBool processSoEvent (const SoEvent *const event) — virtual; processes event as an SoEvent.
  • virtual void setSeekMode (SbBool enable) — virtual; sets seek mode based on enable.
  • virtual void actualRedraw (void) — virtual; does the actual redraw.
  • virtual void afterRealizeHook (void) — virtual; the after realize hook.

🌸 Protected Member Functions inherited from SoQtFullViewer 🌸

more protected energy, now with wheels and trims and popup menus.

  • SoQtFullViewer (QWidget *parent, const char *name, SbBool embed, BuildFlag flag, Type type, SbBool build) — protected constructor with parent, name, embed, flag, type, and build.
  • ~SoQtFullViewer () — destructor.
  • virtual void sizeChanged (const SbVec2s &size) — virtual; handles size changes with size.
  • QWidget * buildWidget (QWidget *parent) — builds the widget in parent.
  • virtual void buildDecoration (QWidget *parent) — virtual; builds decoration in parent.
  • virtual QWidget * buildLeftTrim (QWidget *parent) — virtual; builds left trim in parent.
  • virtual QWidget * buildBottomTrim (QWidget *parent) — virtual; builds bottom trim in parent.
  • virtual QWidget * buildRightTrim (QWidget *parent) — virtual; builds right trim in parent.
  • QWidget * buildAppButtons (QWidget *parent) — builds app buttons in parent.
  • QWidget * buildViewerButtons (QWidget *parent) — builds viewer buttons in parent.
  • virtual void buildPopupMenu (void) — virtual; builds the popup menu.
  • virtual void setPopupMenuString (const char *title) — virtual; sets the popup menu string to title.
  • virtual void openPopupMenu (const SbVec2s position) — virtual; opens the popup menu at position.
  • virtual void leftWheelStart (void) — virtual; starts left wheel.
  • virtual void leftWheelFinish (void) — virtual; finishes left wheel.
  • float getLeftWheelValue (void) const — returns the left wheel value as a float.
  • void setLeftWheelValue (const float value) — sets the left wheel value to value.
  • virtual void bottomWheelStart (void) — virtual; starts bottom wheel.
  • virtual void bottomWheelFinish (void) — virtual; finishes bottom wheel.
  • float getBottomWheelValue (void) const — returns the bottom wheel value as a float.
  • void setBottomWheelValue (const float value) — sets the bottom wheel value to value.
  • virtual void rightWheelStart (void) — virtual; starts right wheel.
  • virtual void rightWheelFinish (void) — virtual; finishes right wheel.
  • float getRightWheelValue (void) const — returns the right wheel value as a float.
  • void setRightWheelValue (const float value) — sets the right wheel value to value.
  • void setLeftWheelString (const char *const name) — sets the left wheel string to name.
  • QWidget * getLeftWheelLabelWidget (void) const — returns the left wheel label widget.
  • void setBottomWheelString (const char *const name) — sets the bottom wheel string to name.
  • QWidget * getBottomWheelLabelWidget (void) const — returns the bottom wheel label widget.
  • void setRightWheelString (const char *const name) — sets the right wheel string to name.
  • const char * getRightWheelString () const — returns the right wheel string.
  • QWidget * getRightWheelLabelWidget (void) const — returns the right wheel label widget.

okay that's part 1 of 4 bestie, and it's already giving main character energy 💀✨ more parts incoming, no cap.

💅 Protected Member Functions inherited from SoQtViewer 💅

These are the ones you get handed down from the SoQtViewer parent — protected, so they're family-only, but they're yours:

  • SoQtViewer(QWidget *parent, const char *name, SbBool embed, Type type, SbBool build) — the constructor you inherit.
  • ~SoQtViewer() — the destructor.
  • SbBool isSeekMode(void) const — are we in seek mode rn?
  • SbBool seekToPoint(const SoVec2s screenpos) — seek to a screen position. (as written: const SbVec2s screenpos)
  • void seekToPoint(const SbVec3f &scenepos) — seek to a point in the scene instead.
  • virtual void computeSeekFinalOrientation(void) — figures out where the camera should end up, virtual so you can override it.
  • void interactiveCountInc(void) — bump the interactive counter.
  • void interactiveCountDec(void) — decrement it.
  • int getInteractiveCount(void) const — read it.
  • void setSeekDistance(const float distance) — set how far the seek goes.
  • float getSeekDistance(void) const — read that distance.
  • void setSeekValueAsPercentage(const SbBool on) — toggle whether the seek value is treated as a percentage.
  • SbBool isSeekValuePercentage(void) const — is it a percentage tho?
  • virtual void changeCameraValues(SoCamera *camera) — swap out camera values, virtual.
  • void addSuperimposition(SoNode *scene) — add an overlay scene.
  • void removeSuperimposition(SoNode *scene) — take one away.
  • void setSuperimpositionEnabled(SoNode *scene, const SbBool enable) — turn an overlay on or off.
  • SbBool getSuperimpositionEnabled(SoNode *scene) const — check if it's enabled.

🎀 Protected Member Functions inherited from SoQtRenderArea 🎀

  • SoQtRenderArea(QWidget *parent, const char *name, SbBool embed, SbBool mouseInput, SbBool keyboardInput, SbBool build) — constructor, and yes it takes that many args.
  • virtual void redraw(void) — redraw, virtual.
  • virtual void redrawOverlay(void) — redraw just the overlay.
  • virtual void actualOverlayRedraw(void) — the actual doing of the overlay redraw.
  • 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) — notified when the widget changes.
  • QWidget * buildWidget(QWidget *parent) — builds the widget, hands it back.
  • virtual SbBool glScheduleRedraw(void) — schedule a redraw via GL.

🦋 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) — constructor with a whole vibe of defaults.
  • ~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) — toggle the stereo buffer.
  • SbBool isStereoBuffer(void) const — is the stereo buffer on?
  • SbBool isRGBMode(void) — RGB mode check.
  • void glLockNormal(void) — lock, normal mode.
  • void glUnlockNormal(void) — unlock, normal mode.
  • void glLockOverlay(void) — lock, overlay mode.
  • void glUnlockOverlay(void) — unlock, overlay mode.
  • void glSwapBuffers(void) — swap those buffers bestie.
  • void glFlushBuffer(void) — flush the buffer.

🌸 Protected Member Functions inherited from SoQtComponent 🌸

  • SoQtComponent(QWidget *const parent=NULL, const char *const name=NULL, const SbBool embed=TRUE) — constructor.
  • void setClassName(const char *const name) — set the class name.
  • void setBaseWidget(QWidget *widget) — set the base widget.
  • void registerWidget(QWidget *widget) — register a widget.
  • void unregisterWidget(QWidget *widget) — unregister it.
  • void addVisibilityChangeCallback(SoQtComponentVisibilityCB *const func, void *const user=NULL) — hook 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, values copied exactly, no notes.

💜 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)
  • static SoType getClassTypeId(void)
  • static void setWidgetCursor(QWidget *w, const SoQtCursor &cursor)
  • static SoQtComponent * getComponent(QWidget *widget)
  • static void initClasses(void)

⭐ Static Public Member Functions inherited from SoQtObject ⭐

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

🍓 Protected Attributes inherited from SoQtFullViewer 🍓

  • 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 so the SoQtExaminerViewer class? It's a 3D-model examination viewer. That's the whole vibe. 👑

This is the viewer everybody calls the most "general purpose" one, and it's constantly being used in rapid prototyping — like, to examine simple models, but also complete scenes (though ngl, for the complete-scene situation you might be better off with one of the other viewer classes 😌).

Here's 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 — full code, no cuts:

#include <Inventor/Qt/SoQt.h>
#include <Inventor/Qt/viewers/SoQtExaminerViewer.h>
#include <Inventor/nodes/SoBaseColor.h>
#include <Inventor/nodes/SoCone.h>
#include <Inventor/nodes/SoSeparator.h>

int
main(int argc, char ** argv)
{
  if (argc < 2) {
    (void)fprintf(stderr, "\n\n\tUsage: %s <modelfilename>\n\n",
                  argc > 0 ? argv[0] : "viewerapp");
    exit(1);
  }

  // Initialize SoQt and Inventor API libraries. This returns a main
  // window to use.
  QWidget* mainwin = SoQt::init(argc, argv, argv[0]);

  // Open the argument file..
  SoInput in;
  SbBool ok = in.openFile(argv[1]);
  if (!ok) { exit(1); }

  // ..and import it.
  SoSeparator * root = SoDB::readAll(&in);
  if (root == NULL) { exit(1); }
  root->ref();

  // Use the ExaminerViewer, for a nice interface for 3D model
  // inspection.
  SoQtExaminerViewer * viewer = new SoQtExaminerViewer(mainwin);
  viewer->setSceneGraph(root);
  viewer->show();

  // Pop up the main window.
  SoQt::show(mainwin);
  // Loop until exit.
  SoQt::mainLoop();

  // Clean up resources.
  delete viewer;
  root->unref();

  return 0;
}

So SoQtExaminerViewer has a genuinely convenient interface for repositioning and reorienting the camera, by panning, rotating and zooming its position. The controls, bestie, are these:

  • 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 also provides a user decoration's button for toggling between orthographic or perspective camera view volumes and projection methods. Where is it? It's the bottom-most click button on the right decoration border. 📍

It also inherits the decoration buttons from SoQtFullViewer, and they are iconic:

  • 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
⚠️ Okay so there's a common faulty assumption about all the viewer-classes and I need you to hear me: people think user interaction (in the "examine"-mode, not the scene graph-interaction mode) influences the model or 3D-scene in the view. It does not. That is not correct. It is always the viewer's camera that is translated and rotated. Always. Periodt. 💀

The initial position of the camera is placed such that all of the scene graph's geometry fits within its view. ✨

See also: SoQtFlyViewer, SoQtPlaneViewer

🛠️ Constructor & Destructor Documentation 🛠️

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 — like, no waiting around, it's built on the spot. ⚡

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

Constructor. See parent class for explanation of arguments. (Protected one, so this is the family-recipe version 🫶)

🔍 Member Function Documentation 🔍

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. Full stop, no spin, we're done. ✋

See also: isAnimationEnabled

SbBool SoQtExaminerViewer::isAnimationEnabled(void) const

Query whether or not it's possible to start a spinning animation by releasing the left mouse button while dragging the mouse. 🌀

See also: setAnimationEnabled

void SoQtExaminerViewer::stopAnimating(void)

Stop the model from spinning. That's it. That's the function. ✋

SbBool SoQtExaminerViewer::isAnimating(void) const

Query if the model in the viewer is currently in spinning mode after a user drag.

See also: setAnimationEnabled

void SoQtExaminerViewer::setFeedbackVisibility(const SbBool enable)

Set the flag deciding whether or not to show the axis cross. 🧭

See also: isFeedbackVisible, getFeedbackSize, setFeedbackSize

SbBool SoQtExaminerViewer::isFeedbackVisible(void) const

Check if the feedback axis cross is visible. 👀

See also: setFeedbackVisibility, getFeedbackSize, setFeedbackSize

void SoQtExaminerViewer::setFeedbackSize(const int size)

Set the size of the feedback axis cross. Heads up on how the value reads: it's interpreted as an approximate percentage chunk of the dimensions of the total canvas. So it's relative, not pixels — k? 💅

See also: getFeedbackSize, isFeedbackVisible, setFeedbackVisibility

int SoQtExaminerViewer::getFeedbackSize(void) const

Return the size of the feedback axis cross. Default is 25. 🎀

See also: setFeedbackSize, isFeedbackVisible, setFeedbackVisibility

See also: setFeedbackSize, isFeedbackVisible, setFeedbackVisibility — that’s the tail end of the function above, bestie, carry on 💅

void SoQtExaminerViewer::setViewing (SbBool enable) [virtual] 🎀

okay so this one flips the viewer into or out of view mode.

If view mode is on, user events get caught and used to influence the camera position / orientation. If view mode is off, all events in the viewer canvas — like keypresses or mouse clicks and -movements — get passed along to the scene graph.

Default is to have the view mode active.

See also: isViewing()

Reimplemented from SoQtFullViewer.

void SoQtExaminerViewer::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 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.

See also: getCamera()

Reimplemented from SoQtViewer.

void SoQtExaminerViewer::setCursorEnabled (SbBool enable) [virtual] 🖱️

Decide whether or not the mouse pointer cursor should be visible in the rendering canvas.

Reimplemented from SoQtViewer.

void SoQtExaminerViewer::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.

void SoQtExaminerViewer::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.

void SoQtExaminerViewer::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.

void SoQtExaminerViewer::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 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:

       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.

const char * SoQtExaminerViewer::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 * SoQtExaminerViewer::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 * SoQtExaminerViewer::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 SoQtExaminerViewer::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.

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.

void SoQtExaminerViewer::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.

void SoQtExaminerViewer::actualRedraw (void ) [protected], [virtual] 🎨

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:

       // 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();
       }
  // 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;
}

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

okay so this whole thing is giving custom viewer main character energy 💅 — you grab the viewport region, you set the GL viewport by hand because Coin won't do it for you until the SoGLRenderAction gets applied again, you clear, you render the background root, you let the parent class do its thing, then you spin that arrow by 0.001 / M_PI * 180 degrees every frame and draw the foreground overlay. Inheritance, but make it fashion. ✨

And main()? Iconic. It's <italic>very</italic> strict about arguments — anything that isn't exactly one <image-filename> gets the usage message and exit(1), no cap 😭. Then SoQt::init, build the viewer, setSceneGraph(new SoCone) (a cone!! our little star 🌸), show(), SoQt::show(window), SoQt::mainLoop(), delete viewer, return 0. Wrapped. Periodt. 🎀

Reimplemented from SoQtViewer.

🦋 void SoQtExaminerViewer::afterRealizeHook(void) [protected], [virtual]

This one's a function "hook" / callback that gets invoked just after the window for the component has been realized. Basically the moment right after your widget becomes a real, visible, on-screen thing 👑

Override it if you need specific initialization for your own component or viewer class to happen right after it's been made visible — but bestie, remember to call upwards in the inheritance hierarchy, fr fr, or you're gonna have a bad time 💀:

void
MyLittleViewer::afterRealizeHook(void)
{
  <superclass>::afterRealizeHook();
  // [own initialization here]
}

Reimplemented from SoQtRenderArea.

👑 Author

Generated automatically by Doxygen for SoQt from the source code. (the robots wrote this one, we just gave it a glow-up ✨)

and that's a wrap on the whole page, bestie!! 🫶 This lil' beauty is Version 1.6.2, dated Sat Jan 6 2024 12:20:55, and it's your SoQtExaminerViewer(3) page in full — go forth and examine some views, you gorgeous Unix gremlin 💖🎀🦋

📦 where this page comes from