Display Control Reference 14.1
Enumerations

Enumerations

enum  Appearance { Flat = 0 , ThreeDimensional = 1 }
 Frame shape of a display object. More...
 
enum  CoordStyle { CS_NORMAL = 0 , CS_CROSSHAIR = 1 }
 Display style of the coordinate system. More...
 
enum  HighBitScaleMode { HBSM_Global = 0 , HBSM_ViewPort = 1 , HBSM_WrapAround = 2 }
 Specifies the treatment of image data with > 8 bits per pixel for display purposes. More...
 
enum  LeftButtonMode {
  LB_NONE = 0 , LB_RUBBER = 1 , LB_FRAME = 2 , LB_AREAMODE = 3 ,
  LB_SETORIGIN = 4 , LB_DRAWPOINT = 5 , LB_DRAWFILL = 6 , LB_DRAWLINE = 7 ,
  LB_DRAWRECT = 8 , LB_PAN = 9
}
 Specifies what the response will be to a LeftButton event of the mouse. More...
 
enum  MouseWheelMode { MW_NONE = 0 , MW_ZOOM = 1 }
 Specifies what the response will be to a MouseWheel event of the mouse. More...
 
enum  RightButtonMode { RB_NONE = 0 , RB_ZOOM = 1 , RB_MENU = 2 }
 Specifies what the response will be to a RightButton event of the mouse. More...
 

Detailed Description

Enumeration Type Documentation

◆ Appearance

enum Appearance

Frame shape of a display object.

Enumerator
Flat 

No frame.

ThreeDimensional 

3-D frame.

◆ CoordStyle

enum CoordStyle

Display style of the coordinate system.

Enumerator
CS_NORMAL 

Conventional display of the coordinate system.

CS_CROSSHAIR 

Crosshair display of the coordinate system.

◆ HighBitScaleMode

Specifies the treatment of image data with > 8 bits per pixel for display purposes.

Enumerator
HBSM_Global 

In this mode, the gray values of the image that is currently being displayed will be scaled to the range [0...255] according to the value range available to the data type that the image implements. In other words: In this mode, e.g. a 12 bit per pixel image will have all its gray values divided by 16 to fit into the 256 grey values available to the display.
In Global mode, the display will give a good impression of the overall brightness of your image. Fine contrast details, however, are not visible in this mode.
Global is the default mode for HighBit Scaling.
Note that regardless of the HighBitScaleMode setting images with floating point accuracies will always use the mode HBSM_ViewPort.

HBSM_ViewPort 

In the ViewPort mode, the display scans the currently visible portion of the image for the minimum and maximum grey value, then scales this range to the available [0...255] range.
Therefore, the "colors" black and white in your display no longer correspond to the minimum and maximum value a pixel in your image can have - they are then just the brightest and the darkest pixel currently on display (refer e.g. to the Display status line to read the true pixel value(s)).
While the absolute values may no longer be interpreted easily, this scaling mode will allow you to see the fine contrast details in your high bit images that would be lost in the Global mode.
Note that in the ViewPort mode, DisplayGain and DisplayOffset will be ignored.

HBSM_WrapAround 

In the WrapAround mode, Instead of scaling pixel values >= 256 to the range [0...255] the display simply uses the lowest 8 bits of each pixel for display. This mode was until CVB 11.01.000 the only available display mode for images with more than 8 bits per pixel (and for DirectDraw display this currently continues to be the only option). It is therefore also the default mode (for backward compatibility) that is assumed if nothing else is specified.

◆ LeftButtonMode

Specifies what the response will be to a LeftButton event of the mouse.

Enumerator
LB_NONE 

No response.

LB_RUBBER 

Generates a rubberband.

LB_FRAME 

Generates a rectangle.

LB_AREAMODE 

Generates a parallelogram which can be scaled and rotated.

LB_SETORIGIN 

Defines a new coordinate origin.

LB_DRAWPOINT 

Draws a point into the overlay (only for overlay images).

LB_DRAWFILL 

Fills in closed curves in the overlay (only for overlay images).

LB_DRAWLINE 

Draws a line into the overlay (only for overlay images).

LB_DRAWRECT 

Draws a rectangle into the overlay (only for overlay images).

LB_PAN 

Pan display (i.e. drag display center around...)

◆ MouseWheelMode

Specifies what the response will be to a MouseWheel event of the mouse.

Enumerator
MW_NONE 

No response.

MW_ZOOM 

Generates a rubberband.

◆ RightButtonMode

Specifies what the response will be to a RightButton event of the mouse.

Enumerator
RB_NONE 

Right mouse button is disabled.

RB_ZOOM 

Zoom.

RB_MENU 

Context menu.