SoViewingCube Class Reference
[Nodes]

Interactive cubic shape to control the orientation of a camera. More...

#include <Inventor/ViewerComponents/nodes/SoViewingCube.h>

Inheritance diagram for SoViewingCube:
SoNode SoFieldContainer SoBase SoRefCounter SoTypedObject

List of all members.

Public Types

enum  PositionInViewport {
  TOP_RIGHT,
  TOP_LEFT,
  BOTTOM_RIGHT,
  BOTTOM_LEFT
}
enum  EdgeStyle {
  FLAT,
  ROUND,
  CORNER
}
enum  Axis {
  X,
  Y,
  Z
}

Public Member Functions

virtual SoType getTypeId () const
 SoViewingCube ()
virtual SbBool affectsState () const

Static Public Member Functions

static SoType getClassTypeId ()

Public Attributes

SoSFNode sceneCamera
SoSFVec2f size
SoSFEnum position
SoSFEnum edgeStyle
SoSFColor selectionColor
SoSFColor faceColor
SoSFColor edgeColor
SoSFColor cornerColor
SoSFFilePathString facePosX
SoSFFilePathString faceNegX
SoSFFilePathString facePosY
SoSFFilePathString faceNegY
SoSFFilePathString facePosZ
SoSFFilePathString faceNegZ
SoSFFloat edgeSize
SoSFFloat animationDuration
SoSFEnum upAxis

Detailed Description

Interactive cubic shape to control the orientation of a camera.

VSG extension [PREVIEW]

The viewing cube is an interactive shape that indicates the current orientation of a camera (like a "compass" or "gnomon") and also responds to user actions by re-orienting the associated camera to one of the predefined orientations. These orientations are defined so that the camera will be in front of a selected part of the bounding cube of the scene.

Interactions

When the mouse cursor is over the viewing cube, the part (face, edge, or corner) that is under the cursor is highlighted with the selectionColor. Then if the left mouse button (button 1) is clicked (pressed and released), the selected part of the viewing cube is used to define the new orientation.

The viewing cube can be used as a replacement for the X/Y/Z camera orientation buttons implemented in many graphical user interfaces. It provides even more possibilities thanks to the pick-able edges and corners of the viewing cube which offer 26 different viewing positions. However if the edgeSize is set to 0, the edges and corners are not pick-able. In this case the user can only select six different positions.

The camera controlled by the viewing cube is defined by the field sceneCamera. This is normally the same camera that the 3D viewer is controlling. In this case both the viewer and the viewing cube control the camera and the viewing cube orientation is synchronized with the sceneCamera.

In principle, as SoViewingCube is a standard class derived from SoNode, it can be inserted in any scene graph and used with a classical viewer or SceneExaminer class. In that case the viewing cube will correctly indicate the camera orientation, but it will not be convenient for the user to use the viewing cube's interaction feature. These viewers are always in either viewing mode (mouse events control the camera) or in selection mode (mouse events are sent to the scene graph). In viewing mode, the viewing cube will not respond to mouse clicks, but in selection mode the viewer will not respond to mouse clicks.

Therefore we recommend to use the SceneOrbiter class as the viewer when using a viewing cube. SceneOrbiter is a "mode less" viewer. A mouse click without moving the mouse is interpreted as a selection (for example triggering the viewing cube behavior), but a mouse click and "drag" is interpreted as controlling the camera. For convenience, the SceneOrbiter automatically adds a viewing cube to the scene graph.

The viewing cube is rendered in a corner of the render area. Its size and position in the render area are defined by the size and position fields.

vcube_top_right.png
viewing cube at the top right corner of a render area

Rendering customization

When the mouse cursor is moved on top of the viewing cube, the part that is under the cursor is highlighted using the color defined by the field selectionColor. The colors of the cube can also be personalized with 3 fields: faceColor, edgeColor and cornerColor.

Cubic shape customization

The shape of the viewing cube can be customized by several fields. The shape of the edges and corners is defined by the field edgeStyle. The edges can form a sharp corner, be rounded or be flat (beveled). The size of the edges and corners relative to the cube face is defined by the field edgeSize.

vcube_edgesize01_round.png
edgeStyle=ROUND and edgeSize=0.1

Each flat face of the viewing cube can also be customized. By default the text Top/Bottom/Front/Back/Left/Right appears on the center of each face according to its orientation. The six fields facePosX ... faceNegZ allow the application to replace the default appearance of each face with an image. Note that these images should have a transparent background so the highlight color is visible when the cursor is over the face.

vcube_edgesize025_round.png
viewing cube custom faces with F/R/B textures

Animation

To provide a better user experience, picking a part of the viewing cube does not immediately change the camera orientation. A smooth animation is done between the current camera orientation and the new orientation. The duration of the animation is defined by the animationDuration field.

Note that the animation of the camera is done in such a way that the default text of each face Top/Bottom/Front/Back/Left/Right are always legible.

FILE FORMAT/DEFAULT

SEE ALSO

SceneOrbiter

What is a Preview Feature ?:

