SoXtPlaneViewer Class Reference
[Xt]

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

#include <Inventor/Xt/viewers/SoXtPlaneViewer.h>

Inheritance diagram for SoXtPlaneViewer:
SoXtFullViewer SoXtViewer SoXtRenderArea SoStereoViewer SoXtGLWidget SoXtComponent

List of all members.

Public Member Functions

 SoXtPlaneViewer (SoWidget parent=NULL, const char *name=NULL, SbBool buildInsideParent=TRUE, SoXtFullViewer::BuildFlag flag=SoXtFullViewer::BUILD_ALL, SoXtViewer::Type type=SoXtViewer::BROWSER)
 ~SoXtPlaneViewer ()
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

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.

RESOURCES

USAGE

SEE ALSO

SoXtFullViewer, SoXtViewer, SoXtComponent, SoXtRenderArea, SoXtWalkViewer, SoXtExaminerViewer, SoXtFlyViewer


Constructor & Destructor Documentation

SoXtPlaneViewer::SoXtPlaneViewer ( SoWidget  parent = NULL,
const char *  name = NULL,
SbBool  buildInsideParent = TRUE,
SoXtFullViewer::BuildFlag  flag = SoXtFullViewer::BUILD_ALL,
SoXtViewer::Type  type = SoXtViewer::BROWSER 
)

Constructor which specifies the viewer type.

Please refer to the SoXtViewer reference pages for a description of the viewer types.

SoXtPlaneViewer::~SoXtPlaneViewer (  ) 

Destructor.


Member Function Documentation

virtual void SoXtPlaneViewer::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 SoXtFullViewer.

virtual void SoXtPlaneViewer::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 SoXtViewer.

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

Moves the camera to be aligned with the given plane.

virtual void SoXtPlaneViewer::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 SoXtViewer.

virtual void SoXtPlaneViewer::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 SoXtFullViewer.


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

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