KeySpline Class

Reference

Definition

Namespace:: System.Windows.Media.Animation

Assembly:: PresentationCore.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

This class is used by a spline key frame to define animation progress.

public ref class KeySpline : System::Windows::Freezable, IFormattable

[System.ComponentModel.TypeConverter(typeof(System.Windows.KeySplineConverter))]
[System.Windows.Localizability(System.Windows.LocalizationCategory.None, Readability=System.Windows.Readability.Unreadable)]
public class KeySpline : System.Windows.Freezable, IFormattable

[<System.ComponentModel.TypeConverter(typeof(System.Windows.KeySplineConverter))>]
[<System.Windows.Localizability(System.Windows.LocalizationCategory.None, Readability=System.Windows.Readability.Unreadable)>]
type KeySpline = class
    inherit Freezable
    interface IFormattable

Public Class KeySpline
Inherits Freezable
Implements IFormattable

Inheritance: Object

DispatcherObject

DependencyObject

Freezable
KeySpline

Attributes: TypeConverterAttribute LocalizabilityAttribute

Implements: IFormattable

Remarks

To understand how a KeySpline works, it is helpful to understand cubic Bezier curves. A cubic Bezier curve is defined by a start point, an end point, and two control points. The two coordinates in the KeySpline defines those two control points. When describing key splines, the start point of the Bezier curve is always 0, and the end point is always 1, which is why you define only the two control points. The resulting curve specifies how an animation is interpolated during a time segment; that is, the curve represents the rate of change in the animation's target attribute over the time segment. To better see the relationship between animation progress and a Bezier curve, see Key Spline Animation Sample.

XAML Attribute Usage

<object property="cp1X,cp1Y cp2X,cp2Y"/>

XAML Values

cp1X
X component of the curve's first control point. The value must be between 0 and 1.

cp1Y
Y component of the curve's first control point. The value must be between 0 and 1.

cp2X
X component of the curve's second control point. The value must be between 0 and 1.

cp2Y
Y component of the curve's second control point. The value must be between 0 and 1.

The separator between values may be either comma or one or more spaces. The convention shown here of commas between components of a point and space between points is a recommended convention. Do not use a comma as the decimal point within the values of point components, even if that is the norm in your culture. XAML values are treated as en-us in all type conversion cases, and the comma is thus interpreted as the separator and not as the intended decimal point.

Constructors

KeySpline()	Initializes a new instance of the KeySpline class.
KeySpline(Double, Double, Double, Double)	Initializes a new instance of the KeySpline class with the specified coordinates for the control points.
KeySpline(Point, Point)	Initializes a new instance of the KeySpline class with the specified control points.

Properties

CanFreeze	Gets a value that indicates whether the object can be made unmodifiable. (Inherited from Freezable)
ControlPoint1	The first control point used to define a Bezier curve that describes a KeySpline.
ControlPoint2	The second control point used to define a Bezier curve that describes a KeySpline.
DependencyObjectType	Gets the DependencyObjectType that wraps the CLR type of this instance. (Inherited from DependencyObject)
Dispatcher	Gets the Dispatcher this DispatcherObject is associated with. (Inherited from DispatcherObject)
IsFrozen	Gets a value that indicates whether the object is currently modifiable. (Inherited from Freezable)
IsSealed	Gets a value that indicates whether this instance is currently sealed (read-only). (Inherited from DependencyObject)

Methods

