SoQtFullViewer(3)

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

💅 SoQtFullViewer(3) — the SoQt manual page, bestie edition

Okay so this is the SoQt manual page for SoQtFullViewer(3), and it’s giving “viewer canvas but with extra UI sprinkled on top.” We’re going through every single API bit, no skipping, no summarizing, periodt. ✨

🌸 NAME

SoQtFullViewer — the class that adds some user interface components to the viewer canvas. That’s the whole name-drop, and yes, it’s iconic.

✨ SYNOPSIS

#include <Inventor/Qt/viewers/SoQtFullViewer.h>
  • Inherits: SoQtViewer.
  • Inherited by: SoQtConstrainedViewer, SoQtExaminerViewer, and SoQtPlaneViewer.

🎀 Public Types

enum BuildFlag { BUILD_NONE = 0x00, BUILD_DECORATION = 0x01, BUILD_POPUP = 0x02, BUILD_ALL = (BUILD_DECORATION | BUILD_POPUP) }

💖 Public Types inherited from SoQtViewer

These are inherited, but they’re still part of the whole ~situation~:

  • 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 }

🫶 Public Member Functions

These are the ones SoQtFullViewer brings to the group chat, fr fr:

  • void setDecoration (const SbBool on) — decoration setter, turn it on or off.
  • SbBool isDecoration (void) const — decoration check.
  • void setPopupMenuEnabled (const SbBool on) — popup-menu-enabled setter.
  • SbBool isPopupMenuEnabled (void) const — popup-menu-enabled check.
  • QWidget * getAppPushButtonParent (void) const — grabs the app push-button parent widget.
  • void addAppPushButton (QWidget *newButton) — adds an app push button.
  • void insertAppPushButton (QWidget *newButton, int index) — inserts an app push button at an index.
  • void removeAppPushButton (QWidget *oldButton) — removes an app push button.
  • int findAppPushButton (QWidget *oldButton) const — finds an app push button.
  • int lengthAppPushButton (void) const — app push-button count.
  • QWidget * getRenderAreaWidget (void) const — grabs the render area widget.
  • virtual void setViewing (SbBool on) — viewing setter.
  • virtual void setComponentCursor (const SoQtCursor &cursor) — component cursor setter.

🌈 Public Member Functions inherited from SoQtViewer

All inherited, all exact, no edits, no cap:

  • virtual void setCamera (SoCamera *camera)
  • 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
  • virtual void setCursorEnabled (SbBool enable)
  • 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

More inherited goodness — yes, the whole list, bestie:

  • 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 inherited stack, zero notes left behind:

  • 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 functions, all inherited, all here, no disappearing acts:

  • 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

Just one, but she still counts:

  • SbBool isOfType (SoType type) const

🔥 Protected Member Functions

Protected girlies — still fully listed, because we don’t ghost APIs:

  • 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 createViewerButtons (QWidget *parent, SbPList *buttonlist)
  • virtual void buildPopupMenu (void)
  • virtual void setPopupMenuString (const char *title)
  • virtual void openPopupMenu (const SbVec2s position)
  • virtual void leftWheelStart (void)
  • virtual void leftWheelMotion (float)
  • virtual void leftWheelFinish (void)
  • float getLeftWheelValue (void) const
  • void setLeftWheelValue (const float value)
  • virtual void bottomWheelStart (void)
  • virtual void bottomWheelMotion (float)
  • virtual void bottomWheelFinish (void)
  • float getBottomWheelValue (void) const
  • void setBottomWheelValue (const float value)
  • virtual void rightWheelStart (void)
  • virtual void rightWheelMotion (float)
  • virtual void rightWheelFinish (void)
  • 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
  • virtual SbBool processSoEvent (const SoEvent *const event)

🛡️ Protected Member Functions (the inherited ones, the behind-the-scenes besties)

