SoWx  0.1.0
Coin3D GUI toolkit binding
Loading...
Searching...
No Matches
SoWxExaminerViewer Class Reference

The SoWxExaminerViewer class is a 3D-model examination viewer. More...

#include <Inventor/Wx/viewers/SoWxExaminerViewer.h>

Inheritance diagram for SoWxExaminerViewer:
SoWxFullViewer SoWxViewer SoWxRenderArea SoWxGLWidget SoWxComponent SoWxObject

Public Member Functions

 SoWxExaminerViewer (wxWindow *parent=NULL, const char *name=NULL, SbBool embed=TRUE, SoWxFullViewer::BuildFlag flag=BUILD_ALL, SoWxViewer::Type type=BROWSER)
 
int getFeedbackSize (void) const
 
SbBool isAnimating (void) const
 
SbBool isAnimationEnabled (void) const
 
SbBool isFeedbackVisible (void) const
 
void setAnimationEnabled (const SbBool enable)
 
virtual void setCamera (SoCamera *camera)
 
virtual void setCursorEnabled (SbBool enable)
 
void setFeedbackSize (const int size)
 
void setFeedbackVisibility (const SbBool enable)
 
virtual void setViewing (SbBool enable)
 
void stopAnimating (void)
 
- Public Member Functions inherited from SoWxFullViewer
void addAppPushButton (wxWindow *newButton)
 
int findAppPushButton (wxWindow *oldButton) const
 
wxWindow * getAppPushButtonParent (void) const
 
wxWindow * getRenderAreaWidget (void) const
 
void insertAppPushButton (wxWindow *newButton, int index)
 
SbBool isDecoration (void) const
 
SbBool isPopupMenuEnabled (void) const
 
int lengthAppPushButton (void) const
 
void removeAppPushButton (wxWindow *oldButton)
 
virtual void setComponentCursor (const SoWxCursor &cursor)
 
void setDecoration (const SbBool on)
 
void setPopupMenuEnabled (const SbBool on)
 
- Public Member Functions inherited from SoWxViewer
void addFinishCallback (SoWxViewerCB *func, void *data=NULL)
 
void addStartCallback (SoWxViewerCB *func, void *data=NULL)
 
void getAnaglyphStereoColorMasks (SbBool left[3], SbBool right[3])
 
SoWxViewer::BufferType getBufferingType (void) const
 
SoCamera * getCamera (void) const
 
SoType getCameraType (void) const
 
SoWxViewer::DrawStyle getDrawStyle (const SoWxViewer::DrawType type) const
 
SoDirectionalLight * getHeadlight (void) const
 
virtual SoNode * getSceneGraph (void)
 
float getSeekTime (void) const
 
float getStereoOffset (void) const
 
SoWxViewer::StereoType getStereoType (void) const
 
const SbColor & getWireframeOverlayColor (void) const
 
SbBool isAutoClipping (void) const
 
SbBool isCursorEnabled (void) const
 
SbBool isDetailSeek (void) const
 
SbBool isHeadlight (void) const
 
SbBool isStereoViewing (void) const
 
SbBool isViewing (void) const
 
void removeFinishCallback (SoWxViewerCB *func, void *data=NULL)
 
void removeStartCallback (SoWxViewerCB *func, void *data=NULL)
 
virtual void resetToHomePosition (void)
 
virtual void saveHomePosition (void)
 
void setAnaglyphStereoColorMasks (const SbBool left[3], const SbBool right[3])
 
void setAutoClipping (SbBool enable)
 
void setAutoClippingStrategy (const AutoClippingStrategy strategy, const float value=0.6f, SoWxAutoClippingCB *cb=NULL, void *cbuserdata=NULL)
 
virtual void setBufferingType (SoWxViewer::BufferType type)
 
virtual void setCameraType (SoType type)
 
void setDetailSeek (const SbBool enable)
 
virtual void setDoubleBuffer (const SbBool enable)
 
virtual void setDrawStyle (SoWxViewer::DrawType type, SoWxViewer::DrawStyle style)
 
virtual void setHeadlight (SbBool enable)
 
virtual void setSceneGraph (SoNode *root)
 
void setSeekTime (const float seconds)
 
virtual void setStereoOffset (const float dist)
 
SbBool setStereoType (SoWxViewer::StereoType s)
 
virtual void setStereoViewing (SbBool enable)
 
