AnimationBuilder.Offset Method

Definition

Namespace:

Microsoft.Toolkit.Uwp.UI.Animations

Assembly:

Microsoft.Toolkit.Uwp.UI.Animations.dll

Package:

Microsoft.Toolkit.Uwp.UI.Animations v7.1.2

Overloads

Offset()	Adds a new composition offset translation animation for all axes to the current schedule.
Offset(Axis)	Adds a new composition offset animation for a single axis to the current schedule.
Offset(Vector2, Nullable<Vector2>, Nullable<TimeSpan>, Nullable<TimeSpan>, Nullable<RepeatOption>, EasingType, EasingMode)	Adds a new composition offset animation for the X and Y axes to the current schedule.
Offset(Vector3, Nullable<Vector3>, Nullable<TimeSpan>, Nullable<TimeSpan>, Nullable<RepeatOption>, EasingType, EasingMode)	Adds a new composition offset translation animation for all axes to the current schedule.
Offset(Axis, Double, Nullable<Double>, Nullable<TimeSpan>, Nullable<TimeSpan>, Nullable<RepeatOption>, EasingType, EasingMode)	Adds a new composition offset animation for a single axis to the current schedule.

Offset()

Adds a new composition offset translation animation for all axes to the current schedule.

public Microsoft.Toolkit.Uwp.UI.Animations.IPropertyAnimationBuilder<System.Numerics.Vector3> Offset ();

member this.Offset : unit -> Microsoft.Toolkit.Uwp.UI.Animations.IPropertyAnimationBuilder<System.Numerics.Vector3>

Public Function Offset () As IPropertyAnimationBuilder(Of Vector3)

Returns

IPropertyAnimationBuilder<Vector3>

An IPropertyAnimationBuilder<T> instance to configure the animation.

Remarks

This animation is only available on the composition layer.

Offset(Axis)

Adds a new composition offset animation for a single axis to the current schedule.

public Microsoft.Toolkit.Uwp.UI.Animations.IPropertyAnimationBuilder<double> Offset (Microsoft.Toolkit.Uwp.UI.Animations.Axis axis);

member this.Offset : Microsoft.Toolkit.Uwp.UI.Animations.Axis -> Microsoft.Toolkit.Uwp.UI.Animations.IPropertyAnimationBuilder<double>

Public Function Offset (axis As Axis) As IPropertyAnimationBuilder(Of Double)

Parameters

axis

Axis

The target translation axis to animate.

Returns

IPropertyAnimationBuilder<Double>

An IPropertyAnimationBuilder<T> instance to configure the animation.

Remarks

This animation is only available on the composition layer.

Offset(Vector2, Nullable<Vector2>, Nullable<TimeSpan>, Nullable<TimeSpan>, Nullable<RepeatOption>, EasingType, EasingMode)

Adds a new composition offset animation for the X and Y axes to the current schedule.

public Microsoft.Toolkit.Uwp.UI.Animations.AnimationBuilder Offset (System.Numerics.Vector2 to, System.Numerics.Vector2? from = default, TimeSpan? delay = default, TimeSpan? duration = default, Microsoft.Toolkit.Uwp.UI.Animations.RepeatOption? repeat = default, Microsoft.Toolkit.Uwp.UI.Animations.EasingType easingType = Microsoft.Toolkit.Uwp.UI.Animations.EasingType.Default, Windows.UI.Xaml.Media.Animation.EasingMode easingMode = Windows.UI.Xaml.Media.Animation.EasingMode.EaseInOut);

member this.Offset : System.Numerics.Vector2 * Nullable<System.Numerics.Vector2> * Nullable<TimeSpan> * Nullable<TimeSpan> * Nullable<Microsoft.Toolkit.Uwp.UI.Animations.RepeatOption> * Microsoft.Toolkit.Uwp.UI.Animations.EasingType * Windows.UI.Xaml.Media.Animation.EasingMode -> Microsoft.Toolkit.Uwp.UI.Animations.AnimationBuilder

Public Function Offset (to As Vector2, Optional from As Nullable(Of Vector2) = Nothing, Optional delay As Nullable(Of TimeSpan) = Nothing, Optional duration As Nullable(Of TimeSpan) = Nothing, Optional repeat As Nullable(Of RepeatOption) = Nothing, Optional easingType As EasingType = Microsoft.Toolkit.Uwp.UI.Animations.EasingType.Default, Optional easingMode As EasingMode = Windows.UI.Xaml.Media.Animation.EasingMode.EaseInOut) As AnimationBuilder

Parameters

to

Vector2

The final point for the animation.

from

Nullable<Vector2>

The optional starting point for the animation.

delay

Nullable<TimeSpan>

The optional initial delay for the animation.

duration

Nullable<TimeSpan>

The optional animation duration.

repeat

Nullable<RepeatOption>

The optional repeat mode (defaults to once).

easingType

EasingType

The optional easing function type for the animation.

easingMode

Windows.UI.Xaml.Media.Animation.EasingMode

The optional easing function mode for the animation.

Returns

AnimationBuilder

The current AnimationBuilder instance.

Remarks

This animation is only available on the composition layer.

