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.


                C#
                
                    Copy
                    
                
            
public class Transit : IDisposable

Inheritance: object

Transit

Implements: System.IDisposable

Remarks

Transit is not reusable. If the effect ends, the transit is destroyed automatically.

Constructors

View Source

Transit()

Creates and initializes a new instance of the Transit class.

Declaration


                C#
                
                    Copy
                    
                
            
public Transit()

Remarks

Transit is not reusable. If the effect ends, the transit is destroyed automatically.

Properties

View Source

AutoReverse

Gets or sets if auto reverse is on.

Declaration


                C#
                
                    Copy
                    
                
            
public bool AutoReverse { get; set; }

Property Value

Type	Description
bool

Remarks

Transit is not reusable. If the effect ends, the transit is destroyed automatically.

View Source

BeginAccelerationFactor

Gets or sets the transit animation tween mode acceleration factor.

Declaration


                C#
                
                    Copy
                    
                
            
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.

View Source

Chains

Gets the current chained transit list.

Declaration


                C#
                
                    Copy
                    
                
            
public IList<Transit> Chains { get; }

Property Value

Type	Description
System.Collections.Generic.IList<T><Transit>

Remarks

Cannot add the duplicate transit.

View Source

Duration

Gets or sets the transit animation time.

Declaration


                C#
                
                    Copy
                    
                
            
public double Duration { get; set; }

Property Value

Type	Description
double

Remarks

Transit is not reusable. If the effect ends, the transit is destroyed automatically.

View Source

EndAccelerationFactor

Gets or sets the transit animation tween mode acceleration factor.

Declaration


                C#
                
                    Copy
                    
                
            
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.

View Source

EventEnabled

Gets or sets the event enabled when transit is operating.

Declaration


                C#
                
                    Copy
                    
                
            
public bool EventEnabled { get; set; }

Property Value

Type	Description
bool

Remarks

Transit is not reusable. If the effect ends, the transit is destroyed automatically.

View Source

Objects

Gets the objects list of the transit.

Declaration


                C#
                
                    Copy
                    
                
            
public IList<EvasObject> Objects { get; }

Property Value

Type	Description
System.Collections.Generic.IList<T><EvasObject>

Remarks

Cannot add the duplicate object.

View Source

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#
                
                    Copy
                    
                
            
public bool ObjectStateKeep { get; set; }

Property Value

Type	Description
bool

Remarks

Transit is not reusable. If the effect ends, the transit is destroyed automatically.

View Source

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#
                
                    Copy
                    
                
            
public double Progress { get; }

Property Value

Type	Description
double

Remarks

Transit is not reusable. If the effect ends, the transit is destroyed automatically.

View Source

Repeat

Gets or sets the transit repeat count. If the repeat is a negative number, it will repeat infinite times.

Declaration


                C#
                
                    Copy
                    
                
            
public int Repeat { get; set; }

Property Value

Type	Description
int

Remarks

Transit is not reusable. If the effect ends, the transit is destroyed automatically.

View Source

Smooth

Gets or sets the smooth scaling for transit map rendering. This gets the smooth scaling for transit map rendering.

Declaration


                C#
                
                    Copy
                    
                
            
public bool Smooth { get; set; }

Property Value

Type	Description
bool

Remarks

Transit is not reusable. If the effect ends, the transit is destroyed automatically.

View Source

TweenMode

Gets or sets the transit animation acceleration type.

Declaration


                C#
                
                    Copy
                    
                
            
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 Source

AddEffect(EffectBase)

Adds the effect.

Declaration


                C#
                
                    Copy
                    
                
            
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.

View Source

Dispose()

Destroys the current object.

Declaration


                C#
                
                    Copy
                    
                
            
public void Dispose()

Remarks

Transit is not reusable. If the effect ends, the transit is destroyed automatically.

View Source

Dispose(bool)

Releases all the resources currently used by this instance.

Declaration


                C#
                
                    Copy
                    
                
            
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.

View Source

~Transit()

Destroys the transit object.

Declaration


                C#
                
                    Copy
                    
                
            
protected ~Transit()

Remarks

Transit is not reusable. If the effect ends, the transit is destroyed automatically.

View Source

Go(double)

Starts the transition in given seconds. Once this API is called, the transit begins to measure the time.

Declaration


                C#
                
                    Copy
                    
                
            
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.

View Source

Pause()

Pauses the transition.

Declaration


                C#
                
                    Copy
                    
                
            
public void Pause()

Remarks

Transit is not reusable. If the effect ends, the transit is destroyed automatically.

View Source

Resume()

Resumes the transition.

Declaration


                C#
                
                    Copy
                    
                
            
public void Resume()

Remarks

Transit is not reusable. If the effect ends, the transit is destroyed automatically.

Events

View Source

Deleted

A callback is called when the transit is deleted.

Declaration


                C#
                
                    Copy
                    
                
            
public event EventHandler Deleted

Event Type

Type	Description
System.EventHandler

Remarks

Transit is not reusable. If the effect ends, the transit is destroyed automatically.

Implements

System.IDisposable