-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
SplineSingleKeyFrame.xml
298 lines (290 loc) · 21 KB
/
SplineSingleKeyFrame.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
<Type Name="SplineSingleKeyFrame" FullName="System.Windows.Media.Animation.SplineSingleKeyFrame">
<TypeSignature Language="C#" Value="public class SplineSingleKeyFrame : System.Windows.Media.Animation.SingleKeyFrame" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SplineSingleKeyFrame extends System.Windows.Media.Animation.SingleKeyFrame" />
<TypeSignature Language="DocId" Value="T:System.Windows.Media.Animation.SplineSingleKeyFrame" />
<TypeSignature Language="VB.NET" Value="Public Class SplineSingleKeyFrame
Inherits SingleKeyFrame" />
<TypeSignature Language="F#" Value="type SplineSingleKeyFrame = class
 inherit SingleKeyFrame" />
<TypeSignature Language="C++ CLI" Value="public ref class SplineSingleKeyFrame : System::Windows::Media::Animation::SingleKeyFrame" />
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Windows.Media.Animation.SingleKeyFrame</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Animates from the <see cref="T:System.Single" /> value of the previous key frame to its own <see cref="P:System.Windows.Media.Animation.SingleKeyFrame.Value" /> using splined interpolation.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This class is used as part of a <xref:System.Windows.Media.Animation.SingleKeyFrameCollection> in conjunction with a <xref:System.Windows.Media.Animation.SingleAnimationUsingKeyFrames> to animate a <xref:System.Single> property value along a set of key frames.
A key frame defines a segment of the <xref:System.Windows.Media.Animation.SingleAnimationUsingKeyFrames> to which it belongs. Each key frame has a target <xref:System.Windows.Media.Animation.SingleKeyFrame.Value%2A> and a <xref:System.Windows.Media.Animation.SingleKeyFrame.KeyTime%2A>. The <xref:System.Windows.Media.Animation.SingleKeyFrame.KeyTime%2A> specifies the time at which the key frame's <xref:System.Windows.Media.Animation.SingleKeyFrame.Value%2A> should be reached. A key frame animates from the target value of the previous key frame to its own target value. It starts when the previous key frame ends and ends when its own key time is reached.
Spline key frames like <xref:System.Windows.Media.Animation.SplineSingleKeyFrame> creates a variable transition between values which is determined by the <xref:System.Windows.Media.Animation.SplineSingleKeyFrame.KeySpline%2A> property. Splined interpolation can be used to achieve more realistic "real world" timing effects such as acceleration and deceleration.
]]></format>
</remarks>
<altmember cref="T:System.Windows.Media.Animation.SingleAnimationUsingKeyFrames" />
<altmember cref="T:System.Windows.Media.Animation.SingleKeyFrameCollection" />
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Windows.Media.Animation.SplineSingleKeyFrame" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SplineSingleKeyFrame ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Animation.SplineSingleKeyFrame.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 SplineSingleKeyFrame();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Windows.Media.Animation.SplineSingleKeyFrame" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SplineSingleKeyFrame (float value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(float32 value) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Animation.SplineSingleKeyFrame.#ctor(System.Single)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (value As Single)" />
<MemberSignature Language="F#" Value="new System.Windows.Media.Animation.SplineSingleKeyFrame : single -> System.Windows.Media.Animation.SplineSingleKeyFrame" Usage="new System.Windows.Media.Animation.SplineSingleKeyFrame value" />
<MemberSignature Language="C++ CLI" Value="public:
 SplineSingleKeyFrame(float value);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="value" Type="System.Single" />
</Parameters>
<Docs>
<param name="value">Ending value (also known as "target value") for the key frame.</param>
<summary>Initializes a new instance of the <see cref="T:System.Windows.Media.Animation.SplineSingleKeyFrame" /> class with the specified ending value.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SplineSingleKeyFrame (float value, System.Windows.Media.Animation.KeyTime keyTime);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(float32 value, valuetype System.Windows.Media.Animation.KeyTime keyTime) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Animation.SplineSingleKeyFrame.#ctor(System.Single,System.Windows.Media.Animation.KeyTime)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (value As Single, keyTime As KeyTime)" />
<MemberSignature Language="F#" Value="new System.Windows.Media.Animation.SplineSingleKeyFrame : single * System.Windows.Media.Animation.KeyTime -> System.Windows.Media.Animation.SplineSingleKeyFrame" Usage="new System.Windows.Media.Animation.SplineSingleKeyFrame (value, keyTime)" />
<MemberSignature Language="C++ CLI" Value="public:
 SplineSingleKeyFrame(float value, System::Windows::Media::Animation::KeyTime keyTime);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="value" Type="System.Single" />
<Parameter Name="keyTime" Type="System.Windows.Media.Animation.KeyTime" />
</Parameters>
<Docs>
<param name="value">Ending value (also known as "target value") for the key frame.</param>
<param name="keyTime">Key time for the key frame. The key time determines when the target value is reached which is also when the key frame ends.</param>
<summary>Initializes a new instance of the <see cref="T:System.Windows.Media.Animation.SplineSingleKeyFrame" /> class with the specified ending value and key time.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SplineSingleKeyFrame (float value, System.Windows.Media.Animation.KeyTime keyTime, System.Windows.Media.Animation.KeySpline keySpline);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(float32 value, valuetype System.Windows.Media.Animation.KeyTime keyTime, class System.Windows.Media.Animation.KeySpline keySpline) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Animation.SplineSingleKeyFrame.#ctor(System.Single,System.Windows.Media.Animation.KeyTime,System.Windows.Media.Animation.KeySpline)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (value As Single, keyTime As KeyTime, keySpline As KeySpline)" />
<MemberSignature Language="F#" Value="new System.Windows.Media.Animation.SplineSingleKeyFrame : single * System.Windows.Media.Animation.KeyTime * System.Windows.Media.Animation.KeySpline -> System.Windows.Media.Animation.SplineSingleKeyFrame" Usage="new System.Windows.Media.Animation.SplineSingleKeyFrame (value, keyTime, keySpline)" />
<MemberSignature Language="C++ CLI" Value="public:
 SplineSingleKeyFrame(float value, System::Windows::Media::Animation::KeyTime keyTime, System::Windows::Media::Animation::KeySpline ^ keySpline);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="value" Type="System.Single" />
<Parameter Name="keyTime" Type="System.Windows.Media.Animation.KeyTime" />
<Parameter Name="keySpline" Type="System.Windows.Media.Animation.KeySpline" />
</Parameters>
<Docs>
<param name="value">Ending value (also known as "target value") for the key frame.</param>
<param name="keyTime">Key time for the key frame. The key time determines when the target value is reached which is also when the key frame ends.</param>
<param name="keySpline">
<see cref="T:System.Windows.Media.Animation.KeySpline" /> for the key frame. The <see cref="T:System.Windows.Media.Animation.KeySpline" /> represents a Bezier curve which defines animation progress of the key frame.</param>
<summary>Initializes a new instance of the <see cref="T:System.Windows.Media.Animation.SplineSingleKeyFrame" /> class with the specified ending value, key time, and <see cref="T:System.Windows.Media.Animation.KeySpline" />.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CreateInstanceCore">
<MemberSignature Language="C#" Value="protected override System.Windows.Freezable CreateInstanceCore ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance class System.Windows.Freezable CreateInstanceCore() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Animation.SplineSingleKeyFrame.CreateInstanceCore" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function CreateInstanceCore () As Freezable" />
<MemberSignature Language="F#" Value="override this.CreateInstanceCore : unit -> System.Windows.Freezable" Usage="splineSingleKeyFrame.CreateInstanceCore " />
<MemberSignature Language="C++ CLI" Value="protected:
 override System::Windows::Freezable ^ CreateInstanceCore();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.Freezable</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Creates a new instance of <see cref="T:System.Windows.Media.Animation.SplineSingleKeyFrame" /> class.</summary>
<returns>A new instance of <see cref="T:System.Windows.Media.Animation.SplineSingleKeyFrame" /> class.</returns>
<remarks>To be added.</remarks>
<altmember cref="M:System.Windows.Freezable.CreateInstanceCore" />
</Docs>
</Member>
<Member MemberName="InterpolateValueCore">
<MemberSignature Language="C#" Value="protected override float InterpolateValueCore (float baseValue, double keyFrameProgress);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance float32 InterpolateValueCore(float32 baseValue, float64 keyFrameProgress) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Animation.SplineSingleKeyFrame.InterpolateValueCore(System.Single,System.Double)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function InterpolateValueCore (baseValue As Single, keyFrameProgress As Double) As Single" />
<MemberSignature Language="F#" Value="override this.InterpolateValueCore : single * double -> single" Usage="splineSingleKeyFrame.InterpolateValueCore (baseValue, keyFrameProgress)" />
<MemberSignature Language="C++ CLI" Value="protected:
 override float InterpolateValueCore(float baseValue, double keyFrameProgress);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Single</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="baseValue" Type="System.Single" />
<Parameter Name="keyFrameProgress" Type="System.Double" />
</Parameters>
<Docs>
<param name="baseValue">The value to animate from.</param>
<param name="keyFrameProgress">A value between 0.0 and 1.0, inclusive, that specifies the percentage of time that has elapsed for this key frame.</param>
<summary>Uses splined interpolation to transition between the previous key frame value and the value of the current key frame.</summary>
<returns>The output value of this key frame given the specified base value and progress.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="KeySpline">
<MemberSignature Language="C#" Value="public System.Windows.Media.Animation.KeySpline KeySpline { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Windows.Media.Animation.KeySpline KeySpline" />
<MemberSignature Language="DocId" Value="P:System.Windows.Media.Animation.SplineSingleKeyFrame.KeySpline" />
<MemberSignature Language="VB.NET" Value="Public Property KeySpline As KeySpline" />
<MemberSignature Language="F#" Value="member this.KeySpline : System.Windows.Media.Animation.KeySpline with get, set" Usage="System.Windows.Media.Animation.SplineSingleKeyFrame.KeySpline" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Windows::Media::Animation::KeySpline ^ KeySpline { System::Windows::Media::Animation::KeySpline ^ get(); void set(System::Windows::Media::Animation::KeySpline ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.Media.Animation.KeySpline</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the two control points that define animation progress for this key frame.</summary>
<value>The two control points that specify the cubic Bezier curve which defines the progress of the key frame.</value>
<remarks>
<format type="text/markdown">< .
<a name="dependencyPropertyInfo_KeySpline"></a>
## Dependency Property Information
|||
|-|-|
|Identifier field|<xref:System.Windows.Media.Animation.SplineSingleKeyFrame.KeySplineProperty>|
|Metadata properties set to `true`|None|
]]></format>
</remarks>
<related type="ExternalDocumentation" href="https://go.microsoft.com/fwlink/?LinkID=160011">Key Spline Animation Sample</related>
</Docs>
</Member>
<Member MemberName="KeySplineProperty">
<MemberSignature Language="C#" Value="public static readonly System.Windows.DependencyProperty KeySplineProperty;" />
<MemberSignature Language="ILAsm" Value=".field public static initonly class System.Windows.DependencyProperty KeySplineProperty" />
<MemberSignature Language="DocId" Value="F:System.Windows.Media.Animation.SplineSingleKeyFrame.KeySplineProperty" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly KeySplineProperty As DependencyProperty " />
<MemberSignature Language="F#" Value=" staticval mutable KeySplineProperty : System.Windows.DependencyProperty" Usage="System.Windows.Media.Animation.SplineSingleKeyFrame.KeySplineProperty" />
<MemberSignature Language="C++ CLI" Value="public: static initonly System::Windows::DependencyProperty ^ KeySplineProperty;" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>PresentationCore</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Windows.DependencyProperty</ReturnType>
</ReturnValue>
<Docs>
<summary>Identifies the <see cref="P:System.Windows.Media.Animation.SplineSingleKeyFrame.KeySpline" /> dependency property.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>