SoQtConstrainedViewer(3)

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

💅 SoQtConstrainedViewer(3) — the SoQt one ✨

okay so bestie, buckle up: this is the manpage for SoQtConstrainedViewer, and it lives in the SoQt family. She's the superclass for viewers that have opinions about where the camera's up-vector can point. Think of her as the mom friend who doesn't let the viewpoint do anything embarrassing. 🫶

🌸 NAME 🌸

SoQtConstrainedViewer — the superclass for viewers with constrains on the viewpoint. (yes, "constrains", that's literally what the original says, we don't fix the spelling of our ancestors 💀)

The way that this class is the blueprint, and SoQtFlyViewer is the child that actually goes places. Cute.

🦋 SYNOPSIS 🦋

#include <Ink / Qt/viewers/SoQtConstrainedViewer.h>

no wait, actual one, character for character:

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

Inherits SoQtFullViewer.

Inherited by SoQtFlyViewer. ✈️ (that's the fly one, get it)

⭐ Public Member Functions

These are the ones she lets you call directly. Short list, but she makes it count:

  • void setUpDirection (const SbVec3f &dir) — sets which way is "up" for the camera. you're literally telling the scene which way the sky goes.
  • const SbVec3f & getUpDirection (void) const — hands you back the up direction. read-only, respectful. 🎀
  • virtual void setCamera (SoCamera *newcam) — swaps in a whole new camera. yes, the entire camera. main character energy.
  • virtual void saveHomePosition (void) — bookmarks where the camera is right now so you can yeet back later.
  • virtual void resetToHomePosition (void) — the "undo my chaotic camera wandering" button. iconic. 🔥

🧸 Public Member Functions inherited from SoQtFullViewer

the deluxe edition features, passed down like a family heirloom:

  • void setDecoration (const SbBool on) — toggles the window decoration chrome.
  • SbBool isDecoration (void) const — is the decoration on or not, bestie.
  • void setPopupMenuEnabled (const SbBool on) — enable/disable the popup menu.
  • SbBool isPopupMenuEnabled (void) const — asks the popup menu how it's feeling (enabled or not).
  • QWidget * getAppPushButtonParent (void) const — gives you the widget that's parent to app push buttons.
  • void addAppPushButton (QWidget *newButton) — add your own button to the viewer. customise her 💅
  • void insertAppPushButton (QWidget *newButton, int index) — same, but at a specific spot in the lineup.
  • void removeAppPushButton (QWidget *oldButton) — bye bye button.
  • int findAppPushButton (QWidget *oldButton) const — finds a button by pointer, returns its index.
  • int lengthAppPushButton (void) const — how many app buttons we got.
  • QWidget * getRenderAreaWidget (void) const — the widget where the actual rendering happens.
  • virtual void setViewing (SbBool on) — turn viewing mode on/off.
  • virtual void setComponentCursor (const SoQtCursor &cursor) — set the cursor for this component. 🖱️✨

🌈 Public Member Functions inherited from SoQtViewer

this is the long one. grab a snack. 🍓

  • SoCamera * getCamera (void) const — the current camera, in all her glory.
  • virtual void setCameraType (SoType type) — pick which kind of camera she uses.
  • SoType getCameraType (void) const — which kind is she using right now.
  • virtual void toggleCameraType (void) — flips between camera types. no thoughts, just toggling.
  • virtual void viewAll (void) — frames the whole scene. the "make it fit" button.
  • virtual void setHeadlight (SbBool enable) — on/off for the headlight.
  • SbBool isHeadlight (void) const — headlight status check.
  • SoDirectionalLight * getHeadlight (void) const — hands you the headlight object itself.
  • virtual void setDrawStyle (SoQtViewer::DrawType type, SoQtViewer::DrawStyle style) — pick the draw style for a given draw type.
  • SoQtViewer::DrawStyle getDrawStyle (const SoQtViewer::DrawType type) const — what's the draw style for this draw type.
  • virtual void setBufferingType (SoQtViewer::BufferType type) — set the buffering type.
  • SoQtViewer::BufferType getBufferingType (void) const — read back the buffering type.
  • SbBool isViewing (void) const — are we viewing or nah.
  • virtual void setCursorEnabled (SbBool enable) — cursor on/off.
  • SbBool isCursorEnabled (void) const — cursor status, respectfully asked.
  • void setAutoClipping (SbBool enable) — auto-clipping on/off.
  • SbBool isAutoClipping (void) const — is auto-clipping doing her thing.
  • void setAutoClippingStrategy (const AutoClippingStrategy strategy, const float value=0.6f, SoQtAutoClippingCB *cb=NULL, void *cbuserdata=NULL) — the full auto-clipping config: strategy, plus value defaulting to 0.6f, plus an SoQtAutoClippingCB *cb defaulting to NULL, plus void *cbuserdata defaulting to NULL. all the knobs. 🎛️
  • virtual void setStereoViewing (SbBool enable) — stereo viewing on/off.
  • SbBool isStereoViewing (void) const — stereo viewing status.
  • virtual void setStereoOffset (const float dist) — how far apart the stereo eyes sit.
  • float getStereoOffset (void) const — read that offset back.
  • SbBool setStereoType (SoQtViewer::StereoType s) — set the stereo flavour. returns an SbBool, because she likes to report back.
  • SoQtViewer::StereoType getStereoType (void) const — which stereo flavour are we on.
  • void setAnaglyphStereoColorMasks (const SbBool left[3], const SbBool right[3]) — the anaglyph color masks, one three-element array per eye.
  • void getAnaglyphStereoColorMasks (SbBool left[3], SbBool right[3]) — reads those anaglyph masks out into your arrays.
  • void setDetailSeek (const SbBool enable) — detail-seek on/off.
  • SbBool isDetailSeek (void) const — detail-seek status.
  • void setSeekTime (const float seconds) — how long a seek animation takes, in seconds.
  • float getSeekTime (void) const — how long a seek animation takes, in seconds, but as a return value.
  • void addStartCallback (SoQtViewerCB *func, void *data=NULL) — hook a callback to the start event. data defaults to NULL.
  • void addFinishCallback (SoQtViewerCB *func, void *data=NULL) — hook a callback to the finish event. data defaults to NULL.
  • void removeStartCallback (SoQtViewerCB *func, void *data=NULL) — unhook that start callback. data defaults to NULL.
  • void removeFinishCallback (SoQtViewerCB *func, void *data=NULL) — unhook that finish callback. data defaults to NULL.
  • void setWireframeOverlayColor (const SbColor &color) — the wireframe overlay colour. aesthetic choice, honestly.
  • const SbColor & getWireframeOverlayColor (void) const — read the wireframe overlay colour back.
  • virtual void setDoubleBuffer (const SbBool enable) — double buffering on/off.
  • virtual void setSceneGraph (SoNode *root) — drop in your scene graph root.
  • virtual SoNode * getSceneGraph (void) const (well, virtual SoNode * getSceneGraph (void) in the original) — gives you the scene graph root back.

🎀 Public Member Functions inherited from SoQtRenderArea

the render area has so many features and she wants you to know about every single one:

  • SoQtRenderArea (QWidget *parent=NULL, const char *name=NULL, SbBool embed=TRUE, SbBool mouseInput=TRUE, SbBool keyboardInput=TRUE) — the constructor. defaults: parent=NULL, name=NULL, embed=TRUE, mouseInput=TRUE, keyboardInput=TRUE.
  • ~SoQtRenderArea () — the destructor.
  • void setOverlaySceneGraph (SoNode *scene) — set a whole separate overlay scene.
  • SoNode * getOverlaySceneGraph (void) — get that overlay scene back.
  • void setBackgroundColor (const SbColor &color) — background colour, go wild.
  • const SbColor & getBackgroundColor (void) const — what's the background colour.
  • void setBackgroundIndex (int idx) — background as a colour-map index.
  • int getBackgroundIndex (void) const — which index is the background.
  • void setOverlayBackgroundIndex (int idx) — overlay background index.
  • int getOverlayBackgroundIndex (void) const — read the overlay background index.
  • void setColorMap (int start, int num, const SbColor *colors) — install a colour map chunk.
  • void setOverlayColorMap (int start, int num, const SbColor *colors) — same but for the overlay.
  • void setViewportRegion (const SbViewportRegion &newRegion) — set the viewport region.
  • const SbViewportRegion & getViewportRegion (void) const — read the viewport region.
  • void setTransparencyType (SoGLRenderAction::TransparencyType type) — choose how transparency is rendered.
  • SoGLRenderAction::TransparencyType getTransparencyType (void) const — read the transparency type.
  • void setAntialiasing (SbBool smoothing, int numPasses) — antialiasing config: smoothing flag + number of passes.
  • void getAntialiasing (SbBool &smoothing, int &numPasses) const — reads antialiasing settings out via references.
  • void setClearBeforeRender (SbBool enable, SbBool zbEnable=TRUE) — clear before render; zbEnable defaults to TRUE.
  • SbBool isClearBeforeRender (void) const — are we clearing before render.
  • SbBool isClearZBufferBeforeRender (void) const — are we clearing the z-buffer before render.
  • void setClearBeforeOverlayRender (SbBool enable) — clear before the overlay render.
  • SbBool isClearBeforeOverlayRender (void) const — clearing before overlay render, y/n.
  • void setAutoRedraw (SbBool enable) — auto redraw on/off.
  • SbBool isAutoRedraw (void) const — auto redraw status.
  • void setRedrawPriority (uint32_t priority) — set the redraw priority.
  • uint32_t getRedrawPriority (void) const — read the redraw priority.
  • void render (void) — render. just. render. go off. 🔥
  • void renderOverlay (void) — render the overlay.
  • void scheduleRedraw (void) — queue up a redraw for later.
  • void scheduleOverlayRedraw (void) — queue up an overlay redraw for later.
  • void redrawOnSelectionChange (SoSelection *selection) — redraw whenever this selection changes.
  • void redrawOverlayOnSelectionChange (SoSelection *selection) — redraw the overlay whenever this selection changes.
  • void setEventCallback (SoQtRenderAreaEventCB *func, void *user=NULL) — set an event callback; user defaults to NULL.
  • void setSceneManager (SoSceneManager *manager) — hand over the scene manager.
  • SoSceneManager * getSceneManager (void) const — get the scene manager back.
  • void setOverlaySceneManager (SoSceneManager *manager) — hand over the overlay scene manager.
  • SoSceneManager * getOverlaySceneManager (void) const — get the overlay scene manager back.
  • void setGLRenderAction (SoGLRenderAction *action) — swap in the GL render action.
  • SoGLRenderAction * getGLRenderAction (void) const — get the GL render action.
  • void setOverlayGLRenderAction (SoGLRenderAction *action) — swap in the overlay GL render action.
  • SoGLRenderAction * getOverlayGLRenderAction (void) const — get the overlay GL render action.
  • SbBool sendSoEvent (const SoEvent *event) — push an SoEvent through the system.
  • void registerDevice (SoQtDevice *device) — register an input device.
  • void unregisterDevice (SoQtDevice *device) — un-register it. 😭

🦋 Public Member Functions inherited from SoQtGLWidget

GL widget era. she's got buffers for days:

  • void setBorder (const SbBool enable) — border on/off.
  • SbBool isBorder (void) const — is there a border.
  • SbBool isDoubleBuffer (void) const — double buffering check.
  • void setDrawToFrontBufferEnable (const SbBool enable) — draw-to-front-buffer on/off.
  • SbBool isDrawToFrontBufferEnable (void) const — is draw-to-front-buffer enabled.
  • void setQuadBufferStereo (const SbBool enable) — quad buffer stereo on/off.
  • SbBool isQuadBufferStereo (void) const — quad buffer stereo status.
  • void setAccumulationBuffer (const SbBool enable) — accumulation buffer on/off.
  • SbBool getAccumulationBuffer (void) const — read the accumulation buffer setting.
  • void setStencilBuffer (const SbBool enable) — stencil buffer on/off.
  • SbBool getStencilBuffer (void) const — read the stencil buffer setting.
  • void setAlphaChannel (const SbBool enable) — alpha channel on/off.
  • SbBool getAlphaChannel (void) const — read the alpha channel setting.
  • void setOverlayRender (const SbBool onoff) — overlay render on/off.
  • SbBool isOverlayRender (void) const — is overlay render happening.
  • void setSampleBuffers (const int numsamples) — how many sample buffers.
  • int getSampleBuffers (void) const — read how many sample buffers.
  • void setStealFocus (SbBool enable) — steal focus, y/n. rude but valid 💅
  • SbBool isStealFocus (void) const — do we steal focus.
  • QWidget * getGLWidget (void) const — the GL widget.
  • QWidget * getNormalWidget (void) const — the normal widget.
  • QWidget * getOverlayWidget (void) const — the overlay widget.
  • SbBool hasOverlayGLArea (void) const — does she have an overlay GL area.
  • SbBool hasNormalGLArea (void) const — does she have a normal GL area.
  • unsigned long getOverlayTransparentPixel (void) — the overlay transparent pixel value.
  • void getPointSizeLimits (SbVec2f &range, float &granularity) — reads point size limits out into your refs.
  • void getLineWidthLimits (SbVec2f &range, float &granularity) — reads line width limits out into your refs.

🧚 Public Member Functions inherited from SoQtComponent

component-level stuff, very "who am I as a widget" energy:

  • virtual SoType getTypeId (void) const — the type id.
  • virtual ~SoQtComponent () — destructor, but virtual.
  • virtual void show (void) — show her. 👑
  • virtual void hide (void) — hide her. 🙈
  • SbBool isFullScreen (void) const — fullscreen check.
  • SbBool setFullScreen (const SbBool onoff) — toggle fullscreen; returns an SbBool.
  • SbBool isVisible (void) const — is she visible.
  • SbBool isTopLevelShell (void) const — is she a top level shell.
  • QWidget * getWidget (void) const — the widget.
  • QWidget * getBaseWidget (void) const — the base widget.
  • QWidget * getShellWidget (void) const — the shell widget.
  • QWidget * getParentWidget (void) const — the parent widget.
  • void setSize (const SbVec2s size) — set the size.
  • SbVec2s getSize (void) const — get the size.
  • void setTitle (const char *const title) — set the window title.
  • const char * getTitle (void) const — get the window title.
  • void setIconTitle (const char *const title) — set the icon title.
  • const char * getIconTitle (void) const — get the icon title.
  • const char * getWidgetName (void) const — the widget name.
  • const char * getClassName (void) const — the class name.
  • void setWindowCloseCallback (SoQtComponentCB *const func, void *const user=NULL) — hook the window-close callback; user defaults to NULL.

💜 Public Member Functions inherited from SoQtObject

literally one (1) function. she's low maintenance:

  • SbBool isOfType (SoType type) const — is this object of that type.

💀 Protected Member Functions

the inner circle. you don't call these from outside, they're for subclasses and for the class herself when she's feeling private:

  • SoQtConstrainedViewer (QWidget *parent, const char *const name, SbBool embed, SoQtFullViewer::BuildFlag flag, SoQtViewer::Type type, SbBool build) — the protected constructor. yes, the constructor is protected. she's exclusive like that. ✨
  • ~SoQtConstrainedViewer () — the destructor.
  • virtual void tiltCamera (float delta) — tilts the camera by delta. this is the actual constraint-enforcing behaviour, lowkey the whole point of the class.
  • virtual void bottomWheelMotion (float value) — what happens when the bottom wheel moves.
  • virtual void leftWheelMotion (float value) — what happens when the left wheel moves.
  • virtual void changeCameraValues (SoCamera *camera) — adjust the camera's values.
  • void findUpDirection (SbVec2s mouselocation) — works out the up direction from a mouse location.
  • void checkForCameraUpConstrain (void) — the vibe check for the camera's up constraint. the name says it all, fr fr.

🍓 Protected Member Functions inherited from SoQtFullViewer

the protected inheritance list, i.e. the full-viewer internals:

  • SoQtFullViewer (QWidget *parent, const char *name, SbBool embed, BuildFlag flag, Type type, SbBool build) — protected constructor.
  • ~SoQtFullViewer () — destructor.
  • virtual void sizeChanged (const SbVec2s &size) — reacts to a size change.
  • QWidget * buildWidget (QWidget *parent) — builds the widget.
  • virtual void buildDecoration (QWidget *parent) — builds the decoration.
  • virtual QWidget * buildLeftTrim (QWidget *parent) — builds the left trim.
  • virtual QWidget * buildBottomTrim (QWidget *parent) — builds the bottom trim.
  • virtual QWidget * buildRightTrim (QWidget *parent) — builds the right trim.
  • QWidget * buildAppButtons (QWidget *parent) — builds the app buttons.
  • QWidget * buildViewerButtons (QWidget *parent) — builds the viewer buttons.
  • virtual void createViewerButtons (QWidget *parent, SbPList *buttonlist) — creates the viewer buttons into a list.
  • virtual void buildPopupMenu (void) — builds the popup menu.
  • virtual void setPopupMenuString (const char *title) — sets the popup menu's string.
  • virtual void openPopupMenu (const SbVec2s position) — opens the popup menu at a position.
  • virtual void leftWheelStart (void) — left wheel interaction starts.
  • virtual void leftWheelFinish (void) — left wheel interaction ends.
  • float getLeftWheelValue (void) const — the left wheel's value.
  • void setLeftWheelValue (const float value) — set the left wheel's value.
  • virtual void bottomWheelStart (void) — bottom wheel interaction starts.
  • virtual void bottomWheelFinish (void) — bottom wheel interaction ends.
  • float getBottomWheelValue (void) const — the bottom wheel's value.
  • void setBottomWheelValue (const float value) — set the bottom wheel's value.
  • virtual void rightWheelStart (void) — right wheel interaction starts.
  • virtual void rightWheelMotion (float) — right wheel motion. note the unnamed float — yes, she left it unnamed. we respect it.
  • virtual void rightWheelFinish (void) — right wheel interaction ends.
  • float getRightWheelValue (void) const — the right wheel's value.
  • void setRightWheelValue (const float value) — set the right wheel's value.
  • void setLeftWheelString (const char *const name) — label for the left wheel.
  • QWidget * getLeftWheelLabelWidget (void) const — the left wheel's label widget.
  • void setBottomWheelString (const char *const name) — label for the bottom wheel.
  • QWidget * getBottomWheelLabelWidget (void) const — the bottom wheel's label widget.
  • void setRightWheelString (const char *const name) — label for the right wheel.
  • const char * getRightWheelString () const — the right wheel's string. note the empty parens, that's how she wrote it, we keep it.
  • QWidget * getRightWheelLabelWidget (void) const — the right wheel's label widget.
  • virtual SbBool processSoEvent (const SoEvent *const event) — processes an SoEvent.
part one ends right here bestie — the rest is coming, don't you dare close the terminal 💖

💫 Protected Member Functions inherited from SoQtViewer

These are the family-only (protected 🔒) members you get handed down from the parent class — still yours to use if you subclass, bestie:

  • SoQtViewer (QWidget *parent, const char *name, SbBool embed, Type type, SbBool build) — the inherited constructor.
  • ~SoQtViewer () — the inherited destructor.
  • virtual void setSeekMode (SbBool enable) — flip seek mode on or off.
  • SbBool isSeekMode (void) const — ask whether seek mode is currently on.
  • SbBool seekToPoint (const SbVec2s screenpos) — seek toward a screen position.
  • void seekToPoint (const SbVec3f &scenepos) — and here's the overload that takes a scene position instead.
  • virtual void computeSeekFinalOrientation (void) — sorts out the final orientation for a seek.
  • virtual void actualRedraw (void) — the actual redraw hook.
  • void interactiveCountInc (void) — bump the interactive counter up by one.
  • void interactiveCountDec (void) — drop the interactive counter down by one.
  • int getInteractiveCount (void) const — read the current interactive count.
  • void setSeekDistance (const float distance) — set how far a seek travels.
  • float getSeekDistance (void) const — read back that seek distance.
  • void setSeekValueAsPercentage (const SbBool on) — toggle whether the seek value is treated as a percentage.
  • SbBool isSeekValuePercentage (void) const — check if that percentage thing is on.
  • void addSuperimposition (SoNode *scene) — add a superimposition node.
  • void removeSuperimposition (SoNode *scene) — take one back out.
  • void setSuperimpositionEnabled (SoNode *scene, const SbBool enable) — enable or disable a superimposition scene.
  • SbBool getSuperimpositionEnabled (SoNode *scene) const — query whether it's enabled.

🎀 Protected Member Functions inherited from SoQtRenderArea

  • SoQtRenderArea (QWidget *parent, const char *name, SbBool embed, SbBool mouseInput, SbBool keyboardInput, SbBool build) — inherited constructor, with mouse and keyboard input switches.
  • virtual void redraw (void) — redraw.
  • virtual void redrawOverlay (void) — redraw the overlay layer.
  • virtual void actualOverlayRedraw (void) — the actual overlay redraw hook.
  • virtual void processEvent (QEvent *event) — handle an incoming Qt 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 changes.
  • virtual void afterRealizeHook (void) — the hook that runs after realization.
  • QWidget * buildWidget (QWidget *parent) — build the widget under a given parent.
  • virtual const char * getDefaultWidgetName (void) const — default widget name getter.
  • virtual const char * getDefaultTitle (void) const — default title getter.
  • virtual const char * getDefaultIconTitle (void) const — default icon title getter.
  • virtual SbBool glScheduleRedraw (void) — schedule a GL redraw.

🦋 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) — inherited constructor, note the 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 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 (yes, Glx, not GL — that's how it's spelled, leave it alone 🙈).
  • SbVec2s getGlxSize (void) const — get the Glx size.
  • float getGlxAspectRatio (void) const — get the Glx aspect ratio.
  • void setStereoBuffer (SbBool flag) — set the stereo buffer flag.
  • SbBool isStereoBuffer (void) const — is this a stereo buffer?
  • SbBool isRGBMode (void) — are we in 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 the overlay buffer.
  • void glSwapBuffers (void) — swap the buffers.
  • 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 with those same friendly defaults.
  • 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 one.
  • void addVisibilityChangeCallback (SoQtComponentVisibilityCB *const func, void *const user=NULL) — add a visibility-change callback, with user=NULL by default.
  • void removeVisibilityChangeCallback (SoQtComponentVisibilityCB *const func, void *const user=NULL) — remove one.

