Class
TransitionEffect

Abstract class that represents a transition effect.

Definition

Namespace:Telerik.Windows.Controls.TransitionControl

Assembly:Telerik.Windows.Controls.dll

Syntax:

cs-api-definition
public abstract class TransitionEffect : ShaderEffect

Inheritance: objectTransitionEffect

Derived Classes: BaseTransitionEffect

Constructors

TransitionEffect()

Initializes a new instance of the TransitionEffect class.

Declaration

cs-api-definition
[SuppressMessage("Microsoft.Usage", "CA2214:DoNotCallOverridableMethodsInConstructors")]
protected TransitionEffect()

Fields

CurrentSamplerProperty

Identifies the CurrentSampler property. Brush-valued properties turn into sampler-property in the shader. Represents the image present in the final state of the transition.

Declaration

cs-api-definition
public static readonly DependencyProperty CurrentSamplerProperty

Field Value

DependencyProperty

OldSamplerProperty

Identifies the OldSampler property. Brush-valued properties turn into sampler-property in the shader. Represents the image present in the initial state of the transition.

Declaration

cs-api-definition
public static readonly DependencyProperty OldSamplerProperty

Field Value

DependencyProperty

ProgressProperty

Identifies the Progress property. When its value is 0.0 the effect shows the initial state of the transition, when 1.0 - the final state.

Declaration

cs-api-definition
public static readonly DependencyProperty ProgressProperty

Field Value

DependencyProperty

Properties

CurrentSampler

Gets or sets the CurrentSampler variable within the shader. Represents the image present in the final state of the transition.

Declaration

cs-api-definition
[Browsable(false)]
public Brush CurrentSampler { get; set; }

Property Value

Brush

OldSampler

Gets or sets the OldSampler variable within the shader. Represents the image present in the initial state of the transition.

Declaration

cs-api-definition
[Browsable(false)]
public Brush OldSampler { get; set; }

Property Value

Brush

Progress

Gets or sets the Progress variable within the shader. When its value is 0.0 the effect shows the initial state of the transition, when 1.0 - the final state.

Declaration

cs-api-definition
public double Progress { get; set; }

Property Value

double

Methods

LoadShader()

When overridden this method should load the shader and return it.

Declaration

cs-api-definition
protected abstract PixelShader LoadShader()

Returns

PixelShader

The newly loaded shader.

OnProgressChanged(double, double)

This method is called when the progress of the transition is changed. When overridden it should take care of moving the transition.

Declaration

cs-api-definition
protected virtual void OnProgressChanged(double oldProgress, double newProgress)

Parameters

oldProgress

double

The old progress of the transition.

newProgress

double

The new progress of the transition.

PackUri<T>(string)

Creates an Uri for resource by its full path and using the assembly name of the class specified by the type parameter T.

Declaration

cs-api-definition
[SuppressMessage("Microsoft.Design", "CA1004:GenericMethodsShouldProvideTypeParameter")]
protected static Uri PackUri<T>(string relativeFile)

Parameters

relativeFile

string

The relative path to the resource file.

Returns

Uri

An Uri that points the resource.