diff options
Diffstat (limited to 'docs/Xamarin.Forms.Core/Xamarin.Forms/Easing.xml')
| -rw-r--r-- | docs/Xamarin.Forms.Core/Xamarin.Forms/Easing.xml | 495 |
1 files changed, 495 insertions, 0 deletions
diff --git a/docs/Xamarin.Forms.Core/Xamarin.Forms/Easing.xml b/docs/Xamarin.Forms.Core/Xamarin.Forms/Easing.xml new file mode 100644 index 00000000..ffd8b16f --- /dev/null +++ b/docs/Xamarin.Forms.Core/Xamarin.Forms/Easing.xml @@ -0,0 +1,495 @@ +<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<double,double> easingFunc);" /> + <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Func`2<float64, float64> 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<System.Double,System.Double>" /> + </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>Jumps towards, and then bounces as it settles at the final value. (Note: Known bug in 1.0.0 release)</summary> + <remarks> + <para>NOTE: The 1.0.0. release of <see cref="F:Xamarin.Forms.Easing.BounceIn" /> has a known bug and runs backwards. The following graph shows the desired behavior, shortly to be released:</para> + <para> + <img href="Easing.BounceIn.png" /> + </para> + </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<double,double> func);" /> + <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname class Xamarin.Forms.Easing op_Implicit(class System.Func`2<float64, float64> 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<System.Double,System.Double>" /> + </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> |