Class AlphaFunction

Definition

Namespace:
Tizen.NUI
Assembly:
Tizen.NUI.dll
API Level:
3

Alpha functions are used in animations to specify the rate of change of the animation parameter over time.
Understanding an animation as a parametric function over time, the alpha function is applied to the parameter of the animation before computing the final animation value.

C#
Copy
public class AlphaFunction : Disposable, IDisposable
Inheritance
System.Object
AlphaFunction
Implements
System.IDisposable

Constructors

View Source

AlphaFunction()

The default constructor.
Creates an alpha function object with the default built-in alpha function.

Declaration
C#
Copy
public AlphaFunction()
API Level: 3
View Source

AlphaFunction(Delegate)

The constructor.
Creates an alpha function object with the user-defined alpha function.

Declaration
C#
Copy
public AlphaFunction(Delegate func)
Parameters
Type Name Description
System.Delegate func

User defined function. It must be a method formatted as float alphafunction(float progress)

API Level: 3
View Source

AlphaFunction(AlphaFunction.BuiltinFunctions)

The constructor.
Creates an alpha function object with the built-in alpha function passed as a parameter to the constructor.

Declaration
C#
Copy
public AlphaFunction(AlphaFunction.BuiltinFunctions function)
Parameters
Type Name Description
AlphaFunction.BuiltinFunctions function

One of the built-in alpha functions.

API Level: 3
View Source

AlphaFunction(Vector2, Vector2)

The constructor.
Creates a bezier alpha function. The bezier will have the first point at (0,0) and the end point at (1,1).

Declaration
C#
Copy
public AlphaFunction(Vector2 controlPoint0, Vector2 controlPoint1)
Parameters
Type Name Description
Vector2 controlPoint0

A Vector2 which will be used as the first control point of the curve.

Vector2 controlPoint1

A Vector2 which will be used as the second control point of the curve.

Remarks

The x components of the control points will be clamped to the range [0, 1] to prevent non-monotonic curves.

API Level: 3

Methods

View Source

GetBezierControlPoints(out Vector2, out Vector2)

Retrieves the control points of the alpha function.

Declaration
C#
Copy
public void GetBezierControlPoints(out Vector2 controlPoint0, out Vector2 controlPoint1)
Parameters
Type Name Description
Vector2 controlPoint0

A Vector2 which will be used as the first control point of the curve.

Vector2 controlPoint1

A Vector2 which will be used as the second control point of the curve.

API Level: 3
View Source

GetBuiltinFunction()

Returns the built-in function used by the alpha function.
In case no built-in function has been specified, it will return AlphaFunction::DEFAULT.

Declaration
C#
Copy
public AlphaFunction.BuiltinFunctions GetBuiltinFunction()
Returns
Type Description
AlphaFunction.BuiltinFunctions

One of the built-in alpha functions.

API Level: 3
View Source

GetMode()

Returns the functioning mode of the alpha function.

Declaration
C#
Copy
public AlphaFunction.Modes GetMode()
Returns
Type Description
AlphaFunction.Modes

The functioning mode of the alpha function.

API Level: 3

Implements

System.IDisposable