void setWireframeOverlayColor (const SbColor &color)
 
virtual void toggleCameraType (void)
 
virtual void viewAll (void)
 
- Public Member Functions inherited from SoWxRenderArea
 SoWxRenderArea (wxWindow *parent=NULL, const char *name=NULL, SbBool embed=TRUE, SbBool mouseInput=TRUE, SbBool keyboardInput=TRUE)
 
 ~SoWxRenderArea ()
 
void getAntialiasing (SbBool &smoothing, int &numPasses) const
 
const SbColor & getBackgroundColor (void) const
 
int getBackgroundIndex (void) const
 
SoGLRenderAction * getGLRenderAction (void) const
 
int getOverlayBackgroundIndex (void) const
 
SoGLRenderAction * getOverlayGLRenderAction (void) const
 
SoNode * getOverlaySceneGraph (void)
 
SoSceneManager * getOverlaySceneManager (void) const
 
uint32_t getRedrawPriority (void) const
 
SoSceneManager * getSceneManager (void) const
 
SoGLRenderAction::TransparencyType getTransparencyType (void) const
 
const SbViewportRegion & getViewportRegion (void) const
 
SbBool isAutoRedraw (void) const
 
SbBool isClearBeforeOverlayRender (void) const
 
SbBool isClearBeforeRender (void) const
 
SbBool isClearZBufferBeforeRender (void) const
 
void redrawOnSelectionChange (SoSelection *selection)
 
void redrawOverlayOnSelectionChange (SoSelection *selection)
 
void registerDevice (SoWxDevice *device)
 
void render (void)
 
void renderOverlay (void)
 
void scheduleOverlayRedraw (void)
 
void scheduleRedraw (void)
 
SbBool sendSoEvent (const SoEvent *event)
 
void setAntialiasing (SbBool smoothing, int numPasses)
 
void setAutoRedraw (SbBool enable)
 
void setBackgroundColor (const SbColor &color)
 
void setBackgroundIndex (int idx)
 
void setClearBeforeOverlayRender (SbBool enable)
 
void setClearBeforeRender (SbBool enable, SbBool zbEnable=TRUE)
 
void setColorMap (int start, int num, const SbColor *colors)
 
void setEventCallback (SoWxRenderAreaEventCB *func, void *user=NULL)
 
void setGLRenderAction (SoGLRenderAction *action)
 
void setOverlayBackgroundIndex (int idx)
 
void setOverlayColorMap (int start, int num, const SbColor *colors)
 
void setOverlayGLRenderAction (SoGLRenderAction *action)
 
void setOverlaySceneGraph (SoNode *scene)
 
void setOverlaySceneManager (SoSceneManager *manager)
 
void setRedrawPriority (uint32_t priority)
 
void setSceneManager (SoSceneManager *manager)
 
void setTransparencyType (SoGLRenderAction::TransparencyType type)
 
void setViewportRegion (const SbViewportRegion &newRegion)
 
void unregisterDevice (SoWxDevice *device)
 
- Public Member Functions inherited from SoWxGLWidget
SbBool getAccumulationBuffer (void) const
 
SbBool getAlphaChannel (void) const
 
wxWindow * getGLWidget (void) const
 
void getLineWidthLimits (SbVec2f &range, float &granularity)
 
wxWindow * getNormalWidget (void) const
 
unsigned long getOverlayTransparentPixel (void)
 
wxWindow * getOverlayWidget (void) const
 
void getPointSizeLimits (SbVec2f &range, float &granularity)
 
int getSampleBuffers (void) const
 
SbBool getStencilBuffer (void) const
 
SbBool hasNormalGLArea (void) const
 
SbBool hasOverlayGLArea (void) const
 
SbBool isBorder (void) const
 
SbBool isDoubleBuffer (void) const
 
SbBool isDrawToFrontBufferEnable (void) const
 
SbBool isOverlayRender (void) const
 
SbBool isQuadBufferStereo (void) const
 
SbBool isStealFocus (void) const
 
void setAccumulationBuffer (const SbBool enable)
 
void setAlphaChannel (const SbBool enable)
 
void setBorder (const SbBool enable)
 
void setDrawToFrontBufferEnable (const SbBool enable)
 
void setOverlayRender (const SbBool onoff)
 
void setQuadBufferStereo (const SbBool enable)
 