Offset(Vector3, Nullable<Vector3>, Nullable<TimeSpan>, Nullable<TimeSpan>, Nullable<RepeatOption>, EasingType, EasingMode)

Adds a new composition offset translation animation for all axes to the current schedule.

public Microsoft.Toolkit.Uwp.UI.Animations.AnimationBuilder Offset (System.Numerics.Vector3 to, System.Numerics.Vector3? from = default, TimeSpan? delay = default, TimeSpan? duration = default, Microsoft.Toolkit.Uwp.UI.Animations.RepeatOption? repeat = default, Microsoft.Toolkit.Uwp.UI.Animations.EasingType easingType = Microsoft.Toolkit.Uwp.UI.Animations.EasingType.Default, Windows.UI.Xaml.Media.Animation.EasingMode easingMode = Windows.UI.Xaml.Media.Animation.EasingMode.EaseInOut);

member this.Offset : System.Numerics.Vector3 * Nullable<System.Numerics.Vector3> * Nullable<TimeSpan> * Nullable<TimeSpan> * Nullable<Microsoft.Toolkit.Uwp.UI.Animations.RepeatOption> * Microsoft.Toolkit.Uwp.UI.Animations.EasingType * Windows.UI.Xaml.Media.Animation.EasingMode -> Microsoft.Toolkit.Uwp.UI.Animations.AnimationBuilder

Public Function Offset (to As Vector3, Optional from As Nullable(Of Vector3) = Nothing, Optional delay As Nullable(Of TimeSpan) = Nothing, Optional duration As Nullable(Of TimeSpan) = Nothing, Optional repeat As Nullable(Of RepeatOption) = Nothing, Optional easingType As EasingType = Microsoft.Toolkit.Uwp.UI.Animations.EasingType.Default, Optional easingMode As EasingMode = Windows.UI.Xaml.Media.Animation.EasingMode.EaseInOut) As AnimationBuilder

Parameters

to

Vector3

The final point for the animation.

from

Nullable<Vector3>

The optional starting point for the animation.

delay

Nullable<TimeSpan>

The optional initial delay for the animation.

duration

Nullable<TimeSpan>

The optional animation duration.

repeat

Nullable<RepeatOption>

The optional repeat mode (defaults to once).

easingType

EasingType

The optional easing function type for the animation.

easingMode

Windows.UI.Xaml.Media.Animation.EasingMode

The optional easing function mode for the animation.

Returns

AnimationBuilder

The current AnimationBuilder instance.

Remarks

This animation is only available on the composition layer.

Offset(Axis, Double, Nullable<Double>, Nullable<TimeSpan>, Nullable<TimeSpan>, Nullable<RepeatOption>, EasingType, EasingMode)

Adds a new composition offset animation for a single axis to the current schedule.

public Microsoft.Toolkit.Uwp.UI.Animations.AnimationBuilder Offset (Microsoft.Toolkit.Uwp.UI.Animations.Axis axis, double to, double? from = default, TimeSpan? delay = default, TimeSpan? duration = default, Microsoft.Toolkit.Uwp.UI.Animations.RepeatOption? repeat = default, Microsoft.Toolkit.Uwp.UI.Animations.EasingType easingType = Microsoft.Toolkit.Uwp.UI.Animations.EasingType.Default, Windows.UI.Xaml.Media.Animation.EasingMode easingMode = Windows.UI.Xaml.Media.Animation.EasingMode.EaseInOut);

member this.Offset : Microsoft.Toolkit.Uwp.UI.Animations.Axis * double * Nullable<double> * Nullable<TimeSpan> * Nullable<TimeSpan> * Nullable<Microsoft.Toolkit.Uwp.UI.Animations.RepeatOption> * Microsoft.Toolkit.Uwp.UI.Animations.EasingType * Windows.UI.Xaml.Media.Animation.EasingMode -> Microsoft.Toolkit.Uwp.UI.Animations.AnimationBuilder

Public Function Offset (axis As Axis, to As Double, Optional from As Nullable(Of Double) = Nothing, Optional delay As Nullable(Of TimeSpan) = Nothing, Optional duration As Nullable(Of TimeSpan) = Nothing, Optional repeat As Nullable(Of RepeatOption) = Nothing, Optional easingType As EasingType = Microsoft.Toolkit.Uwp.UI.Animations.EasingType.Default, Optional easingMode As EasingMode = Windows.UI.Xaml.Media.Animation.EasingMode.EaseInOut) As AnimationBuilder

Parameters

axis

Axis

The target translation axis to animate.

to

Double

The final value for the animation.

from

Nullable<Double>

The optional starting value for the animation.

delay

Nullable<TimeSpan>

The optional initial delay for the animation.

duration

Nullable<TimeSpan>

The optional animation duration.

repeat

Nullable<RepeatOption>

The optional repeat mode (defaults to once).

easingType

EasingType

The optional easing function type for the animation.

easingMode

Windows.UI.Xaml.Media.Animation.EasingMode

The optional easing function mode for the animation.

Returns

AnimationBuilder

The current AnimationBuilder instance.

Remarks

This animation is only available on the composition layer.