3D Display Control Reference 14.0
Enumerations

Enumerations

enum  Core3DViewerHorizontalTextAlignment { HorizontalAlignmentLeft , HorizontalAlignmentCenter , HorizontalAlignmentRight }
 Horizontal text alignment options for 3D display labels. More...
 
enum  Core3DViewerInteractorMode {
  InteractorMode_Undefined = -1 , InteractorMode_JoystickCamera = 0 , InteractorMode_JoystickActor = 1 , InteractorMode_TrackballCamera = 2 ,
  InteractorMode_TrackballActor = 3 , InteractorMode_Flight = 4
}
 Specifies how the user interacts with the 3D display. More...
 
enum  Core3DViewerVerticalTextAlignment { VerticalAlignmentTop , VerticalAlignmentCenter , VerticalAlignmentBottom }
 Vertical text alignment options for 3D display labels. More...
 
enum  Core3DViewerVisualizationMode { VisualizationUndefined , VisualizationSolidColor , VisualizationColorRange }
 Visualization mode on the 3D display. More...
 

Detailed Description

Enumeration Type Documentation

◆ Core3DViewerHorizontalTextAlignment

Horizontal text alignment options for 3D display labels.

Enumerator
HorizontalAlignmentLeft 

Left-aligned text output relative to label location.

HorizontalAlignmentCenter 

Center-aligned text output relative to label location.

HorizontalAlignmentRight 

Right-aligned text output relative to label location.

◆ Core3DViewerInteractorMode

Specifies how the user interacts with the 3D display.

User interaction with the 3D display control works through a combination of mouse movement (even though some of the interaction mode names may imply other input devices), mouse buttons and keyboard presses. For details refer to the description of the different enum values.

In addition to the interactions mentioned in the description of the enum values, the 3D display will recognize the following keystrokes:

Key Effect
j/t toggle between joystick and trackball mode
c/a toggle between camera and actor/object mode
f switch to flight mode
p pick object under mouse cursor
r reset camera position
s surface mode
w wireframe mode
Enumerator
InteractorMode_Undefined 

Interaction mode not defined.

InteractorMode_JoystickCamera 

Interactively manipulate the camera position and view direction.

In this mode, the user moves/rotates/pans the camera and the point of view using a combination of mouse, mouse buttons and keyboard buttons:

  • movement/panning/rotation speed is determined by the mouse pointer's position relative to the scene's center
  • mouse speed determines camera acceleration (i. e. the camera may continue to move even if the mouse is not moving)
  • holding down the left mouse button lets you modify camera rotation
  • holding down the left mouse button while pressing the CTRL key lets the camera spin in the direction indicated by the mouse
  • holding down the right mouse button will let you modify the camera zoom
  • holding down the center button (if available) lets you pan the scene; holding down the left mouse button while pressing the SHIFT key will do the same
InteractorMode_JoystickActor 

Interact with objects rather than the camera.

In this mode, the user moves/rotates/pans separate objects in the 
scene independently:
  - movement/panning/rotation speed is determined by the mouse 
    pointer's position relative to the scene's center
  - mouse speed determines camera acceleration (i. e. the object may 
    continue to move even if the mouse is not moving)
  - holding down the left mouse button lets you modify object's 
    rotation (unless rotation for the object has been locked)
  - holding down the left mouse button while pressing the CTRL key 
    lets the object spin in the direction indicated by the mouse
  - holding down the right mouse button will let you zoom in or out
    on the object
  - holding down the center button (if available) lets you pan the
    object (holding down the left mouse button while pressing the
    SHIFT key will do the same)
Currently the only object in the 3D view to interact with is the 
volume of interest selection box (toggled using the #ShowSelectorBox
property). 
InteractorMode_TrackballCamera 

Interactively manipulate the camera position and view direction.

In this mode, the camera motion is proportional to the magnitude of the mouse motion:

  • holding down the left mouse button while moving the mouse will cause the camera to rotate around its focal point; holding down the CTRL key as well will spin the camera
  • holding down the right mouse button while moving the mouse will let you zoom into or out of the scene
  • holding down the center button will pan the scene according to the current mouse movement (holding down the left mouse button while pressing the SHIFT key will do the same)
Attention
This mode is the 3D display's default interaction mode.
InteractorMode_TrackballActor 

Interact with objects rather than the camera.

In this mode, the user moves/rotates/pans separate objects in the 
scene independently at a rate that is proportional to the magniture
of the mouse motion:
- holding down the left mouse button while moving the mouse will cause 
  the object to rotate around its center point (unless rotation has
  been locked for this object); holding down the CTRL key as well 
  will spin the object
- holding down the right mouse button while moving the mouse will let
  you zoom in or out on the object
- holding down the center button (if available) lets you move the
  object (holding down the left mouse button while pressing the
  SHIFT key will do the same) 
InteractorMode_Flight 

Control 3D scene rendering through flight-like controls.

In 'flight' mode...
- pressing the left mouse button will generate a forward motion
  in view direction (pressing the 'A' key will do the same)
- pressing the right mouse button will generate a reverse motion
  (again relative to view direction; pressing the 'Z' key will do 
  the same)
- moving the mouse while pressing either button will change the 
  view direction accordingly (pressing the left/up/right/down arrow on 
  keyboard will do the same)
- pressing the CTRL key while moving will cause sideways steps 
  (pressing '+' or '-' keys will increase or decrease step sizes)
- holding down the SHIFT key while moving will accelerate motion
- holding down CTRL and SHIFT while moving will roll in the indicated
  direction
-  

◆ Core3DViewerVerticalTextAlignment

Vertical text alignment options for 3D display labels.

Enumerator
VerticalAlignmentTop 

Top-aligned text output relative to label location.

VerticalAlignmentCenter 

Center-aligned text output relative to label location.

VerticalAlignmentBottom 

Bottom-aligned text output relative to label location.

◆ Core3DViewerVisualizationMode

Visualization mode on the 3D display.

Enumerator
VisualizationUndefined 

Impossible to determine value.

VisualizationSolidColor 

Display object with a uniform color.

VisualizationColorRange 

Display object with a range of colors.