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

object

Transit

Implements

IDisposable

Remarks

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

Constructors

Transit()

Creates and initializes a new instance of the Transit class.

Declaration

public Transit()

Properties

AutoReverse

Gets or sets if auto reverse is on.

Declaration

public bool AutoReverse { get; set; }

Property Value

Type	Description
bool

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.

Chains

Gets the current chained transit list.

Declaration

public IList<Transit> Chains { get; }

Property Value

Type	Description
IList<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

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.

EventEnabled

Gets or sets the event enabled when transit is operating.

Declaration

public bool EventEnabled { get; set; }

Property Value

Type	Description
bool

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

Objects

Gets the objects list of the transit.

Declaration

public IList<EvasObject> Objects { get; }

Property Value

Type	Description
IList<EvasObject>

Remarks

Cannot add the duplicate object.

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

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

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

TweenMode

Gets or sets the transit animation acceleration type.

Declaration

public TweenMode TweenMode { get; set; }

Property Value

Type	Description
TweenMode

Methods

AddEffect(EffectBase)

Adds the effect.

Declaration

public void AddEffect(EffectBase effect)

Parameters

Type	Name	Description
EffectBase	effect	EffectBase object.

Dispose()

Destroys the current object.

Declaration

public void Dispose()

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.

~Transit()

Destroys the transit object.

Declaration

protected ~Transit()

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.

Pause()

Pauses the transition.

Declaration

public void Pause()

Resume()

Resumes the transition.

Declaration

public void Resume()

Events

Deleted

A callback is called when the transit is deleted.

Declaration

public event EventHandler Deleted

Event Type

Type	Description
EventHandler

Implements

IDisposable