✨ inherited from SoQtViewer

  • SoQtViewer(QWidget *parent, const char *name, SbBool embed, Type type, SbBool build) — the protected constructor, for when you're building your own viewer subclass and don't want randoms instantiating it 💅
  • ~SoQtViewer() — protected destructor, same energy
  • virtual void setSeekMode(SbBool enable) — flip seek mode on/off
  • SbBool isSeekMode(void) const — is seek mode on rn?
  • SbBool seekToPoint(const SbVec2s screenpos) — seek to a point on screen
  • void seekToPoint(const SbVec3f &scenepos) — seek to a point in the scene
  • virtual void computeSeekFinalOrientation(void) — work out where the camera should end up after a seek
  • virtual void actualRedraw(void) — the actual redraw work, lowkey where the magic happens
  • void interactiveCountInc(void) — bump the interactive count up
  • void interactiveCountDec(void) — bump it back down
  • int getInteractiveCount(void) const — what's the count rn?
  • void setSeekDistance(const float distance) — set how far the seek goes
  • float getSeekDistance(void) const — read how far the seek goes
  • void setSeekValueAsPercentage(const SbBool on) — make seek values percentages instead of absolutes
  • SbBool isSeekValuePercentage(void) const — are seek values percentages rn?
  • virtual void changeCameraValues(SoCamera *camera) — update camera values
  • void addSuperimposition(SoNode *scene) — slap a superimposed scene on top ✨
  • void removeSuperimposition(SoNode *scene) — take it back off
  • void setSuperimpositionEnabled(SoNode *scene, const SbBool enable) — turn a superimposed scene on/off
  • SbBool getSuperimpositionEnabled(SoNode *scene) const — is that superimposed scene enabled?

🎀 inherited from SoQtRenderArea

  • SoQtRenderArea(QWidget *parent, const char *name, SbBool embed, SbBool mouseInput, SbBool keyboardInput, SbBool build) — protected constructor, mouse and keyboard input toggles included 🐭⌨️
  • virtual void redraw(void) — redraw everything
  • virtual void redrawOverlay(void) — redraw just the overlay
  • virtual void actualOverlayRedraw(void) — the actual overlay redraw, the one doing the work
  • virtual void processEvent(QEvent *event) — handle an incoming event
  • virtual void initGraphic(void) — set up the graphics
  • virtual void initOverlayGraphic(void) — set up the overlay graphics
  • virtual void widgetChanged(QWidget *widget) — called when the widget swaps out
  • virtual void afterRealizeHook(void) — the hook that runs after realize, iykyk
  • QWidget * buildWidget(QWidget *parent) — actually construct the widget
  • virtual const char * getDefaultWidgetName(void) const — default widget name
  • virtual const char * getDefaultTitle(void) const — default title
  • virtual const char * getDefaultIconTitle(void) const — default icon title
  • virtual SbBool glScheduleRedraw(void) — schedule a redraw, return whether it worked

🦋 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) — protected constructor, with defaults: parent=NULL, name=NULL, embed=TRUE, glmodes=SO_GL_RGB, build=TRUE
  • ~SoQtGLWidget() — destructor
  • QWidget * buildWidget(QWidget *parent) — build the widget
  • void setGLSize(const SbVec2s size) — set the GL canvas size
  • SbVec2s getGLSize(void) const — read the GL canvas size
  • float getGLAspectRatio(void) const — read the GL aspect ratio
  • void setGlxSize(const SbVec2s size) — set the Glx size
  • SbVec2s getGlxSize(void) const — read the Glx size
  • float getGlxAspectRatio(void) const — read the Glx aspect ratio
  • void setStereoBuffer(SbBool flag) — flip the stereo buffer
  • SbBool isStereoBuffer(void) const — stereo buffer on?
  • SbBool isRGBMode(void) — RGB mode?
  • void glLockNormal(void) — lock the normal buffer
  • void glUnlockNormal(void) — unlock it
  • void glLockOverlay(void) — lock the overlay buffer
  • void glUnlockOverlay(void) — unlock it
  • void glSwapBuffers(void) — swap those buffers, the classic double-buffer move 🔥
  • void glFlushBuffer(void) — flush the buffer

💜 inherited from SoQtComponent

  • SoQtComponent(QWidget *const parent=NULL, const char *const name=NULL, const SbBool embed=TRUE) — protected constructor, defaults parent=NULL, name=NULL, embed=TRUE
  • void setClassName(const char *const name) — give the class a 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 up a visibility-change callback, with user=NULL by default
  • void removeVisibilityChangeCallback(SoQtComponentVisibilityCB *const func, void *const user=NULL) — and unhook it later

