SoWinWalkViewer Class Reference
[Win]

VSG extension Viewer component which moves the camera in a plane. More...

#include <Inventor/Win/viewers/SoWinWalkViewer.h>

Inheritance diagram for SoWinWalkViewer:
SoWinConstrainedViewer SoWinFullViewer SoWinViewer SoWinRenderArea SoStereoViewer SoWinGLWidget SoWinComponent

List of all members.

Public Member Functions

 SoWinWalkViewer (SoWidget parent=NULL, const char *name=NULL, SbBool buildInsideParent=TRUE, SoWinFullViewer::BuildFlag flag=SoWinFullViewer::BUILD_ALL, SoWinViewer::Type type=SoWinViewer::BROWSER)
 ~SoWinWalkViewer ()
virtual void setViewing (SbBool onOrOff)
virtual void setCamera (SoCamera *cam)
virtual void setCursorEnabled (SbBool onOrOff)
virtual void setCameraType (SoType type)
void setViewerSpeed (float speed)
float getViewerSpeed () const
virtual void setSeekMode (SbBool onOrOff)

Detailed Description

VSG extension Viewer component which moves the camera in a plane.

The paradigm for this viewer is a walk-through of an architectural model. Its primary behavior is forward, backward, and left/right turning motion while maintaining a constant "eye level". It is also possible to stop and look around at the scene. The eye level plane can be disabled, allowing the viewer to proceed in the "look at" direction, as if on an escalator. The eye level plane can also be translated up and down - similar to an elevator.

USAGE

SEE ALSO

SoWinFullViewer, SoWinViewer, SoWinComponent, SoWinRenderArea, SoWinPlaneViewer, SoWinExaminerViewer, SoWinFlyViewer


Constructor & Destructor Documentation

SoWinWalkViewer::SoWinWalkViewer ( SoWidget  parent = NULL,
const char *  name = NULL,
SbBool  buildInsideParent = TRUE,
SoWinFullViewer::BuildFlag  flag = SoWinFullViewer::BUILD_ALL,
SoWinViewer::Type  type = SoWinViewer::BROWSER 
)

Constructor which specifies the viewer type.

Please refer to SoWinViewer for a description of the viewer types.

NOTES

    On Windows, the constructor will not create a new top level window -- you must pass a valid window handle for the parent parameter and pass TRUE for buildInsideParent .

SoWinWalkViewer::~SoWinWalkViewer (  ) 

Destructor.


Member Function Documentation

float SoWinWalkViewer::getViewerSpeed (  )  const [inline]

Get viewer speed multiplier.

virtual void SoWinWalkViewer::setCamera ( SoCamera cam  )  [virtual]

Sets the edited camera.

Setting the camera is only needed if the first camera found in the scene when setting the scene graph isn't the one the user really wants to edit.

Reimplemented from SoWinConstrainedViewer.

virtual void SoWinWalkViewer::setCameraType ( SoType  type  )  [virtual]

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

By default an SoPerspectiveCamera will be created if no cameras are found.

Note: The set method will only take effect the next time a scene graph is specified (and if no cameras are found).

Reimplemented from SoWinViewer.

virtual void SoWinWalkViewer::setCursorEnabled ( SbBool  onOrOff  )  [virtual]

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

When disabled, the cursor is undefined by the viewer and will not change as the mode of the viewer changes. When re-enabled, the viewer will reset it to the appropriate icon.

Disabling the cursor enables the application to set the cursor directly on the viewer window or on any parent widget of the viewer. This can be used when setting a busy cursor on the application shell.

Reimplemented from SoWinViewer.

virtual void SoWinWalkViewer::setSeekMode ( SbBool  onOrOff  )  [virtual]

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

Actual seeking will not happen until the viewer decides to (ex: mouse click).

Note: setting the viewer out of seek mode while the camera is being animated will stop the animation to the current location.

Reimplemented from SoWinViewer.

void SoWinWalkViewer::setViewerSpeed ( float  speed  )  [inline]

Set viewer speed multiplier (default is 1).

virtual void SoWinWalkViewer::setViewing ( SbBool  onOrOff  )  [virtual]

Sets whether the viewer is turned on or off.

When turned on, messages are consumed by the viewer. When viewing is off, messages are processed by the viewer's render area. This means messages will be sent down to the scene graph for processing (i.e. picking can occur). Note that if the application has registered a message callback , it will be invoked on every message, whether viewing is turned on or not. However, the return value of this callback (which specifies whether the callback handled the message or not) is ignored when viewing is on. That is, the viewer will process the message even if the callback already did. This is to ensure that the viewing paradigm is not broken (default viewing is on).

Reimplemented from SoWinFullViewer.


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

Open Inventor Toolkit reference manual, generated on 22 Sep 2021
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/