Class Transit
Definition
- Namespace:
- ElmSharp
- Assembly:
- ElmSharp.dll
- API Level:
- preview
Transit is designed to apply various animated transition effects, such as translation, rotation, etc. For using these effects, create a transit and add the desired transition effects.
C#Copypublic class Transit : IDisposable
- Inheritance
-
System.ObjectTransit
- Implements
-
System.IDisposable
Remarks
Transit is not reusable. If the effect ends, the transit is destroyed automatically.
Constructors
Declaration
C#Copypublic Transit()
API Level: preview
Properties
Declaration
C#Copypublic bool AutoReverse { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
API Level: preview
BeginAccelerationFactor
Gets or sets the transit animation tween mode acceleration factor.
Declaration
C#Copypublic double BeginAccelerationFactor { get; set; }
Property Value
Type | Description |
---|---|
System.Double | A factor value from 0.0 to 1.0. |
API Level: preview
Declaration
C#Copypublic IList<Transit> Chains { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IList<Transit> |
Remarks
Cannot add the duplicate transit.
API Level: preview
Declaration
C#Copypublic double Duration { get; set; }
Property Value
Type | Description |
---|---|
System.Double |
API Level: preview
EndAccelerationFactor
Gets or sets the transit animation tween mode acceleration factor.
Declaration
C#Copypublic double EndAccelerationFactor { get; set; }
Property Value
Type | Description |
---|---|
System.Double | A factor value from 0.0 to 1.0. |
API Level: preview
Declaration
C#Copypublic bool EventEnabled { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
API Level: preview
Declaration
C#Copypublic IList<EvasObject> Objects { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IList<EvasObject> |
Remarks
Cannot add the duplicate object.
API Level: preview
ObjectStateKeep
Gets or sets a value whether the objects states will be kept or not. If it is not kept, the objects states will be reset when the transition ends.
Declaration
C#Copypublic bool ObjectStateKeep { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
API Level: preview
Progress
Gets the time progression of the animation (a double value between 0.0 and 1.0). The value returned is a fraction (current time/total time). It represents the progression position relative to the total.
Declaration
C#Copypublic double Progress { get; }
Property Value
Type | Description |
---|---|
System.Double |
API Level: preview
Repeat
Gets or sets the transit repeat count. If the repeat is a negative number, it will repeat infinite times.
Declaration
C#Copypublic int Repeat { get; set; }
Property Value
Type | Description |
---|---|
Int32 |
API Level: preview
Smooth
Gets or sets the smooth scaling for transit map rendering. This gets the smooth scaling for transit map rendering.
Declaration
C#Copypublic bool Smooth { get; set; }
Property Value
Type | Description |
---|---|
Boolean |
API Level: preview
Declaration
C#Copypublic TweenMode TweenMode { get; set; }
Property Value
Type | Description |
---|---|
TweenMode |
API Level: preview
Methods
Declaration
C#Copypublic void AddEffect(EffectBase effect)
Parameters
Type | Name | Description |
---|---|---|
EffectBase | effect | EffectBase object. |
API Level: preview
Declaration
C#Copypublic void Dispose()
API Level: preview
Declaration
C#Copyprotected virtual void Dispose(bool disposing)
Parameters
Type | Name | Description |
---|---|---|
Boolean | disposing | true if the managed resources should be disposed, otherwise false. |
API Level: preview
Declaration
C#Copyprotected void Finalize()
Go(Double)
Starts the transition in given seconds. Once this API is called, the transit begins to measure the time.
Declaration
C#Copypublic void Go(double interval = 0)
Parameters
Type | Name | Description |
---|---|---|
System.Double | interval | The interval value in seconds. |
API Level: preview
Declaration
C#Copypublic void Pause()
API Level: preview
Declaration
C#Copypublic void Resume()
API Level: preview
Events
Declaration
C#Copypublic event EventHandler Deleted
Event Type
Type | Description |
---|---|
System.EventHandler |