void setSampleBuffers (const int numsamples)
 
void setStealFocus (SbBool enable)
 
void setStencilBuffer (const SbBool enable)
 
- Public Member Functions inherited from SoWxComponent
virtual ~SoWxComponent ()
 
wxWindow * getBaseWidget (void) const
 
const char * getClassName (void) const
 
const char * getIconTitle (void) const
 
wxWindow * getParentWidget (void) const
 
wxWindow * getShellWidget (void) const
 
SbVec2s getSize (void) const
 
const char * getTitle (void) const
 
wxWindow * getWidget (void) const
 
const char * getWidgetName (void) const
 
virtual void hide (void)
 
SbBool isFullScreen (void) const
 
SbBool isTopLevelShell (void) const
 
SbBool isVisible (void)
 
SbBool setFullScreen (const SbBool onoff)
 
void setIconTitle (const char *const title)
 
void setSize (const SbVec2s size)
 
void setTitle (const char *const title)
 
void setWindowCloseCallback (SoWxComponentCB *const func, void *const user=NULL)
 
virtual void show (void)
 
- Public Member Functions inherited from SoWxObject
virtual SoType getTypeId (void) const =0
 
SbBool isOfType (SoType type) const
 

Protected Member Functions

 SoWxExaminerViewer (wxWindow *parent, const char *name, SbBool embed, SoWxFullViewer::BuildFlag flag, SoWxViewer::Type type, SbBool build)
 
virtual void actualRedraw (void)
 
virtual void afterRealizeHook (void)
 
virtual void bottomWheelMotion (float val)
 
virtual void createViewerButtons (wxWindow *parent, SbPList *buttonlist)
 
virtual const char * getDefaultIconTitle (void) const
 
virtual const char * getDefaultTitle (void) const
 
virtual const char * getDefaultWidgetName (void) const
 
virtual void leftWheelMotion (float val)
 
virtual SbBool processSoEvent (const SoEvent *const event)
 
virtual void rightWheelMotion (float val)
 
virtual void setSeekMode (SbBool enable)
 
- Protected Member Functions inherited from SoWxFullViewer
 SoWxFullViewer (wxWindow *parent, const char *name, SbBool embed, BuildFlag flag, Type type, SbBool build)
 
 ~SoWxFullViewer ()
 
virtual void bottomWheelFinish (void)
 
virtual void bottomWheelStart (void)
 
wxWindow * buildAppButtons (wxWindow *parent)
 
virtual wxWindow * buildBottomTrim (wxWindow *parent)
 
virtual void buildDecoration (wxWindow *parent)
 
virtual wxWindow * buildLeftTrim (wxWindow *parent)
 
virtual void buildPopupMenu (void)
 
virtual wxWindow * buildRightTrim (wxWindow *parent)
 
wxWindow * buildViewerButtons (wxWindow *parent)
 
wxWindow * buildWidget (wxWindow *parent)
 
wxWindow * getBottomWheelLabelWidget (void) const
 
float getBottomWheelValue (void) const
 
wxWindow * getLeftWheelLabelWidget (void) const
 
float getLeftWheelValue (void) const
 
wxWindow * getRightWheelLabelWidget (void) const
 
const char * getRightWheelString () const
 
float getRightWheelValue (void) const
 
virtual void leftWheelFinish (void)
 
virtual void leftWheelStart (void)
 
virtual void openPopupMenu (const SbVec2s position)
 
virtual void rightWheelFinish (void)
 
virtual void rightWheelStart (void)
 
void setBottomWheelString (const char *const name)
 
void setBottomWheelValue (const float value)
 
void setLeftWheelString (const char *const name)
 
void setLeftWheelValue (const float value)
 
virtual void setPopupMenuString (const char *title)
 
void setRightWheelString (const char *const name)
 
void setRightWheelValue (const float value)
 
virtual void sizeChanged (const SbVec2s &size)
 
- Protected Member Functions inherited from SoWxViewer
 SoWxViewer (wxWindow *parent, const char *name, SbBool embed, Type type, SbBool build)
 
 ~SoWxViewer ()
 
void addSuperimposition (SoNode *scene)
 
virtual void changeCameraValues (SoCamera *camera)
 
virtual void computeSeekFinalOrientation (void)
 
int getInteractiveCount (void) const
 
float getSeekDistance (void) const
 
