Export (0) Print
Expand All

ClockController.SpeedRatio Property

Gets or sets the interactive speed of the target Clock.

Namespace:  System.Windows.Media.Animation
Assembly:  PresentationCore (in PresentationCore.dll)

Public Property SpeedRatio As Double

Property Value

Type: System.Double
A finite value greater than zero that describes the interactive speed of the target clock. This value is multiplied against the value of the SpeedRatio of the clock's Timeline. For example, if the timeline's SpeedRatio is 0.5 and the ClockController object's SpeedRatio is 3.0, the timeline moves at 1.5 times normal speed (0.5 * 3.0). The default value is 1.0.

Setting this property has no effect until the next tick. If you set this property and then get its value before the next tick occurs, you'll get the old value. This property will return the new value after the next tick.

Setting this property does not change the value of the underlying timeline's SpeedRatio.

Setting this property triggers the target clock's CurrentGlobalSpeedInvalidated event.

A ClockController object's SpeedRatio property enables you to change the speed of a Clock without altering the SpeedRatio of the clock's Timeline. In the following example, a ClockController is used to interactively modify the SpeedRatio of a clock. The CurrentGlobalSpeedInvalidated event and the clock's CurrentGlobalSpeed property are used to display the clock's current global speed each time its interactive SpeedRatio is changed.

'  This example shows how to interactively control 
'  the speed of a clock

Imports System
Imports System.Windows
Imports System.Windows.Controls
Imports System.Windows.Media
Imports System.Windows.Shapes
Imports System.Windows.Media.Animation

Namespace Microsoft.Samples.Animation.TimingBehaviors
	Public Class ClockControllerSpeedRatioExample
		Inherits Page

		Private myControllableClock As AnimationClock
		Private speedRatioButton As Button
		Private speedRatioSettingTextBox As TextBox
		Private doubleParseResult As Double = 1
		Private currentGlobalSpeedTextBlock As TextBlock

		Public Sub New()
			Dim mainPanel As New StackPanel()

			' Create a rectangle to animate.
			Dim animatedRectangle As New Rectangle()
			animatedRectangle.Width = 100
			animatedRectangle.Height = 100
			animatedRectangle.Fill = Brushes.Orange
			' Create a DoubleAnimation to
			' animate its width.
			Dim widthAnimation As New DoubleAnimation(100, 500, New Duration(TimeSpan.FromSeconds(5)))
			'widthAnimation.RepeatBehavior = RepeatBehavior.Forever
			widthAnimation.AutoReverse = True
			widthAnimation.SpeedRatio = 0.5

			' Create a clock from the animation.
			myControllableClock = widthAnimation.CreateClock()

			' Apply the clock to the rectangle's Width property.
			animatedRectangle.ApplyAnimationClock(Rectangle.WidthProperty, myControllableClock)

			' Create some controls the enable the user to
			' interactively control the SpeedRatio of the clock. 
			Dim speedRatioDetailsPanel As New StackPanel()
			speedRatioDetailsPanel.Margin = New Thickness(0,20,0,20)
			speedRatioDetailsPanel.Orientation = Orientation.Horizontal
			Dim speedRatioLabel As New Label()
			speedRatioLabel.Content = "Speed Ratio:"

			' Create a text box so that the user can
			' specify the amount by which to seek.
			speedRatioSettingTextBox = New TextBox()
			speedRatioSettingTextBox.Text = myControllableClock.Controller.SpeedRatio.ToString()
			speedRatioSettingTextBox.VerticalAlignment = VerticalAlignment.Top
			AddHandler speedRatioSettingTextBox.TextChanged, AddressOf seekAmountTextBox_TextChanged

			' Create a button to apply SpeedRatio changes.
			speedRatioButton = New Button()
			speedRatioButton.Content = "Apply Speed Ratio"
			AddHandler speedRatioButton.Click, AddressOf speedRatioButton_Clicked


			' Display the clock's global speed information.
			Dim myLabel As New Label()
			myLabel.Content = "CurrentGlobalSpeed "
			currentGlobalSpeedTextBlock = New TextBlock()
			currentGlobalSpeedTextBlock.Text = myControllableClock.CurrentGlobalSpeed.ToString()

			' List for speed changes.
			AddHandler myControllableClock.CurrentGlobalSpeedInvalidated, AddressOf myControllableClock_currentGlobalSpeedInvalidated

			Me.Content = mainPanel
		End Sub

		' Updates the clock's SpeedRatio.
		Private Sub speedRatioButton_Clicked(ByVal sender As Object, ByVal e As RoutedEventArgs)

			' This statement triggers a CurrentGlobalSpeedInvalidated
			' event.
			myControllableClock.Controller.SpeedRatio = doubleParseResult

		End Sub

		' Displays the current global speed.
		Private Sub myControllableClock_currentGlobalSpeedInvalidated(ByVal sender As Object, ByVal e As EventArgs)

			currentGlobalSpeedTextBlock.Text = myControllableClock.CurrentGlobalSpeed.ToString() & " Event triggered at: " & Date.Now.ToString()

		End Sub

		' Verifies that speedRatioSettingTextBox has valid text content.
		' If it doesn't, the speedRatioButton is disabled.
		Private Sub seekAmountTextBox_TextChanged(ByVal sender As Object, ByVal e As TextChangedEventArgs)

			Dim theTextBox As TextBox = CType(e.Source, TextBox)
			If theTextBox.Text Is Nothing OrElse theTextBox.Text.Length < 1 OrElse Double.TryParse(theTextBox.Text, System.Globalization.NumberStyles.Any, Nothing, doubleParseResult) = False Then
				speedRatioButton.IsEnabled = False
				speedRatioButton.IsEnabled = True
			End If

		End Sub

	End Class
End Namespace

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

© 2014 Microsoft