Description

The Viewer is an ActiveX control that displays images that are under the control of the Media Cybernetics Imaging Engine.

Object Model



Remarks

The viewer 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.

Members

Methods
GetClientWindowSize

A method used to retrieve both the ClientWindowHeight and ClientWindowWidth properties.

GetPanScroll

A method to obtain both the Pan and Scroll properties with a single call.

MapImageToZoomed

Convert image pixel coordinates into screen coordinates.

MapZoomedToImage

Converts zoomed coordinates into image coordinates.

SequenceFastForward

Displays the last frame in the SequenceFrameRange.

SequenceHoldState

Save the play state for restoration, then pause the sequence

SequencePause

Stops playback of the sequence

SequencePlayBackward

Displays successively lower frames from the SequenceFrameRange at the SequenceFrameRate.

SequencePlayForward

Displays successively higher frames from the SequenceFrameRange at the SequenceFrameRate.

SequenceRestoreState

Restores the play state that was saved with a previous call to SequenceHoldState

SequenceRewind

Displays the first frame in the SequenceFrameRange.

SequenceStepBackward

Steps backward to a new frame in the SequenceFrameRange

SequenceStepForward

Steps forward to a new frame in the SequenceFrameRange

SetCenteredMagnification

Changes the Magnification while centering a given image point

SetClientWindowSize

A method used to set both the ClientWindowHeight and ClientWindowWidth properties with a single call.

SetImageToDisplay

Attach an IMcImage to the viewer for display.

SetNotifyPriority

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

SetPanScroll

A method to set both the Pan and Scroll properties with a single call.

UpdateDisplayPalette

This function updates the Windows system palette to the proper palette for display of the image displayed in the Viewer.


Properties
AutoScrollMethodRead-write property

Enables the viewer's automatic mouse pan/scroll and mousewheel zoom.

AutoScrollSpeedRead-write property

The maximum scrolling speed in image pixels to pan or scroll per second during autoscroll.

AutoScrollThresholdRead-write property

The distance, in image pixels, from the display window edges for autoscrolling.

AutoZoomModeRead-write property

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

ClientWindowHandleRead-only property

A Read Only property that contains the HWND of the viewer's client window.

ClientWindowHeightRead-only property

A property used to set the height of the viewer's display client window, including scrollbars, if visible.

ClientWindowWidthRead-only property

A property used to set the width of the viewer's display client window, including scrollbars, if visible.

DisplayRead-only property

The McView's “Display Engine” property

EnableScrollBarsRead-write property

This boolean property allows the client to control whether or not the viewer will display scroll bars if the image to display is larger than the display window.

FrameToDisplayRead-write property

The FrameIndex of the ImageToDisplay Frame being displayed.

HorizontalScrollBarVisibleRead-only propertyproperty HorizontalScrollBarVisible
ImageToDisplayRead-write property

A property used to attach an image to the viewer.

ImageViewRectBottomRead-only property

A read only property that describes the bottom coordinate of the portion of the image being displayed.

ImageViewRectRightRead-only property

A read only property that describes the right coordinate of the portion of the image being displayed.

MagnificationRead-write property

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

NotifyEnabledRead-write property

Determines if a particular event notify client will receive events.

PanRead-write property

Shifts the image horizontally.

ScrollRead-write property

Shifts the image vertically.

ScrollBarsAreVisibleRead-only property

This Read Only boolean property allows the client to determine if the scroll bars are actually being displayed.

SequenceDirectionRead-only property

Indicates whether a sequence is playing, and if so in which direction.

SequenceEndBehaviorRead-write property

Determines the action taken during playback when the end or beginning of the SequenceFrameRange is passed.

SequenceFrameRangeRead-write property

The range(s) of frames to be displayed during sequence play or stepping.

SequenceFrameRateRead-write property

The rate at which sequence frames are played

SequenceStepCountRead-write property

The number of frames from SequenceFrameRange that are stepped at each display interval during playback.

TrackActiveFrameRead-write property

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

VerticalScrollBarVisibleRead-only propertyproperty VerticalScrollBarVisible
ViewerGroupRead-write property

A read/write property indicating which to which viewer groups this viewer belongs.

ZoomedImageHeightRead-only property

This Read Only property indicates the display height of the image after processing by the Magnification or AutoZoomMode properties.

ZoomedImageWidthRead-only property

This Read Only property indicates the display width of the image after processing by the Magnification or AutoZoomMode properties.


Events
AboutToPaintevent AboutToPaint
Activateevent GotFocus
DblClickevent DblClick
Deactivateevent LostFocus
KeyDownevent KeyDown
KeyUpevent KeyUp
MouseDownevent MouseDown
MouseMoveevent MouseMove
MouseUpevent MouseUp
Moveevent Move
PostPaintevent PostPaint
PropertyChangedevent PropertyChanged
Resizeevent Resize