SbBool getSuperimpositionEnabled (SoNode *scene) const
 
void interactiveCountDec (void)
 
void interactiveCountInc (void)
 
SbBool isSeekMode (void) const
 
SbBool isSeekValuePercentage (void) const
 
void removeSuperimposition (SoNode *scene)
 
SbBool seekToPoint (const SbVec2s screenpos)
 
void seekToPoint (const SbVec3f &scenepos)
 
void setSeekDistance (const float distance)
 
void setSeekValueAsPercentage (const SbBool on)
 
void setSuperimpositionEnabled (SoNode *scene, const SbBool enable)
 
- Protected Member Functions inherited from SoWxRenderArea
 SoWxRenderArea (wxWindow *parent, const char *name, SbBool embed, SbBool mouseInput, SbBool keyboardInput, SbBool build)
 
virtual void actualOverlayRedraw (void)
 
wxWindow * buildWidget (wxWindow *parent)
 
virtual SbBool glScheduleRedraw (void)
 
virtual void initGraphic (void)
 
virtual void initOverlayGraphic (void)
 
virtual void processEvent (wxEvent &event)
 
virtual void redraw (void)
 
virtual void redrawOverlay (void)
 
virtual void widgetChanged (wxWindow *widget)
 
- Protected Member Functions inherited from SoWxGLWidget
 SoWxGLWidget (wxWindow *const parent=NULL, const char *const name=NULL, const SbBool embed=TRUE, const int glmodes=SO_GL_RGB, const SbBool build=TRUE)
 
 ~SoWxGLWidget ()
 
wxWindow * buildWidget (wxWindow *parent)
 
float getGLAspectRatio (void) const
 
SbVec2s getGLSize (void) const
 
float getGlxAspectRatio (void) const
 
SbVec2s getGlxSize (void) const
 
void glFlushBuffer (void)
 
void glLockNormal (void)
 
void glLockOverlay (void)
 
void glSwapBuffers (void)
 
void glUnlockNormal (void)
 
void glUnlockOverlay (void)
 
SbBool isRGBMode (void)
 
SbBool isStereoBuffer (void) const
 
void setGLSize (const SbVec2s size)
 
void setGlxSize (const SbVec2s size)
 
void setStereoBuffer (SbBool flag)
 
- Protected Member Functions inherited from SoWxComponent
 SoWxComponent (wxWindow *const parent=NULL, const char *const name=NULL, const SbBool embed=TRUE)
 
void addVisibilityChangeCallback (SoWxComponentVisibilityCB *const func, void *const user=NULL)
 
void registerWidget (wxWindow *widget)
 
void removeVisibilityChangeCallback (SoWxComponentVisibilityCB *const func, void *const user=NULL)
 
void setBaseWidget (wxWindow *widget)
 
void setClassName (const char *const name)
 
void unregisterWidget (wxWindow *widget)
 

Additional Inherited Members

- Public Types inherited from SoWxFullViewer
enum  BuildFlag { BUILD_NONE = 0x00 , BUILD_DECORATION = 0x01 , BUILD_POPUP = 0x02 , BUILD_ALL = (BUILD_DECORATION | BUILD_POPUP) }
 
- Public Types inherited from SoWxViewer
enum  AutoClippingStrategy { VARIABLE_NEAR_PLANE , CONSTANT_NEAR_PLANE }
 
enum  BufferType { BUFFER_SINGLE , BUFFER_DOUBLE , BUFFER_INTERACTIVE }
 
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  StereoType {
  STEREO_NONE , STEREO_ANAGLYPH , STEREO_QUADBUFFER , STEREO_INTERLEAVED_ROWS ,
  STEREO_INTERLEAVED_COLUMNS
}
 
enum  Type { BROWSER , EDITOR }
 
- Static Public Member Functions inherited from SoWxRenderArea
static uint32_t getDefaultRedrawPriority (void)
 
- Static Public Member Functions inherited from SoWxComponent
static SoWxComponentgetComponent (wxWindow *widget)
 
static void initClasses (void)
 
static void setWidgetCursor (wxWindow *w, const SoWxCursor &cursor)
 
- Static Public Member Functions inherited from SoWxObject
static SoType getClassTypeId (void)
 
static void init (void)
 
static void initClass (void)
 
- Protected Attributes inherited from SoWxFullViewer
wxWindow * bottomDecoration
 
