Start Method

Summary

Starts the mode.

Syntax

C++

public virtual void Start( 
   ImageViewer imageViewer 
)

Public Overridable Sub Start( 
   ByVal imageViewer As ImageViewer 
)

public:  
   virtual void Start( 
      ImageViewer^ imageViewer 
   )

Parameters

imageViewer

The image viewer to associate with this mode.

Remarks

This method must be overridden in your derived class when implementing your own interactive modes. For an example. refer to ImageViewerInteractiveMode.

The ImageViewer will call Start when the user sets this mode in the viewer and enables it. Typically, the mode should subscribe to the required events in InteractiveService and wait for user interaction. You should unsubscribe to these events when Stop is called.

Example

For an example, refer to ImageViewerInteractiveMode.

Requirements

Target Platforms