Class Path
Definition
- Namespace:
- Tizen.NUI
- Assembly:
- Tizen.NUI.dll
- API Level:
- 3
A 3D parametric curve.
Paths can be used to animate the position and orientation of actors.
C#Copypublic class Path : BaseHandle, INotifyPropertyChanged, IDynamicResourceHandler, IElement, INameScope, IElementController, IDisposable
- Inheritance
- Implements
-
System.ComponentModel.INotifyPropertyChangedSystem.IDisposable
Constructors
Declaration
C#Copypublic Path()
API Level: 3
Properties
Declaration
C#Copypublic PropertyArray ControlPoints { get; set; }
Property Value
| Type | Description |
|---|---|
| PropertyArray |
API Level: 3
Declaration
C#Copypublic PropertyArray Points { get; set; }
Property Value
| Type | Description |
|---|---|
| PropertyArray |
API Level: 3
Methods
Declaration
C#Copypublic void AddControlPoint(Vector3 point)
Parameters
| Type | Name | Description |
|---|---|---|
| Vector3 | point | The new control point to be added. |
API Level: 3
Declaration
C#Copypublic void AddPoint(Position point)
Parameters
| Type | Name | Description |
|---|---|---|
| Position | point | The new interpolation point to be added. |
API Level: 3
GenerateControlPoints(Single)
Automatic generation of control points. Generated control points which result in a smooth join between the splines of each segment.
The generating algorithm is as follows:
For a given knot point K[N], find the vector that bisects K[N-1],[N] and [N],[N+1].
Calculate the tangent vector by taking the normal of this bisector.
The in control point is the length of the preceding segment back along this bisector multiplied by the curvature.
The out control point is the length of the succeeding segment forward along this bisector multiplied by the curvature.
Declaration
C#Copypublic void GenerateControlPoints(float curvature)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Single | curvature | The curvature of the spline. 0 gives straight lines between the knots, negative values means the spline contains loops, positive values up to 0.5 result in a smooth curve, positive values between 0.5 and 1 result in looped curves where the loops are not distinct (i.e., the curve appears to be non-continuous), positive values higher than 1 result in looped curves. |
API Level: 3
Declaration
C#Copypublic Vector3 GetControlPoint(uint index)
Parameters
| Type | Name | Description |
|---|---|---|
| System.UInt32 | index | The index of the control point. |
Returns
| Type | Description |
|---|---|
| Vector3 |
API Level: 3
Declaration
C#Copypublic Vector3 GetPoint(uint index)
Parameters
| Type | Name | Description |
|---|---|---|
| System.UInt32 | index | The index of the interpolation point. |
Returns
| Type | Description |
|---|---|
| Vector3 |
API Level: 3
Declaration
C#Copypublic uint GetPointCount()
Returns
| Type | Description |
|---|---|
| System.UInt32 | The number of interpolation points in the path. |
API Level: 3
Sample(Single, Vector3, Vector3)
Sample path at a given progress. Calculates the position and tangent at that point of the curve.
Declaration
C#Copypublic void Sample(float progress, Vector3 position, Vector3 tangent)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Single | progress | A floating point value between 0.0 and 1.0. |
| Vector3 | position | The interpolated position at that progress. |
| Vector3 | tangent | The interpolated tangent at that progress. |