Description

An object that can render an McImage and its overlays into a variety of visible forms.

Object Model





Remarks

The McDisplay object is capable of blending two images, applying an overlay mask based on a third image, Panning and Scrolling each image independently, and zooming to any magnification. In addition, it supports notify connections to McGraphOverlay objects which can draw on top of the displayed image(s).

An instance of this object acts as the primary display engine for the McView coclass.

Members

Methods
CreateDataObject

Returns a new instance of an IDataObject that holds a snapshot of the current display in the requested CF_ types.

CreateImage

Returns a new instance of an McImage that requires no cast when GetDibBlock is called.

Remarks The created McImage holds a snapshot of the current display as a DIB. The new McImage is not part of the Images collection and it is initally not Visible. It has a name based on the ImageToDisplay.Name with “_Display” appended.

CreatePicture

Returns an IPicture filled with a bitmap or memory-based EnMetaFile.

EditClear

A portion of the image is cleared to a given value.

EditCopy

Copy the display and/or image to the clipboard in one or more formats.

EditCut

Copy the display and/or image to the clipboard then clear the region that the image data came from.

EditGetClipboardImage

Get an image from the clipboard in a specified format or formats.

EditPasteAoi

Image data previously placed on the the clipboard is pasted into the ImageToDisplay.

EditPasteNew

A new image is created from data previously EditCopy/Cut to the clipboard or from bitmap data on the clipboard.

GetBlendAlignLeftTop

Retrieves the alignment between the blending image and the displayed image.

GetMaskAlignLeftTop

Retrieves the alignment between the masking image and the displayed image.

GetMaskingRange

A method used to return the range of pixels values of interest to the image masking operation.

IsActionAvailable

Determines if a specified action can be performed.

MapImageToZoomed

Convert image pixel coordinates into screen coordinates.

MapZoomedToImage

Converts zoomed coordinates into image coordinates.

ResetToDefaults

Resets properties to a default state.

SetBlendAlignLeftTop

Adjusts the alignment between the blending image and the displayed image.

SetMaskAlignLeftTop

Adjusts the alignment between the masking image and the displayed image.

SetMaskingRange

A method used to specify the range of pixels values of interest to the image masking operation. Default range is 1 through 255.

SetNotifyPriority

Specify or inquire as to the order in which event clients will receive events.


Properties
AutoZoomModeRead-write property

A property used to change the magnification of the image so that the image fits the display window.

BlendingFactorRead-write property

A property that describes the blending ratio between the display image and the blending image.

BlendingFrameRead-write property

A property containing the frame number of the IMcImage used to visually blend with the displayed image. You may assign McActiveFrame for the active frame or McLastFrame for the last frame. If you assign McAssociatedFrame, you will get the frame that will associate with the current FrameToDisplay; the BlendingFrame will then track changes in the FrameToDisplay. McAssociatedFrame is the default, so if you only assign a BlendingImage, but no BlendingFrame, you will get the associated frame.

BlendingImageRead-write property

This image is used to visually blend with the displayed image.

BlendingStyleRead-write property

A property that describes the method of combining the display image and the blending image.

ChannelToViewRead-write property

This property is used to control display of individual R, G or B channels.

DataObjectRead-only property

An IDataObject that exposes the current display

DisplayedHeightRead-write property

This read/write property indicates the display height of the image after processing by the Magnification or AutoZoomMode properties.

DisplayedWidthRead-write property

This read/write property indicates the display width of the image after processing by the Magnification or AutoZoomMode properties.

DisplayLUTRead-write property

This is the lookup table used to pseudo-color the imge for display.

DisplayWhatRead-write property

Determines whether the Image, Overlays or Both are included in the generated Display.

EditPasteAoiRectangleRead-only property

A LONGRECT giving the portion of the ImageToDisplay that could be changed by a pasted image.

EnableDisplayLUTRead-write property

Controls the viewer's ability to pseudo-color the image being dislayed.

EnablePseudoColorLUTRead-write property

Property controlling and reflecting whether the PseudoColorLUT property is used.

EnableResponseLUTRead-write property

Controls the viewer's use of the Response LUT attached to the IMcImage.

EnableUpdatesRead-write property

A boolean property used to control whether the viewer should honor Image Changed notifications from the image.

FillColorsRead-write property

The color(s) to use for fill when the image does not cover the display area.

FillPatternRead-write property

The pattern to use for fill when the image does not cover the display area.

FrameToDisplayRead-write property

The FrameIndex of the ImageToDisplay Frame being displayed.

ImageToDisplayRead-write property

A property used to attach an image to the viewer.

MagnificationRead-write property

Expands or contracts the image (zooms in or out) uniformly.

MagnificationXRead-write property

Expands or contracts the image (zooms in or out) horizontally.

MagnificationYRead-write property

Expands or contracts the image (zooms in or out) vertically.

MaskingFrameRead-write property

A property containing the frame number of the IMcImage used to visually overlay a bitmap onto the displayed image.

MaskingImageRead-write property

A property - Returns an McImage* of an image used to visually overlay a bitmap onto the displayed image.

MaskingLUTRead-write property

Not Yet Implemented.

NotifyEnabledRead-write property

Determines if a particular event notify client will receive events.

OwningViewRead-only property

The owning McView instance, if any.

PanRead-write property

Shifts the image horizontally.

ScrollRead-write property

Shifts the image vertically.

SourceRectRead-only property

The image source rectangle for the Display.

TrackActiveFrameRead-write property

This boolean property enables tracking of the currently active frame within the attached image.

UseIndexPaletteRead-write property

Used to report or force a viewer mode that is optimized for 256 color systems, such as laptops.

ViewerGroupRead-write propertyproperty ViewerGroup
ViewObjectRead-only property

An IViewObject that enables drawing of the display to an hDC

WhichSourceRegionRead-write property

Controls whether the source region for the display is the whole image, the image AOI or a specified SourceRect.

ZoomedImageHeightRead-only property

This Read Only property indicates the total height of the image after processing by the Magnification property.

ZoomedImageWidthRead-only property

This Read Only property indicates the total width of the image after processing by the Magnification property.


Events
AboutToPaint

Fired during the viewer's OnDraw processing.

Activate

The OnSetFocus event. The viewer is gaining keyboard input focus.

DblClick

The user has double clicked within the viewer client window.

Deactivate

The OnKillFocus event. The viewer is losing keyboard input focus.

KeyDown

The user has pressed a keyboard key, but not released it.

KeyUp

The user has pressed and released a keyboard key.

MouseDown

The user has clicked, but not yet released, a mouse button within the viewer client window.

MouseMove

The user is moving the mouse over the viewer client window

MouseUp

The user has released a mouse button within the viewer client window.

Move

The viewer client window is being moved.

PostPaint

Fired during the viewer's OnDraw processing.

PropertyChanged

A Viewer property has changed.

Resize

The viewer client window is being resized.