Modules | Namespaces | Classes | Enumerations | Functions | Variables
Viewports

A Viewport maps a Model (the "Root" Model of the Viewport) and all of its references to an output device through a camera (a view frustum) and filters (e.g. levels, view flags, etc). More...

Modules

 Sprites
 Sprites are (typically) small raster images that are drawn "on top" of Viewports by an IViewDecoration.
 

Namespaces

 Bentley
 The Bentley namespace contains types defined by the Bentley Library.
 
 Bentley::DgnPlatform
 The DgnPlatform namespace contains types defined by the DgnPlatform.
 

Classes

struct  FitViewParams
 
struct  ApplyViewOptions
 
struct  Viewport
 
struct  StopEvents
 
struct  IViewDecoration
 Implement this interface to draw "decorations" in Viewports. More...
 
struct  IModelTransientHandler
 
struct  IViewMonitor
 Implement IViewMonitor to receive notifications about significant events affecting ViewPorts. More...
 
struct  IndexedViewport
 A sub-class of Viewport that represents one of the 8 numbered views. More...
 
struct  IndexedViewSet
 
struct  IViewManager
 

Enumerations

enum  ViewportResizeMode {
  KeepCurrent = 0, RelativeRect = 1, AspectRatio = 2, Size = 3,
  SizeAndPosition = 4
}
 
enum  UpdateAbortReason {
  UPDATE_ABORT_None = 0, UPDATE_ABORT_BadView = 1, UPDATE_ABORT_Motion = 2, UPDATE_ABORT_MotionStopped = 3,
  UPDATE_ABORT_Keystroke = 4, UPDATE_ABORT_ControlC = 5, UPDATE_ABORT_MouseWheel = 6, UPDATE_ABORT_Timeout = 7,
  UPDATE_ABORT_Button = 8, UPDATE_ABORT_Paint = 9, UPDATE_ABORT_Focus = 10, UPDATE_ABORT_ModifierKey = 11
}
 

Functions

void Clear ()
 
 StopEvents (bool keystrokes, bool controlC, bool wheel, bool button, bool paint, bool focus)
 
void SetStopOnModifierKey (bool stop)
 Stop when the ctrl or shift key is pressed or released. More...
 

Variables

bool m_keystrokes:1
 
bool m_controlC:1
 
bool m_wheel:1
 
bool m_button:1
 
bool m_paint:1
 
bool m_focus:1
 
bool m_modifierKeyTransition:1
 

Detailed Description

A Viewport maps a Model (the "Root" Model of the Viewport) and all of its references to an output device through a camera (a view frustum) and filters (e.g. levels, view flags, etc).

Enumeration Type Documentation

enum UpdateAbortReason
Enumerator
UPDATE_ABORT_None 
UPDATE_ABORT_BadView 
UPDATE_ABORT_Motion 
UPDATE_ABORT_MotionStopped 
UPDATE_ABORT_Keystroke 
UPDATE_ABORT_ControlC 
UPDATE_ABORT_MouseWheel 
UPDATE_ABORT_Timeout 
UPDATE_ABORT_Button 
UPDATE_ABORT_Paint 
UPDATE_ABORT_Focus 
UPDATE_ABORT_ModifierKey 
enum ViewportResizeMode
strong
Enumerator
KeepCurrent 

The viewport size is unchanged (this is the default). The viewport is unchanged, and the view contents are resized to match the viewport aspect ratio.

RelativeRect 

The viewport is resized to the same size, relative to the available area, that is specifed in viewPortInfo.

AspectRatio 

The viewport is resized to match the aspect ratio of the viewInfo.

Size 

The viewport is resized to match the exact size specifed in viewPortInfo.

SizeAndPosition 

The viewport is resized to match the exact size specified in viewPortInfo, and moved to the position specified as well.

Function Documentation

void Clear ( )
void SetStopOnModifierKey ( bool  stop)

Stop when the ctrl or shift key is pressed or released.

References StopEvents::m_modifierKeyTransition.

StopEvents ( bool  keystrokes,
bool  controlC,
bool  wheel,
bool  button,
bool  paint,
bool  focus 
)

Variable Documentation

bool m_button
bool m_controlC
bool m_focus
bool m_keystrokes
bool m_modifierKeyTransition
bool m_paint
bool m_wheel

Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.