Class Path

View Source

Definition

Namespace:
Tizen.NUI
Assembly:
Tizen.NUI.dll

A 3D parametric curve.
Paths can be used to animate the position and orientation of actors.


                
C#

                

                    
Copy

                    

                

            
public class Path : BaseHandle, INotifyPropertyChanged, IDisposable
Inheritance
object
Tizen.NUI.Binding.BindableObject
Tizen.NUI.Binding.Element
BaseHandle
Path
Implements
System.ComponentModel.INotifyPropertyChanged
System.IDisposable

Constructors

View Source

Path()

Creates an initialized path handle.

Declaration

                
C#

                

                    
Copy

                    

                

            
public Path()

Properties

View Source

ControlPoints

Enumeration for the ControlPoints.

Declaration

                
C#

                

                    
Copy

                    

                

            
public PropertyArray ControlPoints { get; set; }
Property Value
Type Description
PropertyArray
View Source

Points

Enumeration for the Points.

Declaration

                
C#

                

                    
Copy

                    

                

            
public PropertyArray Points { get; set; }
Property Value
Type Description
PropertyArray

Methods

View Source

AddControlPoint(Vector3)

Adds a control point.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void AddControlPoint(Vector3 point)
Parameters
Type Name Description
Vector3 point

The new control point to be added.
View Source

AddPoint(Position)

Adds an interpolation point.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void AddPoint(Position point)
Parameters
Type Name Description
Position point

The new interpolation point to be added.
View Source

Dispose(DisposeTypes)

Dispose

Declaration

                
C#

                

                    
Copy

                    

                

            
protected override void Dispose(DisposeTypes type)
Parameters
Type Name Description
DisposeTypes type

The dispoase type
Overrides
View Source

GenerateControlPoints(float)

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#

                

                    
Copy

                    

                

            
public void GenerateControlPoints(float curvature)
Parameters
Type Name Description
float 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.
View Source

GetControlPoint(uint)

An accessor for the control points.

Declaration

                
C#

                

                    
Copy

                    

                

            
public Vector3 GetControlPoint(uint index)
Parameters
Type Name Description
uint index

The index of the control point.
Returns
Type Description
Vector3
View Source

GetPoint(uint)

An accessor for the interpolation points.

Declaration

                
C#

                

                    
Copy

                    

                

            
public Vector3 GetPoint(uint index)
Parameters
Type Name Description
uint index

The index of the interpolation point.
Returns
Type Description
Vector3
View Source

GetPointCount()

Gets the number of interpolation points in the path.

Declaration

                
C#

                

                    
Copy

                    

                

            
public uint GetPointCount()
Returns
Type Description
uint

The number of interpolation points in the path.
View Source

Sample(float, Vector3, Vector3)

Sample path at a given progress. Calculates the position and tangent at that point of the curve.

Declaration

                
C#

                

                    
Copy

                    

                

            
public void Sample(float progress, Vector3 position, Vector3 tangent)
Parameters
Type Name Description
float 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.

Implements

System.ComponentModel.INotifyPropertyChanged
System.IDisposable