wxWindow * bottomWheel
 
wxWindow * bottomWheelLabel
 
char * bottomWheelStr
 
float bottomWheelVal
 
wxWindow * leftDecoration
 
wxWindow * leftWheel
 
wxWindow * leftWheelLabel
 
char * leftWheelStr
 
float leftWheelVal
 
SoWxPopupMenu * prefmenu
 
wxWindow * rightDecoration
 
wxWindow * rightWheel
 
wxWindow * rightWheelLabel
 
char * rightWheelStr
 
float rightWheelVal
 
- Protected Attributes inherited from SoWxGLWidget
SbBool drawToFrontBuffer
 
SbBool waitForExpose
 
- Protected Attributes inherited from SoWxComponent
SbBool firstRealize
 

Detailed Description

The SoWxExaminerViewer class is a 3D-model examination viewer.

This class is the viewer considered to be the most "general purpose" viewer, and it is often used in rapid prototyping to examine simple models as well as complete scenes (although for the latter, you might be better off with one of the other viewer classes).

Here is a complete, stand-alone example that shows how to set up an SoWxExaminerViewer as a model viewer that loads Inventor and VRML files from disk and places them inside the viewer for the end-user to examine:

#include <Inventor/Wx/SoWx.h>
#include <Inventor/Wx/viewers/SoWxExaminerViewer.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 SoWx and Inventor API libraries. This returns a main
// window to use.
wxWindow* mainwin = SoWx::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.
SoWxExaminerViewer * viewer = new SoWxExaminerViewer(mainwin);
viewer->setSceneGraph(root);
viewer->show();
// Pop up the main window.
SoWx::show(mainwin);
// Loop until exit.
// Clean up resources.
delete viewer;
root->unref();
return 0;
}
virtual void show(void)
Definition SoWxComponent.cpp:183
The SoWxExaminerViewer class is a 3D-model examination viewer.
Definition SoWxExaminerViewer.h:50
SoWxExaminerViewer(wxWindow *parent=NULL, const char *name=NULL, SbBool embed=TRUE, SoWxFullViewer::BuildFlag flag=BUILD_ALL, SoWxViewer::Type type=BROWSER)
virtual void setSceneGraph(SoNode *root)
Definition SoWxViewer.cpp:2841
static wxWindow * init(const char *appname, const char *classname="SoWx")
Definition SoWxCommon.cpp:173
static void mainLoop(void)
mainLoop is required only if an external app is not available (embedded in already existing window).
Definition SoWx.cpp:145

SoWxExaminerViewer has a convenient interface for repositioning and reorientation of the camera, by panning, rotating and zooming its position. The following controls can be used:

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

It also inherits the decoration buttons from the SoWxFullViewer: the arrow for switching to "scene graph interaction" mode, the hand for setting back to "camera interaction" mode, the house for "reset camera to home position", the blueprint house for "set new camera home position", the eye for "zoom camera out to view full scene" and the flashlight for setting "click to seek" mode.

Note that a common faulty assumption about all the viewer-classes is that user interaction (in the "examine"-mode, not the scene graph-interaction mode) influences the model or 3D-scene in the view. This is not correct, as it is always the viewer's camera that is translated and rotated.

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

See also
SoWxFlyViewer, SoWxPlaneViewer

Constructor & Destructor Documentation

◆ SoWxExaminerViewer() [1/2]

