SoQtConstrainedViewer - Man Page

The SoQtConstrainedViewer class is the superclass for viewers with constrains on the viewpoint.

Synopsis

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

Inherits SoQtFullViewer.

Inherited by SoQtFlyViewer.

Public Member Functions

void setUpDirection (const SbVec3f &dir)
const SbVec3f & getUpDirection (void) const
virtual void setCamera (SoCamera *newcam)
virtual void saveHomePosition (void)
virtual void resetToHomePosition (void)

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

Public Member Functions inherited from SoQtViewer
SoCamera * getCamera (void) const
virtual void setCameraType (SoType type)
SoType getCameraType (void) const
virtual void toggleCameraType (void)
virtual void viewAll (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
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
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
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
virtual SoType getTypeId (void) const =0
SbBool isOfType (SoType type) const

Protected Member Functions

SoQtConstrainedViewer (QWidget *parent, const char *const name, SbBool embed, SoQtFullViewer::BuildFlag flag, SoQtViewer::Type type, SbBool build)
~SoQtConstrainedViewer ()
virtual void tiltCamera (float delta)
virtual void bottomWheelMotion (float value)
virtual void leftWheelMotion (float value)
virtual void changeCameraValues (SoCamera *camera)
void findUpDirection (SbVec2s mouselocation)
void checkForCameraUpConstrain (void)

Protected Member Functions inherited from SoQtFullViewer
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 leftWheelFinish (void)
float getLeftWheelValue (void) const
void setLeftWheelValue (const float value)
virtual void bottomWheelStart (void)
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 inherited from SoQtViewer
SoQtViewer (QWidget *parent, const char *name, SbBool embed, Type type, SbBool build)
~SoQtViewer ()
virtual void setSeekMode (SbBool enable)
SbBool isSeekMode (void) const
SbBool seekToPoint (const SbVec2s screenpos)
void seekToPoint (const SbVec3f &scenepos)
virtual void computeSeekFinalOrientation (void)
virtual void actualRedraw (void)
void interactiveCountInc (void)
void interactiveCountDec (void)
int getInteractiveCount (void) const
void setSeekDistance (const float distance)
float getSeekDistance (void) const
void setSeekValueAsPercentage (const SbBool on)
SbBool isSeekValuePercentage (void) const
void addSuperimposition (SoNode *scene)
void removeSuperimposition (SoNode *scene)
void setSuperimpositionEnabled (SoNode *scene, const SbBool enable)
SbBool getSuperimpositionEnabled (SoNode *scene) const

Protected Member Functions inherited from SoQtRenderArea
SoQtRenderArea (QWidget *parent, const char *name, SbBool embed, SbBool mouseInput, SbBool keyboardInput, SbBool build)
virtual void redraw (void)
virtual void redrawOverlay (void)
virtual void actualOverlayRedraw (void)
virtual void processEvent (QEvent *event)
virtual void initGraphic (void)
virtual void initOverlayGraphic (void)
virtual void widgetChanged (QWidget *widget)
virtual void afterRealizeHook (void)
QWidget * buildWidget (QWidget *parent)
virtual const char * getDefaultWidgetName (void) const
virtual const char * getDefaultTitle (void) const
virtual const char * getDefaultIconTitle (void) const
virtual SbBool glScheduleRedraw (void)

Protected Member Functions inherited from SoQtGLWidget
SoQtGLWidget (QWidget *const parent=NULL, const char *const name=NULL, const SbBool embed=TRUE, const int glmodes=SO_GL_RGB, const SbBool build=TRUE)
~SoQtGLWidget ()
QWidget * buildWidget (QWidget *parent)
void setGLSize (const SbVec2s size)
SbVec2s getGLSize (void) const
float getGLAspectRatio (void) const
void setGlxSize (const SbVec2s size)
SbVec2s getGlxSize (void) const
float getGlxAspectRatio (void) const
void setStereoBuffer (SbBool flag)
SbBool isStereoBuffer (void) const
SbBool isRGBMode (void)
void glLockNormal (void)
void glUnlockNormal (void)
void glLockOverlay (void)
void glUnlockOverlay (void)
void glSwapBuffers (void)
void glFlushBuffer (void)

Protected Member Functions inherited from SoQtComponent
SoQtComponent (QWidget *const parent=NULL, const char *const name=NULL, const SbBool embed=TRUE)
void setClassName (const char *const name)
void setBaseWidget (QWidget *widget)
void registerWidget (QWidget *widget)
void unregisterWidget (QWidget *widget)
void addVisibilityChangeCallback (SoQtComponentVisibilityCB *const func, void *const user=NULL)
void removeVisibilityChangeCallback (SoQtComponentVisibilityCB *const func, void *const user=NULL)

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

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)

Static Public Member Functions inherited from SoQtComponent
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

The SoQtConstrainedViewer class is the superclass for viewers with constrains on the viewpoint.

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

Constructor & Destructor Documentation

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

Constructor.

SoQtConstrainedViewer::~SoQtConstrainedViewer () [protected]

Virtual destructor.

Member Function Documentation

void SoQtConstrainedViewer::setUpDirection (const SbVec3f & dir)

Set up-direction vector for the camera viewpoint.

const SbVec3f & SoQtConstrainedViewer::getUpDirection (void) const

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

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.

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.

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.

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.

void SoQtConstrainedViewer::checkForCameraUpConstrain (void) [protected]

If necessary, 'tilts' the camera sideways so the up-direction is heeded.

Author

Generated automatically by Doxygen for SoQt from the source code.

Info

Version 1.6.0 SoQt