Member Enumeration Documentation

Possible up axes of the scene.

Enumerator:
X 

Set X as the up axis.

Y 

Set Y as the up axis.

Z 

Set Z as the up axis.

Different types of edges.

Enumerator:
FLAT 

Edges are flat (beveled).

ROUND 

Edges have a rounded shape.

CORNER 

Edges form a sharp corner.

Possible positions of the viewing cube in the scene camera viewport.

Enumerator:
TOP_RIGHT 

The viewing cube is positioned at the top right corner.

TOP_LEFT 

The viewing cube is positioned at the top left corner.

BOTTOM_RIGHT 

The viewing cube is positioned at the bottom right corner.

BOTTOM_LEFT 

The viewing cube is positioned at the bottom left corner.


Constructor & Destructor Documentation

SoViewingCube::SoViewingCube (  ) 

Member Function Documentation

virtual SbBool SoViewingCube::affectsState (  )  const [virtual]

This node does not affect the state.

Returns FALSE.

Reimplemented from SoNode.

static SoType SoViewingCube::getClassTypeId (  )  [static]

Returns the type identifier for this class.

Reimplemented from SoNode.

virtual SoType SoViewingCube::getTypeId (  )  const [virtual]

Returns the type identifier for this specific instance.

Reimplemented from SoNode.


Member Data Documentation

Duration of camera movement to reach the desired position.

Any negative value of this field is equivalent to 0 (no animation). Default is 0.8 seconds.

Color used to render the corners of the cube.

Default is gray (0.8,0.8,0.8).

Color used to render the edges of the cube.

Default is gray (0.8,0.8,0.8).

Size of the edges, relative to the size of the faces.

The size of the corners are also adjusted according to this value. When the edgeSize is 0, neither edges nor corners of the viewing cube can be highlighted or selected. Thus the viewing cube allows to select only 6 predefined positions of the camera.

This field's value is clamped in a range [0-1]. edgeSize = 1 corresponds to 25% of the face's size. Default is 0.4.

Depending on the edgeStyle value, the edgeSize defines either a radius (for ROUND style) or a width.

vcube_edgesize0.png
Above is a viewing cube with edgeSize = 0

Below are images of a viewing cube with different edgeSize=0.1 on the left column and edgeSize=0.25 on the right column.

vcube_edgesize01_corner.png
vcube_edgesize025_corner.png
edgeStyle = CORNER
vcube_edgesize01_round.png
vcube_edgesize025_round.png
edgeStyle = ROUND
vcube_edgesize01_flat.png
vcube_edgesize025_flat.png
edgeStyle = FLAT

Style of edges and corners.

Use enum EdgeStyle.

vcube_edgestyle_round.png
vcube_edgestyle_corner.png
vcube_edgestyle_flat.png
edgeStyle = ROUND edgeStyle = CORNER edgeStyle = FLAT

Color used to render the faces of the cube.

Default is gray (0.8,0.8,0.8).

Texture to customize the face's appearance which has a "Left" label by default.

See facePosX for detail.

Texture to customize the face's appearance which has a "Bottom" label by default.

See facePosX for detail.

Texture to customize the face's appearance which has a "Back" label by default.

See facePosX for detail.

Texture to customize the face's appearance which has a "Right" label by default.

This field defines the name of the file which contains this texture.

The standard image file formats are supported. See SoRasterImageRW for the list. The image format must handle an alpha channel in order to allow the selected face to be highlighted with the selectionColor.

Texture to customize the face's appearance which has a "Top" label by default.

See facePosX for detail.

Texture to customize the face's appearance which has a "Front" label by default.

See facePosX for detail.

Position of the viewing cube in the scene camera viewport.

Use enum PositionInViewport.

Default is TOP_RIGHT.

Camera which is synchronized with this viewing cube.

When using a viewing cube with a SceneOrbiter, the method SceneOrbiter::enableViewingCube(true) set automatically the field sceneCamera.

However to use a viewing cube with a SceneExaminer, the following code sample gives an example to set the field sceneCamera.

     qtViewerExaminer = new ViewerExaminer(NULL);
     SceneExaminer* sceneExaminer = qtViewerExaminer->getRenderArea()->getSceneInteractor();
     SoViewingCube* viewingCube = new SoViewingCube;
     viewingCube->sceneCamera = sceneExaminer->getCamera();
     sceneExaminer->addChild(viewingCube);

Color used to highlight the part of the viewing cube that is under the cursor.

Default is cyan (0,1,1).

The following image shows the highlighted edge behind the cursor when selectionColor = (1,0,0)

vcube_selectioncolor_red.png

Size of the viewport, in pixels, in which the viewing cube is drawn.

Default is 150 pixels width, 150 pixels height.

Up axis of the scene.

Setting the up axis allows the adjustment of the viewing cube rotations. Thus, this axis remains vertical at all times relative to the viewport, it is always parallel to the vertical border of the viewport. The chosen axis defines the initial position and orientation of the camera (front-top-right corner). Use enum Axis. Default is Y.


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

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