👑 Additional Inherited Members

The whole extended family tree, no cap:

🧚 Public Types inherited from SoQtFullViewer

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

⭐ 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) — hand it the default redraw priority. Static, so no object needed, slay.

💜 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 the classes (plural version, careful 👀).

🎀 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) — plain init, yes, separate from initClass.

🌈 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 real talk: SoQtConstrainedViewer is the superclass for viewers that put constraints on the viewpoint. It's abstract, bestie, so you don't instantiate it directly.

This abstract viewer class adds new methods to keep the camera in an upright position according to some arbitrary up-direction. That up-direction can be decided by either the application programmer — by using SoQtConstrainedViewer::setUpDirection() — or by the end-user, through the interaction mechanisms that the subclasses define. iykyk 👑

✨ Constructor & Destructor Documentation

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

Constructor. That's it, that's the whole ~~vibe~~ description ✨

🎀 SoQtConstrainedViewer::~SoQtConstrainedViewer () [protected]

Virtual destructor. Clean up after yourself, queen 💅

🦋 Member Function Documentation

💫 void SoQtConstrainedViewer::setUpDirection (const SbVec3f & dir)

Set the up-direction vector for the camera viewpoint. This is you deciding which way is up, literally 🌈

⭐ const SbVec3f & SoQtConstrainedViewer::getUpDirection (void ) const