SoWxExaminerViewer::SoWxExaminerViewer ( wxWindow * parent = NULL,
const char * name = NULL,
SbBool embed = TRUE,
SoWxFullViewer::BuildFlag flag = BUILD_ALL,
SoWxViewer::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.

◆ SoWxExaminerViewer() [2/2]

SoWxExaminerViewer::SoWxExaminerViewer ( wxWindow * parent,
const char * name,
SbBool embed,
SoWxFullViewer::BuildFlag flag,
SoWxViewer::Type type,
SbBool build )
protected

Constructor. See parent class for explanation of arguments.

Member Function Documentation

◆ actualRedraw()

void SoWxExaminerViewer::actualRedraw ( void )
protectedvirtual

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/Wx/SoWx.h>
#include <Inventor/Wx/viewers/SoWxExaminerViewer.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 SoWxExaminerViewer {
public:
MyExaminerViewer(wxWindow* parent, const char * filename);
~MyExaminerViewer();
protected:
virtual void actualRedraw(void);
private:
SoSeparator * bckgroundroot;
SoSeparator * foregroundroot;
SoRotationXYZ * arrowrotation;
};
MyExaminerViewer::MyExaminerViewer(wxWindow* parent, const char * filename)
{
// Coin should not clear the pixel-buffer, so the background image
// is not removed.
this->setClearBeforeRender(FALSE, TRUE);
// Set up background scene graph with image in it.
this->bckgroundroot = new SoSeparator;
this->bckgroundroot->ref();
SoOrthographicCamera * cam = new SoOrthographicCamera;
cam->position = SbVec3f(0, 0, 1);
cam->height = 1;
// SoImage will be at z==0.0.
cam->nearDistance = 0.5;
cam->farDistance = 1.5;
SoImage * img = new SoImage;
img->vertAlignment = SoImage::HALF;
img->horAlignment = SoImage::CENTER;
img->filename = filename;
this->bckgroundroot->addChild(cam);
this->bckgroundroot->addChild(img);
// Set up foreground, overlaid scene graph.
this->foregroundroot = new SoSeparator;
this->foregroundroot->ref();
SoLightModel * lm = new SoLightModel;
lm->model = SoLightModel::BASE_COLOR;
SoBaseColor * bc = new SoBaseColor;
bc->rgb = SbColor(1, 1, 0);
cam = new SoOrthographicCamera;
cam->position = SbVec3f(0, 0, 5);
cam->height = 10;
cam->nearDistance = 0;
cam->farDistance = 10;
const double ARROWSIZE = 2.0;
SoTranslation * posit = new SoTranslation;
posit->translation = SbVec3f(-2.5 * ARROWSIZE, 1.5 * ARROWSIZE, 0);
arrowrotation = new SoRotationXYZ;
arrowrotation->axis = SoRotationXYZ::Z;
SoTranslation * offset = new SoTranslation;
offset->translation = SbVec3f(ARROWSIZE/2.0, 0, 0);
SoCube * cube = new SoCube;
cube->width = ARROWSIZE;
cube->height = ARROWSIZE/15.0;
this->foregroundroot->addChild(cam);
this->foregroundroot->addChild(lm);
this->foregroundroot->addChild(bc);
this->foregroundroot->addChild(posit);
this->foregroundroot->addChild(arrowrotation);
this->foregroundroot->addChild(offset);
this->foregroundroot->addChild(cube);
}
MyExaminerViewer::~MyExaminerViewer()
{
this->bckgroundroot->unref();
this->foregroundroot->unref();
}
void
MyExaminerViewer::actualRedraw(void)
{
// Must set up the OpenGL viewport manually, as upon resize
// operations, Coin won't set it up until the SoGLRenderAction is
// applied again. And since we need to do glClear() before applying
// the action..
const SbViewportRegion vp = this->getViewportRegion();
SbVec2s origin = vp.getViewportOriginPixels();
SbVec2s size = vp.getViewportSizePixels();
glViewport(origin[0], origin[1], size[0], size[1]);
const SbColor col = this->getBackgroundColor();
glClearColor(col[0], col[1], col[2], 0.0f);
glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT);
// Render our scene graph with the image.
SoGLRenderAction * glra = this->getGLRenderAction();
glra->apply(this->bckgroundroot);
// Render normal scene graph.
// 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);
}
wxWindow* window = SoWx::init(argv[0]);
MyExaminerViewer * viewer = new MyExaminerViewer(window, argv[1]);
viewer->setSceneGraph(new SoCone);
viewer->show();
SoWx::show(window);
delete viewer;
return 0;
}
// *************************************************************************
virtual void actualRedraw(void)
Definition SoWxExaminerViewer.cpp:663

Reimplemented from SoWxViewer.

◆ afterRealizeHook()

void SoWxExaminerViewer::afterRealizeHook ( void )
protectedvirtual

A function "hook" / callback invoked just after the window for the component has been realized.

Override this if you need specific initialization for your own component or viewer class to happen right after it has been made visible, but remember to call upwards in the inheritance hierarchy:

void
MyLittleViewer::afterRealizeHook(void)
{
<superclass>::afterRealizeHook();
// [own initialization here]
}
virtual void afterRealizeHook(void)
Definition SoWxExaminerViewer.cpp:688