🌸 Protected Attributes (subclass-only vibes)

  • QWidget * leftWheel — the left thumbwheel widget
  • QWidget * rightWheel — the right thumbwheel widget
  • QWidget * bottomWheel — the bottom thumbwheel widget
  • QWidget * leftDecoration — left decoration widget
  • QWidget * rightDecoration — right decoration widget
  • QWidget * bottomDecoration — bottom decoration widget
  • QWidget * leftWheelLabel — the label on the left wheel
  • char * leftWheelStr — the left wheel's string value
  • float leftWheelVal — the left wheel's float value
  • QWidget * rightWheelLabel — the label on the right wheel
  • char * rightWheelStr — the right wheel's string value
  • float rightWheelVal — the right wheel's float value
  • QWidget * bottomWheelLabel — the label on the bottom wheel
  • char * bottomWheelStr — the bottom wheel's string value
  • float bottomWheelVal — the bottom wheel's float value
  • SoQtPopupMenu * prefmenu — the preferences pop-up menu object 🎀

✨ inherited from SoQtGLWidget

  • SbBool waitForExpose — wait for an expose event?
  • SbBool drawToFrontBuffer — draw to the front buffer?

🫶 Additional Inherited Members

Static Public Member Functions inherited from SoQtRenderArea

  • static uint32_t getDefaultRedrawPriority(void) — grab the default redraw priority

Static Public Member Functions inherited from SoQtComponent

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

Static Public Member Functions inherited from SoQtObject

  • static void initClass(void) — init the class
  • static SoType getClassTypeId(void) — get the class type id
  • static void init(void) — init the whole thing

👑 Detailed Description

Okay so SoQtFullViewer adds a bunch of user interface bits to the viewer canvas. It's literally the glow-up of a plain viewer 💅

SoQtFullViewer is an abstract viewer class — so you can't just instantiate it directly, bestie — and it extends its superclass (the basic SoQtViewer class) with two major user interface additions:

  • decorations around the render canvas, with buttons and thumbwheels to control camera interaction and various other aspects of model / scene viewing
  • a pop-up menu, invoked with the right mouse button, which controls yet more aspects of the rendering and the viewer

The user interface features listed above are the common parts of the user interfaces of the SoQtFullViewer's non-abstract subclasses. ✨

For "real" application programs, the viewers / components from this class onwards and further down in the inheritance hierarchy is usually not all that interesting, as they enforces too much extra user interface cruft not compatible with the look and feel of the other parts of the application user interface. So most "real" applications will use either the SoQtViewer or the SoQtRenderArea as their base-level component, and then inherit one of these down into one's own "proper" viewer classes.

The non-abstract subclasses of the SoQtFullViewer class are viewer components often used as a test-bed for prototyping / rapid application development when doing quick testing of scenes, stand-alone 3D-models, animation techniques, etc.

See also: SoQtConstrainedViewer, SoQtExaminerViewer, SoQtPlaneViewer

🧚 Member Enumeration Documentation

enum SoQtFullViewer::BuildFlag

These are the valid values for the constructor argument that decides how much of the user interface features to set up. Heads up: the enum values are bitflags that can be OR'ed together — so you can stack 'em 🔥

Enumerators

  • BUILD_NONE — Do not add any of the user interface components. None. Zero. Nada. 🙈
  • BUILD_DECORATION — Only build and set up the decorations around the OpenGL canvas.
  • BUILD_POPUP — Only build the pop-up menu. (Activated with the right mouse button.) 🖱️
  • BUILD_ALL — Build all user interface components of the SoQtFullViewer. The full course, periodt.

🎀 Constructor & Destructor Documentation

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

Constructor 💖 See the parent class for explanation of the arguments.

