StringKeyFrame.InterpolateValue(String, Double) Method

Definition

Returns the interpolated value of a specific key frame at the progress increment provided.

public:
 System::String ^ InterpolateValue(System::String ^ baseValue, double keyFrameProgress);
public string InterpolateValue (string baseValue, double keyFrameProgress);
member this.InterpolateValue : string * double -> string
Public Function InterpolateValue (baseValue As String, keyFrameProgress As Double) As String

Parameters

baseValue
String

The value to animate from.

keyFrameProgress
Double

A value between 0.0 and 1.0, inclusive, that specifies the percentage of time that has elapsed for this key frame.

Returns

String

The output value of this key frame given the specified base value and progress.

Exceptions

Occurs if keyFrameProgress is not between 0.0 and 1.0, inclusive.

Remarks

The base value is typically the initial value of the property being animated or the Value of the previous key frame.

Most implementations will return the value of baseValue when keyFrameProgress is 0.0.

Applies to