CheckAccess()	Determines whether the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject)
ClearValue(DependencyProperty)	Clears the local value of a property. The property to be cleared is specified by a DependencyProperty identifier. (Inherited from DependencyObject)
ClearValue(DependencyPropertyKey)	Clears the local value of a read-only property. The property to be cleared is specified by a DependencyPropertyKey. (Inherited from DependencyObject)
Clone()	Creates a modifiable clone of the Freezable, making deep copies of the object's values. When copying the object's dependency properties, this method copies expressions (which might no longer resolve) but not animations or their current values. (Inherited from Freezable)
CloneCore(Freezable)	Makes this instance a deep copy of the specified KeySpline. When copying dependency properties, this method copies resource references and data bindings (but they might no longer resolve) but not animations or their current values.
CloneCurrentValue()	Creates a modifiable clone (deep copy) of the Freezable using its current values. (Inherited from Freezable)
CloneCurrentValueCore(Freezable)	Makes this instance a modifiable deep copy of the specified KeySpline using current property values. Resource references, data bindings, and animations are not copied, but their current values are.
CoerceValue(DependencyProperty)	Coerces the value of the specified dependency property. This is accomplished by invoking any CoerceValueCallback function specified in property metadata for the dependency property as it exists on the calling DependencyObject. (Inherited from DependencyObject)
CreateInstance()	Initializes a new instance of the Freezable class. (Inherited from Freezable)
CreateInstanceCore()	Creates a new instance of KeySpline.
Equals(Object)	Determines whether a provided DependencyObject is equivalent to the current DependencyObject. (Inherited from DependencyObject)
Freeze()	Makes the current object unmodifiable and sets its IsFrozen property to `true`. (Inherited from Freezable)
FreezeCore(Boolean)	Makes the Freezable object unmodifiable or tests whether it can be made unmodifiable. (Inherited from Freezable)
GetAsFrozen()	Creates a frozen copy of the Freezable, using base (non-animated) property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable)
GetAsFrozenCore(Freezable)	Makes this instance a clone of the specified KeySpline object.
GetCurrentValueAsFrozen()	Creates a frozen copy of the Freezable using current property values. Because the copy is frozen, any frozen sub-objects are copied by reference. (Inherited from Freezable)
GetCurrentValueAsFrozenCore(Freezable)	Makes this instance a frozen clone of the specified KeySpline. Resource references, data bindings, and animations are not copied, but their current values are.
GetHashCode()	Gets a hash code for this DependencyObject. (Inherited from DependencyObject)
GetLocalValueEnumerator()	Creates a specialized enumerator for determining which dependency properties have locally set values on this DependencyObject. (Inherited from DependencyObject)
GetSplineProgress(Double)	Calculates spline progress from a supplied linear progress.
GetType()	Gets the Type of the current instance. (Inherited from Object)
GetValue(DependencyProperty)	Returns the current effective value of a dependency property on this instance of a DependencyObject. (Inherited from DependencyObject)
InvalidateProperty(DependencyProperty)	Re-evaluates the effective value for the specified dependency property. (Inherited from DependencyObject)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnChanged()	Called when the current KeySpline object is modified.
OnFreezablePropertyChanged(DependencyObject, DependencyObject)	Ensures that appropriate context pointers are established for a DependencyObjectType data member that has just been set. (Inherited from Freezable)
OnFreezablePropertyChanged(DependencyObject, DependencyObject, DependencyProperty)	This member supports the Windows Presentation Foundation (WPF) infrastructure and is not intended to be used directly from your code. (Inherited from Freezable)
OnPropertyChanged(DependencyPropertyChangedEventArgs)	Overrides the DependencyObject implementation of OnPropertyChanged(DependencyPropertyChangedEventArgs) to also invoke any Changed handlers in response to a changing dependency property of type Freezable. (Inherited from Freezable)
ReadLocalValue(DependencyProperty)	Returns the local value of a dependency property, if it exists. (Inherited from DependencyObject)
ReadPreamble()	Ensures that the Freezable is being accessed from a valid thread. Inheritors of Freezable must call this method at the beginning of any API that reads data members that are not dependency properties. (Inherited from Freezable)
SetCurrentValue(DependencyProperty, Object)	Sets the value of a dependency property without changing its value source. (Inherited from DependencyObject)
SetValue(DependencyProperty, Object)	Sets the local value of a dependency property, specified by its dependency property identifier. (Inherited from DependencyObject)
SetValue(DependencyPropertyKey, Object)	Sets the local value of a read-only dependency property, specified by the DependencyPropertyKey identifier of the dependency property. (Inherited from DependencyObject)
ShouldSerializeProperty(DependencyProperty)	Returns a value that indicates whether serialization processes should serialize the value for the provided dependency property. (Inherited from DependencyObject)
ToString()	Creates a string representation of this instance of KeySpline based on the current culture.
ToString(IFormatProvider)	Creates a string representation of this KeySpline based on the supplied IFormatProvider.
VerifyAccess()	Enforces that the calling thread has access to this DispatcherObject. (Inherited from DispatcherObject)
WritePostscript()	Raises the Changed event for the Freezable and invokes its OnChanged() method. Classes that derive from Freezable should call this method at the end of any API that modifies class members that are not stored as dependency properties. (Inherited from Freezable)
WritePreamble()	Verifies that the Freezable is not frozen and that it is being accessed from a valid threading context. Freezable inheritors should call this method at the beginning of any API that writes to data members that are not dependency properties. (Inherited from Freezable)

Events

Changed

Occurs when the Freezable or an object it contains is modified.

(Inherited from Freezable)

Explicit Interface Implementations

IFormattable.ToString(String, IFormatProvider)

Formats the value of the current instance using the specified format.

Applies to

Dela via