Class Transit
Definition
- Namespace:
- ElmSharp
- Assembly:
- ElmSharp.dll
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.
public class Transit : IDisposable
- Inheritance
-
objectTransit
- Implements
-
System.IDisposable
Remarks
Transit is not reusable. If the effect ends, the transit is destroyed automatically.
Constructors
View SourceTransit()
Creates and initializes a new instance of the Transit class.
Declaration
public Transit()
Remarks
Transit is not reusable. If the effect ends, the transit is destroyed automatically.
Properties
View SourceAutoReverse
Gets or sets if auto reverse is on.
Declaration
public bool AutoReverse { get; set; }
Property Value
Type | Description |
---|---|
bool |
Remarks
Transit is not reusable. If the effect ends, the transit is destroyed automatically.
BeginAccelerationFactor
Gets or sets the transit animation tween mode acceleration factor.
Declaration
public double BeginAccelerationFactor { get; set; }
Property Value
Type | Description |
---|---|
double | A factor value from 0.0 to 1.0. |
Remarks
Transit is not reusable. If the effect ends, the transit is destroyed automatically.
Chains
Gets the current chained transit list.
Declaration
public IList<Transit> Chains { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IList<T><Transit> |
Remarks
Cannot add the duplicate transit.
Duration
Gets or sets the transit animation time.
Declaration
public double Duration { get; set; }
Property Value
Type | Description |
---|---|
double |
Remarks
Transit is not reusable. If the effect ends, the transit is destroyed automatically.
EndAccelerationFactor
Gets or sets the transit animation tween mode acceleration factor.
Declaration
public double EndAccelerationFactor { get; set; }
Property Value
Type | Description |
---|---|
double | A factor value from 0.0 to 1.0. |
Remarks
Transit is not reusable. If the effect ends, the transit is destroyed automatically.
EventEnabled
Gets or sets the event enabled when transit is operating.
Declaration
public bool EventEnabled { get; set; }
Property Value
Type | Description |
---|---|
bool |
Remarks
Transit is not reusable. If the effect ends, the transit is destroyed automatically.
Objects
Gets the objects list of the transit.
Declaration
public IList<EvasObject> Objects { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IList<T><EvasObject> |
Remarks
Cannot add the duplicate object.
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
public bool ObjectStateKeep { get; set; }
Property Value
Type | Description |
---|---|
bool |
Remarks
Transit is not reusable. If the effect ends, the transit is destroyed automatically.
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
public double Progress { get; }
Property Value
Type | Description |
---|---|
double |
Remarks
Transit is not reusable. If the effect ends, the transit is destroyed automatically.
Repeat
Gets or sets the transit repeat count. If the repeat is a negative number, it will repeat infinite times.
Declaration
public int Repeat { get; set; }
Property Value
Type | Description |
---|---|
int |
Remarks
Transit is not reusable. If the effect ends, the transit is destroyed automatically.
Smooth
Gets or sets the smooth scaling for transit map rendering. This gets the smooth scaling for transit map rendering.
Declaration
public bool Smooth { get; set; }
Property Value
Type | Description |
---|---|
bool |
Remarks
Transit is not reusable. If the effect ends, the transit is destroyed automatically.
TweenMode
Gets or sets the transit animation acceleration type.
Declaration
public TweenMode TweenMode { get; set; }
Property Value
Type | Description |
---|---|
TweenMode |
Remarks
Transit is not reusable. If the effect ends, the transit is destroyed automatically.
Methods
View SourceAddEffect(EffectBase)
Adds the effect.
Declaration
public void AddEffect(EffectBase effect)
Parameters
Type | Name | Description |
---|---|---|
EffectBase | effect | EffectBase object. |
Remarks
Transit is not reusable. If the effect ends, the transit is destroyed automatically.
Dispose()
Destroys the current object.
Declaration
public void Dispose()
Remarks
Transit is not reusable. If the effect ends, the transit is destroyed automatically.
Dispose(bool)
Releases all the resources currently used by this instance.
Declaration
protected virtual void Dispose(bool disposing)
Parameters
Type | Name | Description |
---|---|---|
bool | disposing | true if the managed resources should be disposed, otherwise false. |
Remarks
Transit is not reusable. If the effect ends, the transit is destroyed automatically.
~Transit()
Destroys the transit object.
Declaration
protected ~Transit()
Remarks
Transit is not reusable. If the effect ends, the transit is destroyed automatically.
Go(double)
Starts the transition in given seconds. Once this API is called, the transit begins to measure the time.
Declaration
public void Go(double interval = 0)
Parameters
Type | Name | Description |
---|---|---|
double | interval | The interval value in seconds. |
Remarks
Transit is not reusable. If the effect ends, the transit is destroyed automatically.
Pause()
Pauses the transition.
Declaration
public void Pause()
Remarks
Transit is not reusable. If the effect ends, the transit is destroyed automatically.
Resume()
Resumes the transition.
Declaration
public void Resume()
Remarks
Transit is not reusable. If the effect ends, the transit is destroyed automatically.
Events
View SourceDeleted
A callback is called when the transit is deleted.
Declaration
public event EventHandler Deleted
Event Type
Type | Description |
---|---|
System.EventHandler |
Remarks
Transit is not reusable. If the effect ends, the transit is destroyed automatically.