Subclasses will probably usually call with the buildNow flag set to FALSE to be able to do delayed building of the OpenGL canvas after other setup tasks has been performed. (Yes, it's called buildNow in the prose and build in the signature — the docs are being iconic like that. Iykyk.)

SoQtFullViewer::~SoQtFullViewer() [protected]

Destructor. Bye bestie 👋

🌈 Member Function Documentation

void SoQtFullViewer::setDecoration(const SbBool enable)

Turn the viewer decorations on or off. ✨

See also: isDecoration()

SbBool SoQtFullViewer::isDecoration(void) const

Return TRUE if the viewer decorations are on, otherwise FALSE.

See also: setDecoration()

void SoQtFullViewer::setPopupMenuEnabled(const SbBool enable)

Decide whether or not if clicking with the right mouse button on the OpenGL canvas should reveal a preferences pop-up menu when in viewing mode. 🖱️

See also: isPopupMenuEnabled()

SbBool SoQtFullViewer::isPopupMenuEnabled(void) const

Return TRUE if the pop-up preferences menu is enabled, otherwise FALSE.

See also: setPopupMenuEnabled()

QWidget * SoQtFullViewer::getAppPushButtonParent(void) const

Returns the widget which is used as the parent of application specified buttons. The row of application buttons (if any) will be placed in the upper left corner. 🫶

See also: addAppPushButton(), insertAppPushButton(), removeAppPushButton()

void SoQtFullViewer::addAppPushButton(QWidget * newButton)

Add an application specific push button to the viewer decorations. Application buttons will be laid out in a vertical row from the upper left corner.

The button will be added bottom-most. ⬇️

See also: insertAppPushButton(), removeAppPushButton(), getAppPushButtonParent()

void SoQtFullViewer::insertAppPushButton(QWidget * newButton, int index)

Insert an application specific push button to the viewer decorations at the given index. 🎯

See also: addAppPushButton(), removeAppPushButton(), getAppPushButtonParent()

void SoQtFullViewer::removeAppPushButton(QWidget * oldButton)

Remove one of the application specific buttons. Gone, but not forgotten 💀

See also: addAppPushButton(), insertAppPushButton()

int SoQtFullViewer::findAppPushButton(QWidget * oldButton) const

Return the index of a particular button that has been specified by the application, or -1 of the button has not been added. (That's the docs' typo, not mine — "of" the button, iconic.)

See also: addAppPushButton()

int SoQtFullViewer::lengthAppPushButton(void) const

Return number of application specific buttons added. 🔢

See also: addAppPushButton(), insertAddAppPushButton() (yes, the doc really says insertAddAppPushButton — I'm not fixing it, I'm preserving the lore)

QWidget * SoQtFullViewer::getRenderAreaWidget(void) const

Returns the render area OpenGL canvas widget.

void SoQtFullViewer::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 SoQtViewer.

Reimplemented in SoQtExaminerViewer, SoQtFlyViewer, and SoQtPlaneViewer.

void SoQtFullViewer::setComponentCursor(const SoQtCursor & cursor) [virtual]

Sets the cursor for this component. 🖱️

Note: not part of the original SGI InventorXt API.

Reimplemented from SoQtComponent.

void SoQtFullViewer::sizeChanged(const SbVec2s & size) [protected], [virtual]

Called internally from within the SoQt library when the widget embedded in a component changes its size, which is usually triggered by end-user interaction.

This method is then invoked to notify the component that the size has changed. It is called from the top and all the way down to the bottom, the size being adjusted to take into account extra decorations having been added at each level in the component class hierarchy. 📐

Reimplemented from SoQtViewer.

void SoQtFullViewer::buildDecoration(QWidget * parent) [protected], [virtual]

Build viewer decorations. 🎀

QWidget * SoQtFullViewer::buildLeftTrim(QWidget * parent) [protected], [virtual]

Build decorations on the left of the render canvas. Override this method in subclasses if you want your own decorations on the viewer window. ✨

The decoration will be 30 pixels wide.

💅 QWidget * SoQtFullViewer::buildBottomTrim(QWidget * parent) [protected], [virtual]

Builds the decorations on the bottom of the render canvas, bestie. Override this method in subclasses if you want your own decorations on the viewer window — go off, make it yours ✨

🌸 QWidget * SoQtFullViewer::buildRightTrim(QWidget * parent) [protected], [virtual]

Builds the decorations on the right side of the render canvas. Same deal — override this method in subclasses if you want your own decorations on the viewer window 💖

🎀 QWidget * SoQtFullViewer::buildAppButtons(QWidget * parent) [protected]

Builds the application-specified button row — but only if any buttons were actually set up. No buttons, no row, periodt.

🦋 QWidget * SoQtFullViewer::buildViewerButtons(QWidget * parent) [protected]

Builds and lays out the viewer-specified button row. Very demure, very mindful layout 💅

👑 void SoQtFullViewer::createViewerButtons(QWidget * parent, SbPList * buttonlist) [protected], [virtual]

This is the one that sets up the viewer buttons with pixmaps and event connections. Iconic behavior.

Okay so here is the one important note if you want to override this method and 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++ — iykyk):

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 😭

The way you delay a superclass viewer from building its decorations is by passing build==FALSE as the last argument of the protected constructors. Then you'll have to explicitly trigger the building in your own constructor. No shortcuts.

