Click or drag to resize
SoWinExaminerViewer Class

Viewer component which uses a virtual trackball to view the data.

Inheritance Hierarchy

Namespace: OIV.Inventor.Win.Viewers
Assembly: OIV.Inventor.Win (in OIV.Inventor.Win.dll) Version: 2024.1.0.0 (2024.1.0)
Syntax
public class SoWinExaminerViewer : SoWinFullViewer

The SoWinExaminerViewer type exposes the following members.

Constructors
  NameDescription
Public methodSoWinExaminerViewer
Calls SoWinExaminerViewer((System.Windows.Forms.Control ^)nullptr, (System.String ^)nullptr, true, OIV.Inventor.Win.Viewers.SoWinFullViewer.BuildFlags( .SoWinFullViewer.BUILD_ALL ), OIV.Inventor.Win.Viewers.SoWinViewer.Types( .SoWinViewer.BROWSER )).
Public methodSoWinExaminerViewer(Control)
Calls SoWinExaminerViewer(parent, (System.String ^)nullptr, true, OIV.Inventor.Win.Viewers.SoWinFullViewer.BuildFlags( .SoWinFullViewer.BUILD_ALL ), OIV.Inventor.Win.Viewers.SoWinViewer.Types( .SoWinViewer.BROWSER )).
Public methodSoWinExaminerViewer(Control, String)
Calls SoWinExaminerViewer(parent, name, true, OIV.Inventor.Win.Viewers.SoWinFullViewer.BuildFlags( .SoWinFullViewer.BUILD_ALL ), OIV.Inventor.Win.Viewers.SoWinViewer.Types( .SoWinViewer.BROWSER )).
Public methodSoWinExaminerViewer(Control, String, Boolean)
Calls SoWinExaminerViewer(parent, name, buildInsideParent, OIV.Inventor.Win.Viewers.SoWinFullViewer.BuildFlags( .SoWinFullViewer.BUILD_ALL ), OIV.Inventor.Win.Viewers.SoWinViewer.Types( .SoWinViewer.BROWSER )).
Public methodSoWinExaminerViewer(Control, String, Boolean, SoWinFullViewerBuildFlags)
Calls SoWinExaminerViewer(parent, name, buildInsideParent, flag, OIV.Inventor.Win.Viewers.SoWinViewer.Types( .SoWinViewer.BROWSER )).
Public methodSoWinExaminerViewer(Control, String, Boolean, SoWinFullViewerBuildFlags, SoWinViewerTypes)

Constructor which specifies the viewer type.

Top
Methods
  NameDescription
Public methodActivateDolly

Sets the start locator for dolly camera animation.

Public methodActivatePanning

Sets the start locator for pan camera animation.

Public methodActivateRoll

Sets the start locator for roll camera animation.

Public methodActivateSpinning

Sets the start locator for spin camera animation.

Public methodActualRendering

This method is called automatically when the viewer requests that its OIV.Inventor.Components.Stereo.SoBaseStereo object perform stereo rendering.

(Inherited from SoWinViewer.)
Public methodAddAppPushButton

Adds application push button, which will be placed in the left hand side decoration trim.

(Inherited from SoWinFullViewer.)
Public methodAddFunctionKeyBinding

Adds a new function key binding to the viewer.

Public methodCode exampleAddHook
Adds an event handler that receives all messages dispatched to this window.
(Inherited from SoWinGLWidget.)
Public methodAddViewingMouseBinding

Adds a new mouse binding to the viewer.

Public methodAdjustClippingPlanes Obsolete.

Along with the manipulation of the camera, OIV.Inventor.Components.Stereo.SoBaseStereo needs to set the scene appropriately when changing the camera settings.

(Inherited from SoWinViewer.)
Public methodBindNormalContext

Makes the normal rendering context the current context.

(Inherited from SoWinGLWidget.)
Public methodConstrainCameraRotation
Calls ConstrainCameraRotation(false, false, false).
Public methodConstrainCameraRotation(Boolean)
Calls ConstrainCameraRotation(x, false, false).
Public methodConstrainCameraRotation(Boolean, Boolean)
Calls ConstrainCameraRotation(x, y, false).
Public methodConstrainCameraRotation(Boolean, Boolean, Boolean)

Constrains the camera to spin around the specified axis.

Public methodCopyView

Copies the view.

(Inherited from SoWinViewer.)
Public methodDispose
(Inherited from SoWinRenderArea.)
Public methodDollyCamera

