ClockController.Stop ClockController.Stop ClockController.Stop ClockController.Stop Method

Definition

Stops the target Clock.

public:
 void Stop();
public void Stop ();
member this.Stop : unit -> unit
Public Sub Stop ()

Remarks

This method changes the target clock's CurrentState to Stopped.

A Stopped clock can be restarted by using the Begin, Seek, or SeekAlignedToLastTick method.

This method has no effect on the timing tree until the next time a tick is processed. As a side-effect, the appropriate events also will not be raised until then.

Stopping a clock triggers the CurrentGlobalSpeedInvalidated and CurrentStateInvalidated events, but not the Completed event.

Applies to