SoWxPlaneViewer Class Reference
[Wx]

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

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

Inheritance diagram for SoWxPlaneViewer:
SoWxFullViewer SoWxViewer SoWxRenderArea SoStereoViewer SoWxGLWidget SoWxComponent

List of all members.

Public Member Functions

 SoWxPlaneViewer (wxWindow *parent=NULL, const char *name=NULL, SbBool buildInsideParent=TRUE, SoWxFullViewer::BuildFlag flag=SoWxFullViewer::BUILD_ALL, SoWxViewer::Type type=SoWxViewer::BROWSER)
 ~SoWxPlaneViewer ()
void setPlane (const SbVec3f &newNormal, const SbVec3f &newRight)
virtual void setViewing (SbBool onOrOff)
virtual void setCamera (SoCamera *cam)
virtual void setCursorEnabled (SbBool onOrOff)
virtual void setSeekMode (SbBool onOrOff)

Detailed Description

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

The Plane viewer component allows the user to translate the camera in the viewing plane, as well as dolly (move foward/backward) and zoom in and out. The viewer also allows the user to roll the camera (rotate around the forward direction) and seek to objects which will specify a new viewing plane. This viewer could be used for modeling, in drafting, and architectural work. The camera can be aligned to the X, Y or Z axes.

USAGE

SEE ALSO

SoWxFullViewer, SoWxViewer, SoWxComponent, SoWxRenderArea, SoWxExaminerViewer,


Constructor & Destructor Documentation

SoWxPlaneViewer::SoWxPlaneViewer ( wxWindow *  parent = NULL,
const char *  name = NULL,
SbBool  buildInsideParent = TRUE,
SoWxFullViewer::BuildFlag  flag = SoWxFullViewer::BUILD_ALL,
SoWxViewer::Type  type = SoWxViewer::BROWSER 
)

Constructor which specifies the viewer type.

Please refer to SoWxViewer 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 .

SoWxPlaneViewer::~SoWxPlaneViewer (  ) 

Destructor.


Member Function Documentation

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

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

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

When disabled, the cursor is not defined 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 SoWxViewer.

void SoWxPlaneViewer::setPlane ( const SbVec3f newNormal,
const SbVec3f newRight 
)

Moves the camera to be aligned with the given plane.

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

Set the viewer into/out of seek mode (default OFF).

Actual seeking will not happen until the viewer decides to, for example, on a mouse click.

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

Reimplemented from SoWxViewer.

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

Sets whether the viewer is turned on or off.

When turned on, events are consumed by the viewer. When viewing is off, events are processed by the viewer's render area. This means events will be sent down to the scene graph for processing (i.e. picking can occur). Note that if the application has registered an event 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 event or not) is ignored when viewing is on. That is, the viewer will process the event even if the callback already did. This is to ensure that the viewing paradigm is not broken (default viewing is on).

Reimplemented from SoWxFullViewer.


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

Open Inventor Toolkit reference manual, generated on 24 Mar 2020
Copyright © Thermo Fisher Scientific All rights reserved.
http://www.openinventor.com/