Move the camera on the z axis based on cursor motion.

Public methodEnableFullRenderingWhenStill

If this flag is set, the viewer will render at full resolution when it sits still for a certain period of time.

(Inherited from SoWinViewer.)
Public methodEnableMouseWheelDolly

Enable/disable moving the camera with the mouse wheel, true by default.

(Inherited from SoWinViewer.)
Public methodEnableSeekWithOrtho

If false, the seek functionality is disabled for an OIV.Inventor.Nodes.SoOrthographicCamera.

(Inherited from SoWinViewer.)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Public methodFindAppPushButton

Returns index of specified push button.

(Inherited from SoWinFullViewer.)
Public methodFlush
(Inherited from SoWinGLWidget.)
Public methodGetAntialiasingMode

Returns the antialiasing mode set using the setAntialiasing(float,AntialiasingMode) method.

(Inherited from SoWinGLWidget.)
Public methodGetAntialiasingParameters (Inherited from SoWinGLWidget.)
Public methodGetAntialiasingQuality

Returns the antialiasing quality set using the setAntialiasing(float,AntialiasingMode) method.

(Inherited from SoWinGLWidget.)
Public methodGetAutoClipTolerance

Returns the auto clipping tolerance value.

(Inherited from SoWinViewer.)
Public methodGetBackgroundColor

Gets the background color for this window.

(Inherited from SoWinRenderArea.)
Public methodGetBackgroundIndex

Gets the window background color when in color index mode.

(Inherited from SoWinRenderArea.)
Public methodGetBorderSize

Included for portability only.

(Inherited from SoWinGLWidget.)
Public methodGetBottomRight

Returns the position of the OpenGL drawing window in absolute screen coordinates (not relative to parent window) of the native window system (typically Y increasing downward).

(Inherited from SoWinViewer.)
Public methodGetBufferingType

Gets the current buffering type in the main view.

(Inherited from SoWinViewer.)
Public methodGetCamera

Gets the camera controlled by the viewer.

(Inherited from SoWinViewer.)
Public methodGetCameraSceneGraph

Gets the sub-scene graph to be viewed.

(Inherited from SoWinViewer.)
Public methodGetCameraType

Gets the camera type that will be created by the viewer if no cameras are found in the scene graph (see OIV.Inventor.Nodes.SoPerspectiveCamera and OIV.Inventor.Nodes.SoOrthographicCamera).

(Inherited from SoWinViewer.)
Public methodGetClassName

Returns the class name.

(Inherited from SoWinComponent.)
Public methodGetConstrainedViewingMode

Returns the current constrained viewing mode.

Public methodGetCurrentDecimationPercentage

Returns the Decimation Percentage the viewer used in its last render.

(Inherited from SoWinViewer.)
Public methodGetCursor Obsolete.

Returns the current cursor.

(Inherited from SoWinGLWidget.)
Public methodGetCursorStyle

Returns the cursor style.

(Inherited from SoWinViewer.)
Public methodGetDecimationStrategy

Gets strategy to use to decide on decimation value.

(Inherited from SoWinViewer.)
Public methodGetDepthValue
(Inherited from SoWinViewer.)
Public methodGetDrawStyle

Queries the current drawing style in the main view.

(Inherited from SoWinViewer.)
Public methodGetFastEditSavePolicy

Returns fast editing save policy used when rendering.

(Inherited from SoWinRenderArea.)
Public methodGetFeedbackSize

Returns the point of rotation feedback size in pixels.

Public methodGetFixedPercentage

Gets fixed percentage for the viewer to render (0.0 to 1.0)

(Inherited from SoWinViewer.)
Public methodGetFloatingColorBuffer

Returns true if floating point rendering is used and its precision.

(Inherited from SoWinGLWidget.)
Public methodGetGLRenderAction

Gets the current GL render action.

(Inherited from SoWinRenderArea.)
Public methodGetGoalFramesPerSecond

Gets goal frames per second for the viewer to try to render.

(Inherited from SoWinViewer.)
Public methodGetGoalNumberOfTriangles

Gets goal number of triangles for the viewer to try to render.

(Inherited from SoWinViewer.)
Public methodGetGraphicConfigTemplate

Gets the current graphics configuration template.

(Inherited from SoWinGLWidget.)
Public methodGetHashCode
Overrides GetHashCode().
(Inherited from SoNetBase.)
Public methodGetHeadlight