Reimplemented from SoWxRenderArea.

◆ bottomWheelMotion()

void SoWxExaminerViewer::bottomWheelMotion ( float value)
protectedvirtual

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

◆ createViewerButtons()

void SoWxExaminerViewer::createViewerButtons ( wxWindow * parent,
SbPList * buttonlist )
protectedvirtual

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 SoWxExaminerViewer:

class MyExaminerViewer : public SoWxExaminerViewer {
public:
MyExaminerViewer(wxWindow* parent);
protected:
virtual void createViewerButtons(wxWindow* parent, SbPList * buttonlist);
};
MyExaminerViewer::MyExaminerViewer(wxWindow* parent)
: SoWxExaminerViewer(parent, NULL, TRUE,
// build == FALSE, to delay creation of decorations
FALSE)
{
// Explicitly trigger the construction of viewer decorations.
wxWindow* widget = this->buildWidget(this->getParentWidget());
this->setBaseWidget(widget);
}
void
MyExaminerViewer::createViewerButtons(wxWindow* parent, SbPList * buttonlist)
{
// [now add your own button(s) to the buttonlist]
}
virtual void createViewerButtons(wxWindow *parent, SbPList *buttonlist)
Definition ExaminerViewer.cpp:111
The SoWxFullViewer class adds some user interface components to the viewer canvas.
Definition SoWxFullViewer.h:44
@ BUILD_ALL
Definition SoWxFullViewer.h:52
@ BROWSER
Definition SoWxViewer.h:95

Reimplemented from SoWxFullViewer.

◆ getDefaultIconTitle()

const char * SoWxExaminerViewer::getDefaultIconTitle ( void ) const
protectedvirtual

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

◆ getDefaultTitle()

const char * SoWxExaminerViewer::getDefaultTitle ( void ) const
protectedvirtual

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

◆ getDefaultWidgetName()

const char * SoWxExaminerViewer::getDefaultWidgetName ( void ) const
protectedvirtual

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

◆ getFeedbackSize()

int SoWxExaminerViewer::getFeedbackSize ( void ) const

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

See also
setFeedbackSize, isFeedbackVisible, setFeedbackVisibility

◆ isAnimating()

SbBool SoWxExaminerViewer::isAnimating ( void ) const

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

◆ isAnimationEnabled()

SbBool SoWxExaminerViewer::isAnimationEnabled ( void ) const

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

See also
setAnimationEnabled

◆ isFeedbackVisible()

SbBool SoWxExaminerViewer::isFeedbackVisible ( void ) const

Check if the feedback axis cross is visible.

See also
setFeedbackVisibility, getFeedbackSize, setFeedbackSize

◆ leftWheelMotion()

void SoWxExaminerViewer::leftWheelMotion ( float value)
protectedvirtual

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

◆ processSoEvent()

SbBool SoWxExaminerViewer::processSoEvent ( const SoEvent *const event)
protectedvirtual

Toolkit-native events are tried to convert to Coin-generic events in the SoWxRenderArea::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 SoWxFullViewer.

◆ rightWheelMotion()

void SoWxExaminerViewer::rightWheelMotion ( float value)
protectedvirtual

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

◆ setAnimationEnabled()

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

See also
isAnimationEnabled

◆ setCamera()

void SoWxExaminerViewer::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 SoWxViewer.

◆ setCursorEnabled()

void SoWxExaminerViewer::setCursorEnabled ( SbBool enable)
virtual

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

Reimplemented from SoWxViewer.

◆ setFeedbackSize()

void SoWxExaminerViewer::setFeedbackSize ( const int size)

Set the size of the feedback axis cross. The value is interpreted as an approximate percentage chunk of the dimensions of the total canvas.

See also
getFeedbackSize, isFeedbackVisible, setFeedbackVisibility

◆ setFeedbackVisibility()

void SoWxExaminerViewer::setFeedbackVisibility ( const SbBool enable)

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

See also
isFeedbackVisible, getFeedbackSize, setFeedbackSize

◆ setSeekMode()

void SoWxExaminerViewer::setSeekMode ( SbBool enable)
protectedvirtual

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

◆ setViewing()

void SoWxExaminerViewer::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 SoWxFullViewer.

◆ stopAnimating()

void SoWxExaminerViewer::stopAnimating ( void )

Stop the model from spinning.


The documentation for this class was generated from the following files: