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#
                
                    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()

API Level: preview

Properties

View Source

AutoReverse

Gets or sets if auto reverse is on.

Declaration


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

Property Value

Type	Description
Boolean

API Level: preview

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
System.Double	A factor value from 0.0 to 1.0.

API Level: preview

View Source

Chains

Gets the current chained transit list.

Declaration


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

Property Value

Type	Description
IList<Transit>

Remarks

Cannot add the duplicate transit.

API Level: preview

View Source

Duration

Gets or sets the transit animation time.

Declaration


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

Property Value

Type	Description
System.Double

API Level: preview

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
System.Double	A factor value from 0.0 to 1.0.

API Level: preview

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
Boolean

API Level: preview

View Source

Objects

Gets the objects list of the transit.

Declaration


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

Property Value

Type	Description
IList<EvasObject>

Remarks

Cannot add the duplicate object.

API Level: preview

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
Boolean

API Level: preview

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
System.Double

API Level: preview

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
System.Int32

API Level: preview

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
Boolean

API Level: preview

View Source

TweenMode

Gets or sets the transit animation acceleration type.

Declaration


                C#
                
                    Copy
                    
                
            
public TweenMode TweenMode { get; set; }

Property Value

Type	Description
TweenMode

API Level: preview

Methods

View Source

AddEffect(EffectBase)

Adds the effect.

Declaration


                C#
                
                    Copy
                    
                
            
public void AddEffect(EffectBase effect)

Parameters

Type	Name	Description
EffectBase	effect	EffectBase object.

API Level: preview

View Source

Dispose()

Destroys the current object.

Declaration


                C#
                
                    Copy
                    
                
            
public void Dispose()

API Level: preview

View Source

Dispose(Boolean)

Releases all the resources currently used by this instance.

Declaration


                C#
                
                    Copy
                    
                
            
protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
Boolean	disposing	true if the managed resources should be disposed, otherwise false.

API Level: preview

View Source

Finalize()

Destroys the transit object.

Declaration


                C#
                
                    Copy
                    
                
            
protected void Finalize()

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
System.Double	interval	The interval value in seconds.

API Level: preview

View Source

Pause()

Pauses the transition.

Declaration


                C#
                
                    Copy
                    
                
            
public void Pause()

API Level: preview

View Source

Resume()

Resumes the transition.

Declaration


                C#
                
                    Copy
                    
                
            
public void Resume()

API Level: preview

Events

View Source

Deleted

A callback is called when the transit is deleted.

Declaration


                C#
                
                    Copy
                    
                
            
public event EventHandler Deleted

Event Type

Type	Description
EventHandler

API Level: preview

Implements

System.IDisposable