Returns the headlight node.

(Inherited from SoWinViewer.)
Public methodGetIconTitle

Included for portability only.

(Inherited from SoWinComponent.)
Public methodGetInvalidateCacheMode

Returns the current cache invalidation mode.

(Inherited from SoWinRenderArea.)
Public methodGetMPEGRecorder

Returns the recorder used for MPEG encoding.

(Inherited from SoWinRenderArea.)
Public methodGetNormalDC

Returns the device context (which is needed for SbGlContextHelper.makeCurrent).

(Inherited from SoWinGLWidget.)
Public methodGetNormalSoContext
(Inherited from SoWinGLWidget.)
Public methodGetNumSamples

Gets how many frames should be timed before frames per second delegateis called.

(Inherited from SoWinViewer.)
Public methodGetPickRadius

Returns the current pick radius for picking and seeking actions.

(Inherited from SoWinViewer.)
Public methodGetPixelFormat

Returns the current pixel format.

(Inherited from SoWinGLWidget.)
Public methodGetRedrawPriority

Gets the priority of the redraw sensor.

(Inherited from SoWinRenderArea.)
Public methodGetSceneGraph

Gets the scene graph to be rendered in this component's window.

(Inherited from SoWinRenderArea.)
Public methodGetSceneManager

Gets the normal scene manager.

(Inherited from SoWinRenderArea.)
Public methodGetSeekTime

Queries the seek time.

(Inherited from SoWinViewer.)
Public methodGetShareContext

Returns the information needed to make OpenGL render contexts share OpenGL objects, for example, display lists and texture objects.

(Inherited from SoWinRenderArea.)
Public methodGetSize

Returns the size of the OpenGL drawing window in absolute screen coordinates (not relative to parent window) of the native window system (typically Y increasing downward).

(Inherited from SoWinViewer.)
Public methodGetStereoBalance

Returns the current stereo balance.

(Inherited from SoWinViewer.)
Public methodGetStereoOffset

Returns the stereo offset.

(Inherited from SoWinViewer.)
Public methodGetStereoViewType

Returns the current stereo implementation.

(Inherited from SoWinViewer.)
Public methodGetTitle

Gets window title.

(Inherited from SoWinComponent.)
Public methodGetTopLeft

Returns the position of the OpenGL drawing window in absolute screen coordinates (not relative to parent window) of the native window system (typically Y increasing downward).

(Inherited from SoWinViewer.)
Public methodGetTransparencyType

Gets the algorithm for rendering transparent objects.