Return the up-direction vector for the camera viewpoint.

🔥 void SoQtConstrainedViewer::setCamera (SoCamera * cam) [virtual]

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

bestie READ THIS PART 👀 the camera you pass 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.

So what you actually do is: 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. And if no camera is available in the scene graph at all? It'll set up its own camera. Self-sufficient icon behaviour, honestly 🫶

See also: getCamera()

Reimplemented from SoQtViewer.

Reimplemented in SoQtFlyViewer.

💜 void SoQtConstrainedViewer::saveHomePosition (void ) [virtual]

Store the current camera settings for later retrieval with resetToHomePosition().

See also: resetToHomePosition()

Reimplemented from SoQtViewer.

🧚 void SoQtConstrainedViewer::resetToHomePosition (void ) [virtual]

Restore the saved camera settings. Home sweet home 🏠✨

See also: saveHomePosition()

Reimplemented from SoQtViewer.

Reimplemented in SoQtFlyViewer.

🍓 void SoQtConstrainedViewer::tiltCamera (float delta) [protected], [virtual]

This method tilts the camera delta degrees closer to the up direction.

🌈 void SoQtConstrainedViewer::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 SoQtConstrainedViewer::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 SoQtConstrainedViewer::changeCameraValues (SoCamera * camera) [protected], [virtual]

Copies the settings of camera into our current camera. Cameras must be of the same class type — no mixing, no matching, no exceptions 💀

Reimplemented from SoQtViewer.

⭐ void SoQtConstrainedViewer::findUpDirection (SbVec2s mouselocation) [protected]

Executes a ray pick at the given mouse pointer location and sets the viewer's camera up-vector direction to the normal vector of the picked geometry. Point at a thing, up becomes that thing's normal — science, fr fr 🧚

💅 void SoQtConstrainedViewer::checkForCameraUpConstrain (void ) [protected]

If necessary, "tilts" the camera sideways so the up-direction is heeded. Yes, "constrain" — that's the spelling, don't come for me 🙈

👑 Author

Generated automatically by Doxygen for SoQt from the source code. Not a human, not a vibe, just a robot doing its best 🫡

aaaand that's the whole page!! 💖 this was documented for SoQt version 1.6.2, stamped Sat Jan 6 2024 12:20:55 — go forth and keep that camera upright, bestie, SoQtConstrainedViewer(3) out 🎀✨

📦 where this page comes from