/
DiscreteMatrixKeyFrame.xml
209 lines (205 loc) · 14.6 KB
/
DiscreteMatrixKeyFrame.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
<Type Name="DiscreteMatrixKeyFrame" FullName="System.Windows.Media.Animation.DiscreteMatrixKeyFrame">
<TypeSignature Language="C#" Value="public class DiscreteMatrixKeyFrame : System.Windows.Media.Animation.MatrixKeyFrame" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit DiscreteMatrixKeyFrame extends System.Windows.Media.Animation.MatrixKeyFrame" />
<TypeSignature Language="DocId" Value="T:System.Windows.Media.Animation.DiscreteMatrixKeyFrame" />
<TypeSignature Language="VB.NET" Value="Public Class DiscreteMatrixKeyFrame
Inherits MatrixKeyFrame" />
<TypeSignature Language="F#" Value="type DiscreteMatrixKeyFrame = class
 inherit MatrixKeyFrame" />
<TypeSignature Language="C++ CLI" Value="public ref class DiscreteMatrixKeyFrame : System::Windows::Media::Animation::MatrixKeyFrame" />
<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.MatrixKeyFrame</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Animates from the <see cref="T:System.Windows.Media.Matrix" /> value of the previous key frame to its own <see cref="P:System.Windows.Media.Animation.MatrixKeyFrame.Value" /> using discrete interpolation.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This class is used as part of a <xref:System.Windows.Media.Animation.MatrixKeyFrameCollection> in conjunction with a <xref:System.Windows.Media.Animation.MatrixAnimationUsingKeyFrames> to animate a <xref:System.Windows.Media.Matrix> property value along a set of key frames.
A key frame defines a segment of the <xref:System.Windows.Media.Animation.MatrixAnimationUsingKeyFrames> to which it belongs. Each key frame has a target <xref:System.Windows.Media.Animation.MatrixKeyFrame.Value%2A> and a <xref:System.Windows.Media.Animation.MatrixKeyFrame.KeyTime%2A>. The <xref:System.Windows.Media.Animation.MatrixKeyFrame.KeyTime%2A> specifies the time at which the key frame's <xref:System.Windows.Media.Animation.MatrixKeyFrame.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.
Discrete key frames like <xref:System.Windows.Media.Animation.DiscreteMatrixKeyFrame> create sudden "jumps" between values (no Interpolation). In other words, the animated property does not change until the key frame's key time is reached at which point the animated property goes suddenly to the target value.
]]></format>
</remarks>
<altmember cref="T:System.Windows.Media.Animation.MatrixAnimationUsingKeyFrames" />
<altmember cref="T:System.Windows.Media.Animation.MatrixKeyFrameCollection" />
</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.DiscreteMatrixKeyFrame" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DiscreteMatrixKeyFrame ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Animation.DiscreteMatrixKeyFrame.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 DiscreteMatrixKeyFrame();" />
<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.DiscreteMatrixKeyFrame" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DiscreteMatrixKeyFrame (System.Windows.Media.Matrix value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.Windows.Media.Matrix value) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Animation.DiscreteMatrixKeyFrame.#ctor(System.Windows.Media.Matrix)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (value As Matrix)" />
<MemberSignature Language="F#" Value="new System.Windows.Media.Animation.DiscreteMatrixKeyFrame : System.Windows.Media.Matrix -> System.Windows.Media.Animation.DiscreteMatrixKeyFrame" Usage="new System.Windows.Media.Animation.DiscreteMatrixKeyFrame value" />
<MemberSignature Language="C++ CLI" Value="public:
 DiscreteMatrixKeyFrame(System::Windows::Media::Matrix 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>
<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>
<Parameter Name="value" Type="System.Windows.Media.Matrix" />
</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.DiscreteMatrixKeyFrame" /> class with the specified ending value.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DiscreteMatrixKeyFrame (System.Windows.Media.Matrix value, System.Windows.Media.Animation.KeyTime keyTime);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.Windows.Media.Matrix value, valuetype System.Windows.Media.Animation.KeyTime keyTime) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Animation.DiscreteMatrixKeyFrame.#ctor(System.Windows.Media.Matrix,System.Windows.Media.Animation.KeyTime)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (value As Matrix, keyTime As KeyTime)" />
<MemberSignature Language="F#" Value="new System.Windows.Media.Animation.DiscreteMatrixKeyFrame : System.Windows.Media.Matrix * System.Windows.Media.Animation.KeyTime -> System.Windows.Media.Animation.DiscreteMatrixKeyFrame" Usage="new System.Windows.Media.Animation.DiscreteMatrixKeyFrame (value, keyTime)" />
<MemberSignature Language="C++ CLI" Value="public:
 DiscreteMatrixKeyFrame(System::Windows::Media::Matrix 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>
<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>
<Parameter Name="value" Type="System.Windows.Media.Matrix" />
<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.DiscreteMatrixKeyFrame" /> class with the specified ending value and key time.</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.DiscreteMatrixKeyFrame.CreateInstanceCore" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function CreateInstanceCore () As Freezable" />
<MemberSignature Language="F#" Value="override this.CreateInstanceCore : unit -> System.Windows.Freezable" Usage="discreteMatrixKeyFrame.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.DiscreteMatrixKeyFrame" />.</summary>
<returns>The new instance.</returns>
<remarks>To be added.</remarks>
<altmember cref="M:System.Windows.Freezable.CreateInstanceCore" />
</Docs>
</Member>
<Member MemberName="InterpolateValueCore">
<MemberSignature Language="C#" Value="protected override System.Windows.Media.Matrix InterpolateValueCore (System.Windows.Media.Matrix baseValue, double keyFrameProgress);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance valuetype System.Windows.Media.Matrix InterpolateValueCore(valuetype System.Windows.Media.Matrix baseValue, float64 keyFrameProgress) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Windows.Media.Animation.DiscreteMatrixKeyFrame.InterpolateValueCore(System.Windows.Media.Matrix,System.Double)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Function InterpolateValueCore (baseValue As Matrix, keyFrameProgress As Double) As Matrix" />
<MemberSignature Language="F#" Value="override this.InterpolateValueCore : System.Windows.Media.Matrix * double -> System.Windows.Media.Matrix" Usage="discreteMatrixKeyFrame.InterpolateValueCore (baseValue, keyFrameProgress)" />
<MemberSignature Language="C++ CLI" Value="protected:
 override System::Windows::Media::Matrix InterpolateValueCore(System::Windows::Media::Matrix 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.Windows.Media.Matrix</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="baseValue" Type="System.Windows.Media.Matrix" />
<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 discrete 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>
</Members>
</Type>