(Inherited from SoWinRenderArea.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetViewerCamera

Returns the camera so OIV.Inventor.Components.Stereo.SoBaseStereo can manipulate it to achieve the stereo effect.

(Inherited from SoWinViewer.)
Public methodGetViewingMode

Gets the current viewing mode.

Public methodGetViewport

Returns viewport region as origin (lower-left corner) and size, given as pixel coordinates.

(Inherited from SoWinViewer.)
Public methodGetViewportRegion

Gets current viewport region to use for rendering.

(Inherited from SoWinRenderArea.)
Public methodGetWidgetName

Returns the window handle name.

(Inherited from SoWinComponent.)
Public methodHide

This hides the component.

(Inherited from SoWinComponent.)
Public methodInsertAppPushButton

Adds application push button, which will be placed in the left hand side decoration trim.

(Inherited from SoWinFullViewer.)
Public methodIsAnimating

Queries if the viewer is currently animating.

Public methodIsAnimationEnabled

Returns whether spin animation is enabled.

Public methodIsAutoClipping

Queries if auto clipping is ON.

(Inherited from SoWinViewer.)
Public methodIsAutoRedraw

Queries whether the render area will automatically redraw whenever something in the scene graph changes.

(Inherited from SoWinRenderArea.)
Public methodIsBorder

Included for portability only.

(Inherited from SoWinGLWidget.)
Public methodIsCameraHeightAnglePreserved

Query whether the OIV.Inventor.Nodes.SoPerspectiveCamera's heightAngle is preserved if the camera is changed to an OIV.Inventor.Nodes.SoOrthographicCamera and then toggled back to an OIV.Inventor.Nodes.SoPerspectiveCamera.

(Inherited from SoWinViewer.)
Public methodIsClearBeforeRender

Queries whether the window will be cleared before rendering starts.

(Inherited from SoWinRenderArea.)
Public methodIsClearZBufferBeforeRender

Queries whether the depth buffer (sometimes called the Z buffer) will be cleared before rendering starts.

(Inherited from SoWinRenderArea.)
Public methodIsClientPopupMenuInstalled Obsolete.

Returns true if an application-specific popup menu is installed.

(Inherited from SoWinFullViewer.)
Public methodIsCursorEnabled Obsolete.

Queries whether the viewer is allowed to change the cursor over the renderArea window.

(Inherited from SoWinViewer.)
Public methodIsDecoration

Returns whether the viewer component trim is on or off.

(Inherited from SoWinFullViewer.)
Public methodIsDetailSeek

Queries whether detail seek is on.

(Inherited from SoWinViewer.)
Public methodIsDoubleBuffer

Returns whether double buffering is on or off.

(Inherited from SoWinGLWidget.)
Public methodIsDrawToFrontBufferEnable

Returns whether drawing to the front buffer is enabled.

(Inherited from SoWinGLWidget.)
Public methodIsFeedbackVisible

Returns the rotation feedback flag.

Public methodIsFullRenderingWhenStill

Queries if the viewer will render at full resolution when it sits still for a certain period of time.

(Inherited from SoWinViewer.)
Public methodIsFullScreen

Queries if the viewer is in fullscreen mode.

(Inherited from SoWinComponent.)
Public methodIsFullScreenEnable

Queries if it is possible to put the viewer in fullscreen mode.

(Inherited from SoWinComponent.)
Public methodIsHeadlight

Queries if the headlight is on.

(Inherited from SoWinViewer.)
Public methodIsPopupMenuEnabled Obsolete.

Returns whether the viewer popup menu is enabled or disabled.

(Inherited from SoWinFullViewer.)
Public methodIsSeekWithOrthoEnabled

Query whether the seek functionality is enabled for an OIV.Inventor.Nodes.SoOrthographicCamera.

(Inherited from SoWinViewer.)
Public methodIsStereoAbsoluteAdjustments

Returns true if stereo absolute adjustments are enabled.

(Inherited from SoWinViewer.)
Public methodIsStereoActive

Returns true if stereo is active.

(Inherited from SoWinViewer.)
Public methodIsStereoBalanceNearFrac

Returns true if the stereo balance adjustement is defined as a fraction of the camera near distance.

(Inherited from SoWinViewer.)
Public methodIsStereoViewing

Queries if stereo viewing is on or off on the viewer.

(Inherited from SoWinViewer.)
Public methodIsStereoViewReversed

Returns true if the left and right eye views are reversed.

(Inherited from SoWinViewer.)
Public methodIsStillNow

Returns whether the viewer is currently still.

(Inherited from SoWinViewer.)
Public methodIsTopLevelShell

Returns true if this component is a top level shell component (has its own window).

(Inherited from SoWinComponent.)
Public methodIsViewerDoubleBuffer

Returns true if viewer is double buffered.

(Inherited from SoWinViewer.)
Public methodIsViewing

Queries whether the viewer is turned on or off.

(Inherited from SoWinViewer.)
Public methodIsVisible

Returns true if this component is mapped onto the screen.

(Inherited from SoWinComponent.)
Public methodLengthAppPushButton

Returns number of application push buttons.

(Inherited from SoWinFullViewer.)
Public methodPanCamera

Pans the camera based on cursor motion.

Public methodPasteView

Pastes the view.

(Inherited from SoWinViewer.)
Public methodRecomputeSceneSize

This can be used to let the viewer know that the scene graph has changed so that the viewer can recompute things like speed which depend on the scene graph size.

(Inherited from SoWinViewer.)
Public methodRedrawOnSelectionChange

Call this convenience method to have this render area redraw whenever the selection list changes in the passed node.

(Inherited from SoWinRenderArea.)
Public methodRegisterDevice

Registers interest in devices.

(Inherited from SoWinRenderArea.)
Public methodRemoveAppPushButton

Removes specified application push button.

(Inherited from SoWinFullViewer.)
Public methodRemoveFunctionKeyBinding

Removes the specified function key binding (if it exists).

Public methodRemoveHook
Removes the event handlers that were added by AddHook.
(Inherited from SoWinGLWidget.)
Public methodRemoveViewingMouseBinding

Removes a mouse binding (if it exists).

Public methodRender

Calling this forces the render area to be redrawn now.

(Inherited from SoWinRenderArea.)
Public methodResetToHomePosition

Restores the camera values.

(Inherited from SoWinViewer.)
Public methodReverseDollyCamera

Same as dollyCamera but reversed.

Public methodReverseStereoView

If true, reverse the left and right eye views.

(Inherited from SoWinViewer.)
Public methodRollCamera

Roll the camera based on cursor motion.

Public methodRotateCamera

Rotates the camera around focal point by given incremental rotation (Given rotation is concatenated onto the current camera rotation)

Public methodSaveHomePosition

Saves the camera values.

(Inherited from SoWinViewer.)
Public methodSaveSnapshot(String)
Calls SaveSnapshot(filename, true).
(Inherited from SoWinGLWidget.)
Public methodSaveSnapshot(String, Boolean)

Save a snapshot of the current image displayed in the viewer.

(Inherited from SoWinGLWidget.)
Public methodScheduleRedraw

Schedules a redraw to happen sometime soon (as opposed to immediately).

(Inherited from SoWinRenderArea.)
Public methodSetAnimationEnabled

Enables/disables the spin animation feature of the viewer (enabled by default).

Public methodSetAntialiasing(Single)
Calls SetAntialiasing(quality, OIV.Inventor.SoSceneManager.AntialiasingModes( .SoSceneManager.AUTO )).
(Inherited from SoWinGLWidget.)
Public methodSetAntialiasing(SoAntialiasingParameters)

Enable (or disable) antialiasing with specific parameters.

(Inherited from SoWinGLWidget.)
Public methodSetAntialiasing(Single, SoSceneManagerAntialiasingModes)

Enable (or disable) antialiasing with specified quality and mode.

(Inherited from SoWinGLWidget.)
Public methodSetAutoClipping

Sets the auto clipping plane.

(Inherited from SoWinViewer.)
Public methodSetAutoClipTolerance

Sets the auto clipping tolerance value.

(Inherited from SoWinViewer.)
Public methodSetAutoRedraw

The render area will automatically redraw whenever something in the scene graph changes.

(Inherited from SoWinRenderArea.)
Public methodSetBackgroundColor

Sets the background color for this window.

(Inherited from SoWinRenderArea.)
Public methodSetBackgroundIndex

Sets the window background color when in color index mode.

(Inherited from SoWinRenderArea.)
Public methodSetBorder

Included for portability only.

(Inherited from SoWinGLWidget.)
Public methodSetBufferingType

Sets the current buffering type in the main view (default OIV.Inventor.Win.Viewers.SoWinViewer.BufferTypes.BUFFER_DOUBLE).

(Inherited from SoWinViewer.)
Public methodSetCamera

Sets the camera that will be controlled by the viewer.

(Inherited from SoWinViewer.)
Public methodSetCameraSceneGraph

Sets the sub-scene graph to be used for OIV.Inventor.Win.Viewers.SoWinViewer.ViewAll() computation.

(Inherited from SoWinViewer.)
Public methodSetCameraType

Sets the camera type that will be created by the viewer if no cameras are found in the scene graph (see OIV.Inventor.Nodes.SoPerspectiveCamera and OIV.Inventor.Nodes.SoOrthographicCamera).

(Inherited from SoWinViewer.)
Public methodSetClearBeforeRender(Boolean)
Calls SetClearBeforeRender(trueOrFalse, true).
(Inherited from SoWinRenderArea.)
Public methodSetClearBeforeRender(Boolean, Boolean)

Enables/prevents window clearing from happening before a rendering starts (default is clear true).

(Inherited from SoWinRenderArea.)
Public methodSetColorMap

Sets the colors to use when displaying in color index mode.

(Inherited from SoWinRenderArea.)
Public methodSetConstrainedViewingMode

Sets the constrained viewing mode.

Public methodSetCursor Obsolete.

Sets the current cursor.

(Inherited from SoWinGLWidget.)
Public methodSetCursorEnabled Obsolete.

Sets whether the viewer is allowed to change the cursor over the renderArea window.

(Inherited from SoWinViewer.)
Public methodSetCursorStyle

Sets the cursor style.

(Inherited from SoWinViewer.)
Public methodSetDecimationStrategy

Sets strategy to use to decide on decimation value.

(Inherited from SoWinViewer.)
Public methodSetDecoration

Shows/hides the viewer component trim (default on).

(Inherited from SoWinFullViewer.)
Public methodSetDetailSeek

When the viewer is in seek mode, left mouse clicks initiate a pick, and the viewer changes its orientation and position to look at the picked object.

(Inherited from SoWinViewer.)
Public methodSetDoubleBuffer

Routine that dynamically changes between single and double buffering.

(Inherited from SoWinGLWidget.)
Public methodSetDrawStyle

Sets the current drawing style in the main view.

(Inherited from SoWinViewer.)
Public methodSetDrawToFrontBufferEnable

Sets drawing to the front buffer.

(Inherited from SoWinGLWidget.)
Public methodSetFastEditSavePolicy(SoGLRenderActionFastEditSavePolicies)
Calls SetFastEditSavePolicy(policy, false).
(Inherited from SoWinRenderArea.)
Public methodSetFastEditSavePolicy(SoGLRenderActionFastEditSavePolicies, Boolean)

Sets fast editing save policy to use when rendering.

(Inherited from SoWinRenderArea.)
Public methodSetFeedbackSize

Sets the point of rotation feedback size in pixels (default 20 pix).

Public methodSetFeedbackVisibility

Shows/hides the point of rotation feedback, which only appears while in viewing mode (default is off).

Public methodSetFixedPercentage

Sets fixed percentage for the viewer to render (0.0 to 1.0) Default is 1.0.

(Inherited from SoWinViewer.)
Public methodSetFloatingColorBuffer(Boolean)
Calls SetFloatingColorBuffer(enable, OIV.Inventor.Win.SoWinGLWidget.FloatColorBufferSizes( .SoWinGLWidget.FLOAT_16_COLOR_BUFFER )).
(Inherited from SoWinGLWidget.)
Public methodSetFloatingColorBuffer(Boolean, SoWinGLWidgetFloatColorBufferSizes)

Enables/disables floating point rendering using 16- or 32-bit components.

(Inherited from SoWinGLWidget.)
Public methodSetFullScreen

Switches the viewer into (or out of) fullscreen mode.

(Inherited from SoWinComponent.)
Public methodSetFullScreenEnable

Enables/disables fullscreen mode.

(Inherited from SoWinComponent.)
Public methodSetGLRenderAction

Sets the GL render action to use.

(Inherited from SoWinRenderArea.)
Public methodSetGoalFramesPerSecond

Sets goal frames per second for the viewer to try to render.

(Inherited from SoWinViewer.)
Public methodSetGoalNumberOfTriangles

Sets goal number of triangles for the viewer to try to render.

(Inherited from SoWinViewer.)
Public methodSetGraphicConfigTemplate

Sets a new graphics configuration template.

(Inherited from SoWinGLWidget.)
Public methodSetHeadlight

Turns the headlight on/off (default on).

(Inherited from SoWinViewer.)
Public methodSetIconTitle

Included for portability only.

(Inherited from SoWinComponent.)
Public methodSetInvalidateCacheMode

Enables or disables the invalidation of render caches.

(Inherited from SoWinRenderArea.)
Public methodSetMPEGRecorder

Sets the recorder used for MPEG encoding.

(Inherited from SoWinRenderArea.)
Public methodSetNumSamples

Sets how many frames should be timed before frames per second delegateis called, default is 10.

(Inherited from SoWinViewer.)
Public methodSetPickRadius

Sets the pick radius, in pixels, used by the viewer for picking and seeking actions.

(Inherited from SoWinViewer.)
Public methodSetPixelFormat

Sets the current pixel format.

(Inherited from SoWinGLWidget.)
Public methodSetPopupMenuEnabled Obsolete.

Enables/disables the viewer popup menu (default enabled).

(Inherited from SoWinFullViewer.)
Public methodSetPreserveCameraHeightAngle

If true, an OIV.Inventor.Nodes.SoPerspectiveCamera's heightAngle is preserved if the camera is changed to an OIV.Inventor.Nodes.SoOrthographicCamera and then toggled back to an OIV.Inventor.Nodes.SoPerspectiveCamera.

(Inherited from SoWinViewer.)
Public methodSetRedrawPriority

Sets the priority of the redraw sensor.

(Inherited from SoWinRenderArea.)
Public methodSetSceneGraph

Sets the scene graph to be rendered in this component's window.

(Inherited from SoWinRenderArea.)
Public methodSetSceneManager

Sets the normal scene manager.

(Inherited from SoWinRenderArea.)
Public methodSetSeekTime

Sets the time a seek takes to change to the new camera location.

(Inherited from SoWinViewer.)
Public methodSetSize

Convenience routine on the window handle.

(Inherited from SoWinComponent.)
Public methodSetStealFocus

By default the GLWidget "steals" focus whenever the cursor moves over it.

(Inherited from SoWinGLWidget.)
Public methodSetStereoAbsoluteAdjustments

If true, use stereo absolute adjustments.

(Inherited from SoWinViewer.)
Public methodSetStereoActive

If true, stero is activated.

(Inherited from SoWinViewer.)
Public methodSetStereoBalance(Single)
Calls SetStereoBalance(balance, false).
(Inherited from SoWinViewer.)
Public methodSetStereoBalance(Single, Boolean)

Sets the stereo balance (the position of the zero parallax plane).

(Inherited from SoWinViewer.)
Public methodSetStereoOffset

Sets the stereo offset.

(Inherited from SoWinViewer.)
Public methodSetStereoViewing

Turns stereo viewing on/off on the viewer (default off).

(Inherited from SoWinViewer.)
Public methodSetStereoViewType

Set an implementation of stereo viewing to use.

(Inherited from SoWinViewer.)
Public methodSetTitle

Sets window title.

(Inherited from SoWinComponent.)
Public methodSetTransparencyType

Sets the algorithm for rendering transparent objects.

(Inherited from SoWinRenderArea.)
Public methodSetViewing

Sets whether the viewer is turned on or off.

(Inherited from SoWinViewer.)
Public methodSetViewingMode

Sets the viewing mode.

Public methodSetViewport

Sets viewport region with given origin (lower-left corner) and size, given as pixel coordinates.

(Inherited from SoWinViewer.)
Public methodSetViewportRegion

Sets viewport region to use for rendering.

(Inherited from SoWinRenderArea.)
Public methodShow

This shows the component.

(Inherited from SoWinComponent.)
Public methodSpinCamera

Spin the camera based on cursor motion.

Public methodSpinConstrainedCamera

Spin the constrained camera based on cursor motion.

Public methodStopAnimating

Stops animation, if it is occurring.

Public methodSwapNormalBuffers

Swaps the normal front and back buffers.

(Inherited from SoWinGLWidget.)
Public methodToggleCameraType

This routine will toggle the current camera from perspective to orthographic, and from orthographic back to perspective.

(Inherited from SoWinViewer.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUnbindNormalContext

unbind the current context (previously bind with bindNormalContext );

(Inherited from SoWinGLWidget.)
Public methodUnregisterDevice

Unregisters interest in devices.

(Inherited from SoWinRenderArea.)
Public methodViewAll

Changes the camera position to view the entire scene (the camera zoom or orientation isn't changed).

(Inherited from SoWinViewer.)
Top
Properties
  NameDescription
Public propertyCameraTypeChangeCallback

Defines a callback which is called each time the camera type has changed (change from OIV.Inventor.Nodes.SoPerspectiveCamera to OIV.Inventor.Nodes.SoOrthographicCamera or vice versa).

(Inherited from SoWinViewer.)
Public propertyContextMenu
Gets/sets application specific contextual menu.
(Inherited from SoWinFullViewer.)
Public propertyCursor

Sets the current cursor.

(Inherited from SoWinGLWidget.)
Public propertyCursorEnabled

Sets whether the viewer is allowed to change the cursor over the renderArea window.

(Inherited from SoWinViewer.)
Public propertyDecimationPercentageCallback

Registers decimation percentage callback.

(Inherited from SoWinViewer.)
Public propertyEventFunction
Sets the event delegate that will be called before viewer process keyboard or mouse event.
(Inherited from SoWinRenderArea.)
Public propertyFramesPerSecondCallback

Registers frames per second callback.

(Inherited from SoWinViewer.)
Public propertyHandle
Implements Handle.
(Inherited from SoWinComponent.)
Public propertyIsDefaultContextMenuEnabled

Enables/disables the viewer popup menu (default enabled).

(Inherited from SoWinFullViewer.)
Public propertyPostRenderCallback

Specifies a function to be called after the Open Inventor render traversal and immediately before the OpenGL buffer swap.

(Inherited from SoWinRenderArea.)
Public propertySeekMode

Externally set the viewer into/out off seek mode (default OFF).

(Inherited from SoWinViewer.)
Public propertyWindowCloseCallback

Sets the delegate to invoke when the user closes this component (double click in the upper left corner) - by default Hide() is called on this component, unless a delegate is specified.

(Inherited from SoWinComponent.)
Top
Events
  NameDescription
Public eventFinishViewing
(Inherited from SoWinViewer.)
Public eventStartViewing
(Inherited from SoWinViewer.)
Top
Remarks

The Examiner viewer component allows you to rotate the view around a point of interest using a virtual trackball. The viewer uses the camera focalDistance field to figure out the point of rotation, which is usually set to be at the center of the scene. In addition to allowing you to rotate the camera around the point of interest, this viewer also allows you to translate the camera in the viewer plane, as well as dolly (move forward and backward) to get closer to or further away from the point of interest. The viewer seek capability can be used to position the camera towards a selected object or point.

Focal point:

The center of rotation for the ExaminerViewer, called the focalPoint, is defined as a point that is focalDistance from the camera position, along the viewVector, where the viewVector is (indirectly) defined by the camera orientation. You can compute the focalPoint for the current camera settings like this:

SoCamera camera = viewer.GetCamera();
SbMatrix mx     = (SbMatrix)camera.orientation.Value;
SbVec3f viewVec = new SbVec3f(-mx[2, 0], -mx[2, 1], -mx[2, 2]);
SbVec3f camPos  = camera.position.Value;
float   focDist = camera.focalDistance.Value;
SbVec3f focalPt = camPos + (focDist * viewVec);

To better understand the above code, remember that we can convert an OIV.Inventor.SbRotation to an OIV.Inventor.SbMatrix and, since orientation is a pure rotation matrix, we can consider the first three columns of this matrix to be the orthogonal X, Y and Z vectors defining the rotated coordinate system. Therefore the view vector is the inversion of the Z axis vector; and finally because this vector is already normalized, an offset of "dist" along this vector is simply "dist * vector". Of course if you have a focalPoint in mind, you can work backward to compute camera position or focalDistance depending on which parameters you want to keep constant.

Customize behaviors:

See the OIV.Inventor.Win.Viewers.SoWinExaminerViewer.AddFunctionKeyBinding(OIV.Inventor.Events.SoKeyboardEvent.Keys, OIV.Inventor.Win.Viewers.SoWinExaminerViewer.SoViewingFunction) and OIV.Inventor.Win.Viewers.SoWinExaminerViewer.AddViewingMouseBinding(OIV.Inventor.Events.SoKeyboardEvent.Keys[], OIV.Inventor.Events.SoMouseButtonEvent.Buttons[], OIV.Inventor.Win.Viewers.SoWinExaminerViewer.SoViewingFunction) methods to customize some behaviors of the viewer.

Viewer components:

For applications that need more flexibility, we recommend using the "viewer component" classes to build exactly the viewing behaviors that your application needs. Please see the OIV.Inventor.ViewerComponents.SoCameraInteractor, SceneInteractor and SceneExaminer classes.

USAGE

(For 3-button mouse only.)

Left Mouse: Rotate the virtual trackball.

Middle Mouse or Ctrl + Left Mouse: Translate up, down, left, right.

Ctrl + Middle Mouse or Left + Middle Mouse: Dolly in and out (gets closer to and further away from the object) (Perspective camera) or zoom in and out (Orthographic camera).

<s> + Left Mouse: Alternative to the Seek button. Press (but do not hold down) the <s> key, then click on a target object.

Right Mouse: Open the popup menu.

ALT: When the viewer is in selection (a.k.a. pick) mode, pressing and holding the ALT key temporarily switches the viewer to viewing mode. When the ALT key is released, the viewer returns to selection mode. Note: If any of the mouse buttons are currently depressed, the ALT key has no effect.

Mouse Wheel: Dolly/zoom camera Rotating the mouse wheel does a camera "dolly" operation on a perspective camera (moving the camera closer or farther away from the scene, which visually zoom) or a camera "zoom" operation on an orthographic camera (changing the view volume height).

Note that many users find the default dolly speed with the mouse wheel to be too slow. The user can hold down the Shift key to make the mouse wheel dolly go 2X faster. To increase the base speed set the environment variable OIV_WHEEL_DELTA. Mouse wheel events contain a "delta" that is a multiple of 120. The viewer divides this value by OIV_WHEEL_DELTA to compute the camera dolly increment. The default value for OIV_WHEEL_DELTA is 120. So, for example, setting OIV_WHEEL_DELTA to 12 makes the mouse wheel dolly go 10X faster.

See Also