Here's a minimal example showing the steps you need 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 in SoQtExaminerViewer, and SoQtPlaneViewer.

🌈 void SoQtFullViewer::buildPopupMenu(void ) [protected], [virtual]

Makes a pop-up menu with preferences settings. Menu sweep, but make it preferences 🫶

One important note — same energy as before — for when you want to override this function in a subclass: be aware that it will usually be invoked (indirectly) from this class's constructor. That is before the table of virtual function pointers has been set up for the subclass, and because of this, the function will not be called in the subclass even though it is virtual. Truly the plot twist nobody asked for 💀

To make the overriding actually be in effect, you need to delay building the widgets of this class. For info on how to do that, see the documentation of SoQtFullViewer::createViewerButtons(). Go read it, bestie, it's right there ⬆️

✨ void SoQtFullViewer::setPopupMenuString(const char * name) [protected], [virtual]

Sets the title of the pop-up menu. Name it something cute 💜

🧚 void SoQtFullViewer::openPopupMenu(const SbVec2s position) [protected], [virtual]

NOTE: This method is not part of the original InventorXt API.

🍓 void SoQtFullViewer::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 in SoQtPlaneViewer.

🎀 void SoQtFullViewer::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 — this is where the whole drag lives, fr fr.

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

Reimplemented in SoQtConstrainedViewer, SoQtExaminerViewer, and SoQtPlaneViewer.

🦋 void SoQtFullViewer::leftWheelFinish(void ) [protected], [virtual]

Called as the user lets go of the thumbwheel in the left frame after a drag operation. The release. The let-go. Override this method in subclassed viewers to provide your own functionality on the thumbwheel 💅

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

Reimplemented in SoQtPlaneViewer.

🌸 float SoQtFullViewer::getLeftWheelValue(void ) const [protected]

Gets the current value of the left thumbwheel. Look at it. Read it. Get that value 🔥

See also: leftWheelMotion()

💖 void SoQtFullViewer::setLeftWheelValue(const float value) [protected]

Sets a new value for the left thumbwheel. Your wheel, your rules ✨

⭐ void SoQtFullViewer::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 🫶

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

Reimplemented in SoQtPlaneViewer.

🔥 void SoQtFullViewer::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. Highkey the busiest method on this page 😭

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

Reimplemented in SoQtConstrainedViewer, SoQtExaminerViewer, and SoQtPlaneViewer.

🎀 void SoQtFullViewer::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 in SoQtPlaneViewer.

🌈 float SoQtFullViewer::getBottomWheelValue(void ) const [protected]

Gets the current value of the bottom thumbwheel. Value check: passed ✨

See also: bottomWheelMotion()

🧚 void SoQtFullViewer::setBottomWheelValue(const float value) [protected]

Sets a new value for the bottom thumbwheel. Slay.

💫 void SoQtFullViewer::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 in SoQtPlaneViewer.

🎀 void SoQtFullViewer::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. Yes, there's three of these. Yes, they all matter 💅

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

Reimplemented in SoQtExaminerViewer, SoQtFlyViewer, and SoQtPlaneViewer.

🍓 void SoQtFullViewer::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 in SoQtPlaneViewer.

🔥 float SoQtFullViewer::getRightWheelValue(void ) const [protected]

Gets the current value of the right thumbwheel. Last wheel, same energy 🌟

See also: rightWheelMotion()

💜 void SoQtFullViewer::setRightWheelValue(const float value) [protected]

Sets a new value for the right thumbwheel. And that's the whole wheel saga, periodt.

✨ void SoQtFullViewer::setLeftWheelString(const char *const string) [protected]

Sets the label of the left thumbwheel. Label it, bestie 🏷️

🎀 QWidget * SoQtFullViewer::getLeftWheelLabelWidget(void ) const [protected]

This method returns the native widget for the label below the left thumb wheel. Native widget, no cosplay 💅

🌸 void SoQtFullViewer::setBottomWheelString(const char *const string) [protected]

Sets the label of the bottom thumbwheel. Cute label incoming 🫶

🦋 QWidget * SoQtFullViewer::getBottomWheelLabelWidget(void ) const [protected]

This method returns the native widget for the label beside the bottom thumb wheel. Beside, not below — read carefully, bestie 👀

⭐ void SoQtFullViewer::setRightWheelString(const char *const string) [protected]

