Interface IViewControllerTransitionDrivable<TContext>
A transition drivable is used to drive a transition's progress, such as when implementing an interactive transition.
Namespace: Pelican7.UIGraph
Assembly: UI Graph API Documentation Project.dll
Syntax
public interface IViewControllerTransitionDrivable<TContext>Type Parameters
| Name | Description |
|---|---|
| TContext |
Properties
CompletionCurve
The transition's completion curve. Upon calling CompleteTransition() or CancelTransition(), UI Graph will complete the remainder of the transition using the remaining duration and the completion curve.
Declaration
AnimationCurve CompletionCurve { set; }Property Value
| Type | Description |
|---|---|
| UnityEngine.AnimationCurve |
Context
The transition's context.
Declaration
TContext Context { get; }Property Value
| Type | Description |
|---|---|
| TContext |
Direction
The transition's direction.
Declaration
ViewControllerTransitionAnimationDriverDirection Direction { get; set; }Property Value
| Type | Description |
|---|---|
| ViewControllerTransitionAnimationDriverDirection |
Duration
The transition's duration.
Declaration
float Duration { get; }Property Value
| Type | Description |
|---|---|
| System.Single |
Progress01
The transition's current progress, from zero to one. Drive the transition's progress with this value.
Declaration
float Progress01 { get; set; }Property Value
| Type | Description |
|---|---|
| System.Single |
TimeUpdateMode
The transition's time update mode.
Declaration
ViewControllerTransitionTimeUpdateMode TimeUpdateMode { get; }Property Value
| Type | Description |
|---|---|
| ViewControllerTransitionTimeUpdateMode |
Methods
CancelTransition()
Cancel the transition. Invoke this method when you want to cancel the transition. UI Graph will complete the remainder of the transition to zero progress using the remaining duration and the completion curve.
Declaration
void CancelTransition()CompleteTransition()
Complete the transition. Invoke this method when you want to complete the transition. UI Graph will complete the remainder of the transition using the remaining duration and the completion curve.
Declaration
void CompleteTransition()