summaryrefslogtreecommitdiff
path: root/docs/Xamarin.Forms.Core/Xamarin.Forms/Easing.xml
blob: 5b0dbb80454cd1c822c3a5463cce7ff02f9b4bac (plain)
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
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
<Type Name="Easing" FullName="Xamarin.Forms.Easing">
  <TypeSignature Language="C#" Value="public class Easing" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi Easing extends System.Object" />
  <AssemblyInfo>
    <AssemblyName>Xamarin.Forms.Core</AssemblyName>
    <AssemblyVersion>1.0.0.0</AssemblyVersion>
    <AssemblyVersion>1.1.0.0</AssemblyVersion>
    <AssemblyVersion>1.2.0.0</AssemblyVersion>
    <AssemblyVersion>1.3.0.0</AssemblyVersion>
    <AssemblyVersion>1.4.0.0</AssemblyVersion>
    <AssemblyVersion>1.5.0.0</AssemblyVersion>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Docs>
    <summary>Functions that modify values non-linearly, generally used for animations.</summary>
    <remarks>
      <para>Easing functions are applied to input values in the range [0,1]. The cubic easing functions are often considered to look most natural.</para>
      <para>If developers wish to use their own easing functions, they should return a value of 0 for an input of 0 and a value of 1 for an input of 1 or the animation will have a jump.</para>
      <para>The predefined <see cref="T:Xamarin.Forms.Easing" /> functions have the following forms:</para>
      <list type="table">
        <listheader>
          <term>Member</term>
          <description>Graph</description>
        </listheader>
        <item>
          <term>
            <see cref="F:Xamarin.Forms.Easing.BounceIn" />
          </term>
          <description>
            <para>
              <img href="Easing.BounceIn.png" />
            </para>
          </description>
        </item>
        <item>
          <term>
            <see cref="F:Xamarin.Forms.Easing.BounceOut" />
          </term>
          <description>
            <para>
              <img href="Easing.BounceOut.png" />
            </para>
          </description>
        </item>
        <item>
          <term>
            <see cref="F:Xamarin.Forms.Easing.CubicIn" />
          </term>
          <description>
            <para>
              <img href="Easing.CubicIn.png" />
            </para>
          </description>
        </item>
        <item>
          <term>
            <see cref="F:Xamarin.Forms.Easing.CubicInOut" />
          </term>
          <description>
            <para>
              <img href="Easing.CubicInOut.png" />
            </para>
          </description>
        </item>
        <item>
          <term>
            <see cref="F:Xamarin.Forms.Easing.CubicOut" />
          </term>
          <description>
            <para>
              <img href="Easing.CubicOut.png" />
            </para>
          </description>
        </item>
        <item>
          <term>
            <see cref="F:Xamarin.Forms.Easing.Linear" />
          </term>
          <description>
            <para>
              <img href="Easing.Linear.png" />
            </para>
          </description>
        </item>
        <item>
          <term>
            <see cref="F:Xamarin.Forms.Easing.SinIn" />
          </term>
          <description>
            <para>
              <img href="Easing.SinIn.gif" />
            </para>
          </description>
        </item>
        <item>
          <term>
            <see cref="F:Xamarin.Forms.Easing.SinInOut" />
          </term>
          <description>
            <para>
              <img href="Easing.SinInOut.gif" />
            </para>
          </description>
        </item>
        <item>
          <term>
            <see cref="F:Xamarin.Forms.Easing.SinOut" />
          </term>
          <description>
            <para>
              <img href="Easing.SinOut.gif" />
            </para>
          </description>
        </item>
        <item>
          <term>
            <see cref="F:Xamarin.Forms.Easing.SpringIn" />
          </term>
          <description>
            <para>
              <img href="Easing.SpringIn.png" />
            </para>
          </description>
        </item>
        <item>
          <term>
            <see cref="F:Xamarin.Forms.Easing.SpringOut" />
          </term>
          <description>
            <para>
              <img href="Easing.SpringOut.png" />
            </para>
          </description>
        </item>
      </list>
    </remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public Easing (Func&lt;double,double&gt; easingFunc);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Func`2&lt;float64, float64&gt; easingFunc) cil managed" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
        <AssemblyVersion>1.2.0.0</AssemblyVersion>
        <AssemblyVersion>1.3.0.0</AssemblyVersion>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
        <AssemblyVersion>1.5.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="easingFunc" Type="System.Func&lt;System.Double,System.Double&gt;" />
      </Parameters>
      <Docs>
        <param name="easingFunc">To be added.</param>
        <summary>Creates a new <see cref="T:Xamarin.Forms.Easing" /> object with the <paramref name="easingFunc" /> function.</summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="BounceIn">
      <MemberSignature Language="C#" Value="public static readonly Xamarin.Forms.Easing BounceIn;" />
      <MemberSignature Language="ILAsm" Value=".field public static initonly class Xamarin.Forms.Easing BounceIn" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
        <AssemblyVersion>1.2.0.0</AssemblyVersion>
        <AssemblyVersion>1.3.0.0</AssemblyVersion>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
        <AssemblyVersion>1.5.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Xamarin.Forms.Easing</ReturnType>
      </ReturnValue>
      <Docs>
        <summary><para>Jumps towards, and then bounces as it settles at the final value.</para></summary>
        <remarks>
            <img href="Easing.BounceIn.png" />
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="BounceOut">
      <MemberSignature Language="C#" Value="public static readonly Xamarin.Forms.Easing BounceOut;" />
      <MemberSignature Language="ILAsm" Value=".field public static initonly class Xamarin.Forms.Easing BounceOut" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
        <AssemblyVersion>1.2.0.0</AssemblyVersion>
        <AssemblyVersion>1.3.0.0</AssemblyVersion>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
        <AssemblyVersion>1.5.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Xamarin.Forms.Easing</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Leaps to final values, bounces 3 times, and settles.</summary>
        <remarks>
          <para>
            <img href="Easing.BounceOut.png" />
          </para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="CubicIn">
      <MemberSignature Language="C#" Value="public static readonly Xamarin.Forms.Easing CubicIn;" />
      <MemberSignature Language="ILAsm" Value=".field public static initonly class Xamarin.Forms.Easing CubicIn" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
        <AssemblyVersion>1.2.0.0</AssemblyVersion>
        <AssemblyVersion>1.3.0.0</AssemblyVersion>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
        <AssemblyVersion>1.5.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Xamarin.Forms.Easing</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Starts slowly and accelerates.</summary>
        <remarks>
          <para>
            <img href="Easing.CubicIn.png" />
          </para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="CubicInOut">
      <MemberSignature Language="C#" Value="public static readonly Xamarin.Forms.Easing CubicInOut;" />
      <MemberSignature Language="ILAsm" Value=".field public static initonly class Xamarin.Forms.Easing CubicInOut" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
        <AssemblyVersion>1.2.0.0</AssemblyVersion>
        <AssemblyVersion>1.3.0.0</AssemblyVersion>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
        <AssemblyVersion>1.5.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Xamarin.Forms.Easing</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Accelerates and decelerates. Often a natural-looking choice.</summary>
        <remarks>
          <para>
            <img href="Easing.CubicInOut.png" />
          </para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="CubicOut">
      <MemberSignature Language="C#" Value="public static readonly Xamarin.Forms.Easing CubicOut;" />
      <MemberSignature Language="ILAsm" Value=".field public static initonly class Xamarin.Forms.Easing CubicOut" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
        <AssemblyVersion>1.2.0.0</AssemblyVersion>
        <AssemblyVersion>1.3.0.0</AssemblyVersion>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
        <AssemblyVersion>1.5.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Xamarin.Forms.Easing</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Starts quickly and the decelerates.</summary>
        <remarks>
          <para>
            <img href="Easing.CubicOut.png" />
          </para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Ease">
      <MemberSignature Language="C#" Value="public double Ease (double v);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig instance float64 Ease(float64 v) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
        <AssemblyVersion>1.2.0.0</AssemblyVersion>
        <AssemblyVersion>1.3.0.0</AssemblyVersion>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
        <AssemblyVersion>1.5.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Double</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="v" Type="System.Double" />
      </Parameters>
      <Docs>
        <param name="v">A value in the range [0,1] to which the easing function should be applied.</param>
        <summary>Applies the easing function to the specified value <paramref name="v" />.</summary>
        <returns>The value of the easing function when applied to the value <paramref name="v" />.</returns>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Linear">
      <MemberSignature Language="C#" Value="public static readonly Xamarin.Forms.Easing Linear;" />
      <MemberSignature Language="ILAsm" Value=".field public static initonly class Xamarin.Forms.Easing Linear" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
        <AssemblyVersion>1.2.0.0</AssemblyVersion>
        <AssemblyVersion>1.3.0.0</AssemblyVersion>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
        <AssemblyVersion>1.5.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Xamarin.Forms.Easing</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Linear transformation.</summary>
        <remarks>
          <para>
            <img href="Easing.Linear.png" />
          </para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="op_Implicit">
      <MemberSignature Language="C#" Value="public static Xamarin.Forms.Easing op_Implicit (Func&lt;double,double&gt; func);" />
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname class Xamarin.Forms.Easing op_Implicit(class System.Func`2&lt;float64, float64&gt; func) cil managed" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
        <AssemblyVersion>1.2.0.0</AssemblyVersion>
        <AssemblyVersion>1.3.0.0</AssemblyVersion>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
        <AssemblyVersion>1.5.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Xamarin.Forms.Easing</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="func" Type="System.Func&lt;System.Double,System.Double&gt;" />
      </Parameters>
      <Docs>
        <param name="func">An easing function.</param>
        <summary>Converts a function into an <see cref="T:Xamarin.Forms.Easing" />.</summary>
        <returns>An <see cref="T:Xamarin.Forms.Easing" /> for the <paramref name="func" />.</returns>
        <remarks>
          <para>An easing function should return a value of (or near) 0 at 0 and 1 (or near) for 1. </para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="SinIn">
      <MemberSignature Language="C#" Value="public static readonly Xamarin.Forms.Easing SinIn;" />
      <MemberSignature Language="ILAsm" Value=".field public static initonly class Xamarin.Forms.Easing SinIn" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
        <AssemblyVersion>1.2.0.0</AssemblyVersion>
        <AssemblyVersion>1.3.0.0</AssemblyVersion>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
        <AssemblyVersion>1.5.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Xamarin.Forms.Easing</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Smoothly accelerates.</summary>
        <remarks>
          <para>
            <img href="Easing.SinIn.gif" />
          </para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="SinInOut">
      <MemberSignature Language="C#" Value="public static readonly Xamarin.Forms.Easing SinInOut;" />
      <MemberSignature Language="ILAsm" Value=".field public static initonly class Xamarin.Forms.Easing SinInOut" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
        <AssemblyVersion>1.2.0.0</AssemblyVersion>
        <AssemblyVersion>1.3.0.0</AssemblyVersion>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
        <AssemblyVersion>1.5.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Xamarin.Forms.Easing</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Accelerates in and out.</summary>
        <remarks>
          <para>
            <img href="Easing.SinInOut.gif" />
          </para>.</remarks>
      </Docs>
    </Member>
    <Member MemberName="SinOut">
      <MemberSignature Language="C#" Value="public static readonly Xamarin.Forms.Easing SinOut;" />
      <MemberSignature Language="ILAsm" Value=".field public static initonly class Xamarin.Forms.Easing SinOut" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
        <AssemblyVersion>1.2.0.0</AssemblyVersion>
        <AssemblyVersion>1.3.0.0</AssemblyVersion>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
        <AssemblyVersion>1.5.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Xamarin.Forms.Easing</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Smoothly decelerates.</summary>
        <remarks>
          <para>
            <img href="Easing.SinOut.gif" />
          </para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="SpringIn">
      <MemberSignature Language="C#" Value="public static readonly Xamarin.Forms.Easing SpringIn;" />
      <MemberSignature Language="ILAsm" Value=".field public static initonly class Xamarin.Forms.Easing SpringIn" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
        <AssemblyVersion>1.2.0.0</AssemblyVersion>
        <AssemblyVersion>1.3.0.0</AssemblyVersion>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
        <AssemblyVersion>1.5.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Xamarin.Forms.Easing</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Moves away and then leaps toward the final value.</summary>
        <remarks>
          <para>
            <img href="Easing.SpringIn.png" />
          </para>
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="SpringOut">
      <MemberSignature Language="C#" Value="public static readonly Xamarin.Forms.Easing SpringOut;" />
      <MemberSignature Language="ILAsm" Value=".field public static initonly class Xamarin.Forms.Easing SpringOut" />
      <MemberType>Field</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>1.0.0.0</AssemblyVersion>
        <AssemblyVersion>1.1.0.0</AssemblyVersion>
        <AssemblyVersion>1.2.0.0</AssemblyVersion>
        <AssemblyVersion>1.3.0.0</AssemblyVersion>
        <AssemblyVersion>1.4.0.0</AssemblyVersion>
        <AssemblyVersion>1.5.0.0</AssemblyVersion>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>Xamarin.Forms.Easing</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Overshoots and then returns.</summary>
        <remarks>
          <para>
            <img href="Easing.SpringOut.png" />
          </para>
        </remarks>
      </Docs>
    </Member>
  </Members>
</Type>