Sets the label of the right thumbwheel. Final label of the trio ✨

💖 QWidget * SoQtFullViewer::getRightWheelLabelWidget(void ) const [protected]

This method returns the native widget for the label below the right thumb wheel. And that's all three label widgets accounted for, no cap.

👑 SbBool SoQtFullViewer::processSoEvent(const SoEvent *const event) [protected], [virtual]

Okay so this is the big one. Toolkit-native events are tried to be converted to Coin-generic events in the SoQtRenderArea::processEvent() method. If this succeeds, they get forwarded to this method. Like a whole relay race of events 🏃‍♀️💨

This is a virtual method, and it 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. Genuinely do not skip this, or your events will just… vanish 💀

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 SoQtViewer.

Reimplemented in SoQtExaminerViewer, SoQtFlyViewer, and SoQtPlaneViewer.

💾 MEMBER DATA DOCUMENTATION 💾

okay so this is the part where we meet all the protected data members — the actual stuff the class is holding onto. they're all [protected], which means they're inner-circle only, bestie. not for just anyone to touch. 🫶

  • QWidget* SoQtFullViewer::leftWheel [protected] — the widget that is the thumbwheel sitting to the left of the render canvas. iconic little guy, holds it down on the left side. 🎡
  • QWidget* SoQtFullViewer::rightWheel [protected] — the widget representing the thumbwheel on the right side of the render canvas. yes, it's the leftWheel's sibling. no, they are not twins, they're on opposite sides, keep up. 💅
  • QWidget* SoQtFullViewer::bottomWheel [protected] — the widget representing the thumbwheel below the render canvas. bottomWheel really said "lowest of the low" and honestly? respect. 🦋
  • QWidget* SoQtFullViewer::leftDecoration [protected] — the root widget for all the left-side decorations. like the parent widget of that whole left-side aesthetic. 👑
  • QWidget* SoQtFullViewer::rightDecoration [protected] — the root widget for the right-side decorations. matching energy, opposite side. ✨
  • QWidget* SoQtFullViewer::bottomDecoration [protected] — the root widget for the bottom decorations. it's giving ground floor, it's giving foundation. 🌸
  • QWidget* SoQtFullViewer::leftWheelLabel [protected] — the label widget of the left wheel. you know, the little text bit that says what the wheel does. 🏷️
  • char* SoQtFullViewer::leftWheelStr [protected] — the text of the left thumbwheel's label. it's a char*! a raw one! keep it close, bestie. 😭
  • float SoQtFullViewer::leftWheelVal [protected] — the current value of the left thumbwheel. it's a float so it's got decimals and vibes. 💫
  • QWidget* SoQtFullViewer::rightWheelLabel [protected] — the label widget of the right wheel. same deal, other side. 🎀
  • char* SoQtFullViewer::rightWheelStr [protected] — the text of the right thumbwheel's label. two char*s so far. living dangerously, love that for us. 🔥
  • float SoQtFullViewer::rightWheelVal [protected] — the current value of the right-side thumbwheel. note the slightly different wording in the original — right side, not right wheel. she's quirky like that. 🙈
  • QWidget* SoQtFullViewer::bottomWheelLabel [protected] — the label widget of the bottom wheel. the little name tag for the bottom hero. 🍓
  • char* SoQtFullViewer::bottomWheelStr [protected] — the text of the bottom thumbwheel's label. third char*. the trifecta is complete. 🧚
  • float SoQtFullViewer::bottomWheelVal [protected] — the current value of the bottom thumbwheel. and that's all three values accounted for. the wheels have been thoroughly documented. ⭐
  • SoQtPopupMenu* SoQtFullViewer::prefmenu [protected] — a pointer to the pop-up menu instance. the preferences menu! the little menu that pops up! she has a SoQtPopupMenu* and she's not afraid to use it. 💜

✍️ Author ✍️

Generated automatically by Doxygen for SoQt from the source code. no human author here, bestie — the robot did it. Doxygen just vibed and produced this whole page. 🤖✨

aaaand that's a wrap on SoQtFullViewer(3)! 🎉 this final part came to you courtesy of Version 1.6.2, dated Sat Jan 6 2024 12:20:55 — that's the source/version and date stamp, so you know exactly which cut of the docs you're reading. go forth and build your viewers, bestie, you've got all the facts now. periodt. 💅🎀🦋

📦 where this page comes from