Unity Splines

https://docs.unity3d.com/Packages/com.unity.splines@2.8/
Admin
Unity Splines is a package that provides tools and a framework for working with curves and paths in...
Tokens:94,007
Snippets:1,319
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### SplineRange Constructor (start, count)

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineRange.html

Constructor for creating a SplineRange with a start index and count.

```csharp
public SplineRange(int start, int count)
```

--------------------------------

### Setup Method Declaration

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.IExtrudeShape.html

Initializes the extrusion process with the target spline and segment count.

```csharp
void Setup(ISpline path, int segmentCount)
```

--------------------------------

### SplineRange Constructor (start, count, direction)

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineRange.html

Constructor for creating a SplineRange with a start index, count, and explicit slice direction.

```csharp
public SplineRange(int start, int count, SliceDirection direction)
```

--------------------------------

### SplineRange Start Property

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineRange.html

Property to get or set the inclusive first index of the range.

```csharp
public int Start { get; set; }
```

--------------------------------

### Setup(ISpline, int)

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.ExtrusionShapes.Circle.html

Initializes the extrusion process with spline path information and segment counts.

```APIDOC
## Method Setup

### Description
Invoked by SplineMesh once prior to extruding the mesh to access information about the ISpline path and the number of segments.

### Signature
`public void Setup(ISpline path, int segmentCount)`

### Parameters
- **path** (ISpline) - The ISpline that this template is being extruded along.
- **segmentCount** (int) - The total number of segments to be created on the extruded mesh.
```

--------------------------------

### Runtime Spline Extrusion Example

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/manual/extrude-runtime.html

This script demonstrates creating a spline, adding knots, and configuring the SplineExtrude component to generate a mesh on a new GameObject.

```csharp
using UnityEngine;
using UnityEngine.Splines;
using Unity.Mathematics;

public class ExtrudeExample : MonoBehaviour
{
    void Start()
    {
        var splineContainer = new GameObject("Spline").AddComponent<SplineContainer>();
        splineContainer.Spline = new Spline();
        splineContainer.Spline.AddRange(new float3[]
        {
            new (0, 0, 0),
            new (0, 0, 1),
            new (1, 0, 1),
            new (1, 0, 0)
        });

        var go = splineContainer.gameObject;
        var extrudeComponent = go.AddComponent<SplineExtrude>();
        extrudeComponent.Container = splineContainer;

        var hasMeshFilter = go.TryGetComponent<MeshFilter>(out var meshFilter);
        if (hasMeshFilter)
        {
            if (meshFilter.sharedMesh == null)
            {
                var extrudeMesh = new Mesh();
                extrudeMesh.name = "Spline Extrude Mesh";
                meshFilter.sharedMesh = extrudeMesh;
            }

            extrudeComponent.Radius = 0.25f;
            extrudeComponent.SegmentsPerUnit = 20;
            extrudeComponent.Sides = 8;
            extrudeComponent.Range = new float2(0, 100);

            var hasMeshRenderer = go.TryGetComponent<MeshRenderer>(out var meshRenderer);
            if (hasMeshRenderer)
                meshRenderer.material = new Material(Shader.Find("Standard"));
        }
    }
}
```

--------------------------------

### GetHashCode()

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEditor.Splines.SelectableTangent.html

Gets a hash code for this tangent.

```APIDOC
## public override int GetHashCode()

### Description
Gets a hash code for this tangent.

### Returns
- **int** - A hash code for the SelectableTangent.
```

--------------------------------

### FromTangent

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.BezierCurve.html

Creates a new BezierCurve instance based on start and end points and their respective tangent vectors.

```APIDOC
## public static BezierCurve FromTangent(float3 pointA, float3 tangentOutA, float3 pointB, float3 tangentInB)

### Description
Creates a BezierCurve from a start and end point plus tangent directions.

### Parameters
- **pointA** (float3) - Starting position of the curve.
- **tangentOutA** (float3) - The direction and magnitude to the second control point.
- **pointB** (float3) - Ending position of the curve.
- **tangentInB** (float3) - The direction and magnitude to the third control point.

### Returns
- **BezierCurve** - A new BezierCurve from the derived control points.
```

--------------------------------

### Warmup Method

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineContainer.html

Ensures all caches contain valid data to prevent performance spikes during evaluation.

```csharp
public void Warmup()
```

--------------------------------

### Warmup()

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineContainer.html

Ensures that all caches contain valid data to avoid performance costs during evaluation.

```APIDOC
## Warmup()

### Description
Ensure that all caches contain valid data. Call this to avoid unexpected performance costs when evaluating splines data. Caches remain valid until any part of the splines state is modified.
```

--------------------------------

### Count

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.KnotLinkCollection.html

Gets the number of KnotLinks currently in the collection.

```APIDOC
## public int Count { get; }

### Description
Returns the total number of KnotLinks contained within the collection.
```

--------------------------------

### Interpolate(float2, float2, float)

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.Interpolators.SmoothStepFloat2.html

Interpolates between two float2 values (a and b) by a ratio (t) with smoothing at the start and end of the transition.

```APIDOC
## Interpolate(float2, float2, float)

### Description
Interpolates between a and b by ratio t with smoothing at the limits. This function interpolates between min and max in a similar way to Lerp, but the interpolation gradually speeds up from the start and slows down toward the end.

### Syntax
`public float2 Interpolate(float2 a, float2 b, float t)`

### Parameters
- **a** (float2) - Start value, returned when t = 0.
- **b** (float2) - End value, returned when t = 1.
- **t** (float) - Interpolation ratio.

### Returns
- **float2** - The interpolated result between the two values.
```

--------------------------------

### ExtrudeSettings Constructors

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.ExtrudeSettings-1.html

Constructors for initializing extrusion settings with specific parameters or a default configuration.

```csharp
public ExtrudeSettings(int segments, bool capped, float2 range, float radius, T shape)
```

```csharp
public ExtrudeSettings(T shape)
```

--------------------------------

### GetCurve

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.NativeSpline.html

Retrieves a BezierCurve starting from the specified knot index.

```csharp
public BezierCurve GetCurve(int index)
```

--------------------------------

### Interpolate(float4, float4, float)

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.Interpolators.SmoothStepFloat4.html

Interpolates between two float4 values (a and b) by a ratio t, applying a smoothstep function that accelerates at the start and decelerates at the end.

```APIDOC
## Method: Interpolate(float4 a, float4 b, float t)

### Description
Interpolates between a and b by ratio t with smoothing at the limits. This function interpolates between min and max in a similar way to Lerp, but the interpolation gradually speeds up from the start and slows down toward the end.

### Parameters
- **a** (float4) - Start value, returned when t = 0.
- **b** (float4) - End value, returned when t = 1.
- **t** (float) - Interpolation ratio.

### Returns
- **float4** - The interpolated result between the two values.
```

--------------------------------

### Previous<T>(T, int)

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineUtility.html

Gets the BezierKnot before the knot at the specified index.

```APIDOC
## Previous<T>(T, int)

### Description
Gets the BezierKnot before spline[index]. This method uses the Count and Closed properties to ensure that it returns the correct knot.

### Parameters
- **spline** (T) - The spline to consider.
- **index** (int) - The current index to consider.

### Returns
- **BezierKnot** - The knot before the knot at spline[index].
```

--------------------------------

### OnToolGUI(EditorWindow)

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEditor.Splines.SplineToolContext.html

Invoked for each window where this context is active to implement common functionality like gizmo drawing and selection.

```APIDOC
## public override void OnToolGUI(EditorWindow window)

### Description
Invoked for each window where this context is active. The spline context uses this method to implement common functionality for working with splines, such as gizmo drawing and selection.

### Parameters
- **window** (EditorWindow) - Required - The window that is displaying this active context.
```

--------------------------------

### Next<T>(T, int)

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineUtility.html

Gets the BezierKnot after the knot at the specified index.

```APIDOC
## Next<T>(T, int)

### Description
Gets the BezierKnot after spline[index]. This method uses the Count and Closed properties to ensure that it returns the correct knot.

### Parameters
- **spline** (T) - The spline to consider.
- **index** (int) - The current index to consider.

### Returns
- **BezierKnot** - The knot after the knot at spline[index].
```

--------------------------------

### OnToolGUI(EditorWindow)

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEditor.Splines.SplineRotateTool.html

Use this method to implement a custom editor tool within the Unity Editor.

```APIDOC
## public override void OnToolGUI(EditorWindow window)

### Description
Use this method to implement a custom editor tool.

### Parameters
- **window** (EditorWindow) - The window that is displaying the custom editor tool.

### Overrides
EditorTool.OnToolGUI(EditorWindow)
```

--------------------------------

### GetTangentMode(int)

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.Spline.html

Gets the TangentMode for a specific knot index.

```APIDOC
## public TangentMode GetTangentMode(int index)

### Description
Retrieves the TangentMode associated with the knot at the specified index.

### Parameters
- **index** (int) - The index of the knot.

### Returns
- **TangentMode** - The TangentMode for the knot.
```

--------------------------------

### NativeSpline Constructor (Standard)

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.NativeSpline.html

Constructs a NativeSpline using a standard set of knots, closure, transformation, and memory allocator.

```csharp
public NativeSpline(IReadOnlyList<BezierKnot> knots, bool closed, float4x4 transform, Allocator allocator = Allocator.Temp)
```

--------------------------------

### Current

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineRange.SplineRangeEnumerator.html

Gets the element in the collection at the current position of the enumerator.

```APIDOC
## int Current

### Description
Gets the element in the collection at the current position of the enumerator.

### Returns
- **int** - The current element.
```

--------------------------------

### OnGUI(Rect, SerializedProperty, GUIContent)

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEditor.Splines.SplineIndexPropertyDrawer.html

Renders the custom GUI interface for the SerializedProperty, displaying the spline index selection menu.

```APIDOC
## OnGUI(Rect position, SerializedProperty property, GUIContent label)

### Description
Creates an interface for a SerializedProperty with an integer property type.

### Parameters
- **position** (Rect) - Rectangle on the screen to use for the property GUI.
- **property** (SerializedProperty) - The SerializedProperty to make the custom GUI for.
- **label** (GUIContent) - The label of this property.
```

--------------------------------

### PreviousIndex<T>(T, int)

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineUtility.html

Gets the index of a knot that precedes a spline index.

```APIDOC
## PreviousIndex<T>(T, int)

### Description
Gets the index of a knot that precedes a spline index. This method uses the Count and Closed properties to ensure that it returns the correct index of the knot.

### Parameters
- **spline** (T) - The spline to consider.
- **index** (int) - The current index to consider.

### Returns
- **int** - Returns a knot index that precedes the `index` on the considered spline.
```

--------------------------------

### ExtrudeSettings(T)

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.ExtrudeSettings-1.html

Creates a new ExtrudeSettings object using a provided IExtrudeShape instance with default parameter values.

```APIDOC
## ExtrudeSettings(T shape)

### Description
Creates a new settings object with an IExtrudeShape instance. A default set of parameters will be used.

### Parameters
- **shape** (T) - The IExtrudeShape template to be used as the shape template when extruding.
```

--------------------------------

### Get Tangent Mode

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.Spline.html

Retrieves the TangentMode for a specific knot index.

```csharp
public TangentMode GetTangentMode(int index)
```

--------------------------------

### OnGUI(Rect, SerializedProperty, GUIContent)

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEditor.Splines.SplineInfoPropertyDrawer.html

Renders the custom GUI interface for the specified SerializedProperty within the provided screen rectangle.

```APIDOC
## void OnGUI(Rect position, SerializedProperty property, GUIContent label)

### Description
Creates an interface for a SerializedProperty with an integer property type.

### Parameters
- **position** (Rect) - Rectangle on the screen to use for the property GUI.
- **property** (SerializedProperty) - The SerializedProperty to make the custom GUI for.
- **label** (GUIContent) - The label of this property.
```

--------------------------------

### NativeSpline Constructor (Knots)

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.NativeSpline.html

Initializes a new NativeSpline from a collection of BezierKnot objects.

```csharp
public NativeSpline(IReadOnlyList<BezierKnot> knots, IReadOnlyList<int> splits, bool closed, float4x4 transform, Allocator allocator = Allocator.Temp)
```

--------------------------------

### Get DataPoint Enumerator

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineData-1.html

Retrieves an enumerator for iterating over the collection of DataPoints.

```csharp
public IEnumerator<DataPoint<T>> GetEnumerator()
```

--------------------------------

### Link Method

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.KnotLinkCollection.html

Establishes a link between two knot positions.

```csharp
public void Link(SplineKnotIndex knotA, SplineKnotIndex knotB)
```

--------------------------------

### SplineRange(int, int)

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineRange.html

Creates a new SplineRange from a start index and count.

```APIDOC
## SplineRange(int start, int count)

### Description
Creates a new SplineRange from a start index and count. If the count is negative, it acts as shorthand for specifying the slice direction.

### Parameters
- **start** (int) - The inclusive first index of a range.
- **count** (int) - The number of elements this range encompasses.
```

--------------------------------

### SplineRange End Property

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineRange.html

Property to get the inclusive end index of the range.

```csharp
public int End { get; }
```

--------------------------------

### Spline Constructors

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.Spline.html

Various ways to initialize a new Spline instance.

```csharp
public Spline()
```

```csharp
public Spline(IEnumerable<float3> knotPositions, TangentMode tangentMode = TangentMode.AutoSmooth, bool closed = false)
```

```csharp
public Spline(IEnumerable<BezierKnot> knots, bool closed = false)
```

```csharp
public Spline(int knotCapacity, bool closed = false)
```

```csharp
public Spline(Spline spline)
```

--------------------------------

### SplineRange Direction Property

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineRange.html

Property to get or set the interpolation direction of the range.

```csharp
public SliceDirection Direction { get; set; }
```

--------------------------------

### NativeSpline Constructor (Full)

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.NativeSpline.html

Constructs a NativeSpline with explicit control over knot collection, closure, transformation, up-vector caching, and memory allocation.

```csharp
public NativeSpline(IReadOnlyList<BezierKnot> knots, bool closed, float4x4 transform, bool cacheUpVectors, Allocator allocator = Allocator.Temp)
```

--------------------------------

### SplineRange Count Property

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineRange.html

Property to get or set the number of indices in the range.

```csharp
public int Count { get; set; }
```

--------------------------------

### NativeSpline(IReadOnlyList<BezierKnot>, bool, float4x4, bool, Allocator)

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.NativeSpline.html

Constructs a new NativeSpline from a collection of BezierKnot, allowing for closed-loop configuration, transformation matrices, and optional up-vector caching.

```APIDOC
## NativeSpline(IReadOnlyList<BezierKnot> knots, bool closed, float4x4 transform, bool cacheUpVectors, Allocator allocator)

### Description
Creates a new NativeSpline instance from a set of BezierKnot. This constructor allows specifying whether the spline is closed, applying a transformation matrix, and optionally caching up vectors for performance.

### Parameters
- **knots** (IReadOnlyList<BezierKnot>) - Required - A collection of sequential BezierKnot forming the spline path.
- **closed** (bool) - Required - Whether the spline is open or closed.
- **transform** (float4x4) - Required - A transformation matrix applied to the control knots.
- **cacheUpVectors** (bool) - Required - Whether to pre-compute and cache up vectors along the spline.
- **allocator** (Allocator) - Optional - The memory allocation method (default: Allocator.Temp).
```

--------------------------------

### Accessing the Main Spline

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineContainer.html

Gets or sets the primary spline associated with the container.

```csharp
public Spline Spline { get; set; }
```

--------------------------------

### NativeSpline Constructor (ISpline)

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.NativeSpline.html

Initializes a new NativeSpline from an existing ISpline object, with optional caching and transformation parameters.

```csharp
public NativeSpline(ISpline spline, bool cacheUpVectors, Allocator allocator = Allocator.Temp)
```

```csharp
public NativeSpline(ISpline spline, Allocator allocator = Allocator.Temp)
```

```csharp
public NativeSpline(ISpline spline, float4x4 transform, bool cacheUpVectors, Allocator allocator = Allocator.Temp)
```

```csharp
public NativeSpline(ISpline spline, float4x4 transform, Allocator allocator = Allocator.Temp)
```

--------------------------------

### Play()

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineAnimate.html

Begins animating the object along the spline.

```APIDOC
## public void Play()

### Description
Begin animating object along the Spline.
```

--------------------------------

### BezierCurve Tangent Properties

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.BezierCurve.html

Properties to get or set the tangents of the cubic curve.

```csharp
public float3 Tangent0 { get; set; }
```

```csharp
public float3 Tangent1 { get; set; }
```

--------------------------------

### Retrieving Pivot Position

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEditor.Splines.SplineTool.html

Gets the current pivot position relative to the selection.

```csharp
public static Vector3 pivotPosition { get; }
```

--------------------------------

### OnGUI Method Declaration

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEditor.Splines.SplineIndexPropertyDrawer.html

Renders the custom GUI interface for the integer property.

```csharp
public override void OnGUI(Rect position, SerializedProperty property, GUIContent label)
```

--------------------------------

### Managing Handle Orientation

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEditor.Splines.SplineTool.html

Gets or sets the orientation mode for spline handles.

```csharp
public static HandleOrientation handleOrientation { get; set; }
```

--------------------------------

### Upload()

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineComputeBufferScope-1.html

Synchronizes the spline data to the GPU buffers.

```APIDOC
### Method: Upload()

Copies the spline curve, info, and length caches to their respective GPU buffers.
```

--------------------------------

### NativeSpline Constructor (With Splits)

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.NativeSpline.html

Constructs a NativeSpline including specific knot indices to be treated as degenerate curves for non-interpolated gaps.

```csharp
public NativeSpline(IReadOnlyList<BezierKnot> knots, IReadOnlyList<int> splits, bool closed, float4x4 transform, bool cacheUpVectors, Allocator allocator = Allocator.Temp)
```

--------------------------------

### SplinePath Slices Property

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplinePath-1.html

Gets or sets the collection of ISpline objects that constitute the path.

```csharp
public IReadOnlyList<T> Slices { get; set; }
```

--------------------------------

### SmoothStepFloat4

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.InterpolatorUtility.html

Gets an interpolator that performs smooth step interpolation between two float4 values.

```APIDOC
## public static IInterpolator<float4> SmoothStepFloat4

### Description
Interpolates between two values a and b by ratio t with smoothing at the start and end.

### Property Value
- **Type**: IInterpolator<float4>
```

--------------------------------

### DataPoint Constructor

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.DataPoint-1.html

Initializes a new instance of the DataPoint struct.

```csharp
public DataPoint(float index, TDataType value)
```

--------------------------------

### SplineToolSettings.toolbarElements

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEditor.Splines.SplineToolSettings.html

Gets the list of toolbar element IDs to display when the Overlay is in a toolbar layout.

```APIDOC
## Property: toolbarElements

### Description
Retrieves a collection of toolbar element IDs that should be displayed when the associated Overlay is configured in a toolbar layout.

### Declaration
`public IEnumerable<string> toolbarElements { get; }`

### Property Value
- **Type**: `IEnumerable<string>`
- **Description**: A list of string identifiers representing the toolbar elements.
```

--------------------------------

### Road.SideCount

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.ExtrusionShapes.Road.html

Gets the number of vertices that make up a single ring around the extruded mesh.

```APIDOC
### Property: SideCount

#### Description
Returns the number of vertices that make up a single ring around the extruded mesh.

#### Declaration
`public int SideCount { get; }`

#### Returns
- **int** - The number of vertices per ring.
```

--------------------------------

### SplineInfo Constructor

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineInfo.html

Initializes a new instance of the SplineInfo struct.

```csharp
public SplineInfo(ISplineContainer container, int index)
```

--------------------------------

### NativeSpline(IReadOnlyList<BezierKnot>, bool, float4x4, Allocator)

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.NativeSpline.html

Constructs a new NativeSpline from a collection of BezierKnot with a transformation matrix and default caching settings.

```APIDOC
## NativeSpline(IReadOnlyList<BezierKnot> knots, bool closed, float4x4 transform, Allocator allocator)

### Description
Creates a new NativeSpline instance from a set of BezierKnot with a specified transformation matrix.

### Parameters
- **knots** (IReadOnlyList<BezierKnot>) - Required - A collection of sequential BezierKnot forming the spline path.
- **closed** (bool) - Required - Whether the spline is open or closed.
- **transform** (float4x4) - Required - A transformation matrix applied to the control knots.
- **allocator** (Allocator) - Optional - The memory allocation method (default: Allocator.Temp).
```

--------------------------------

### Square.SideCount

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.ExtrusionShapes.Square.html

Gets the number of vertices that make up a single ring around the extruded mesh.

```APIDOC
## Property: SideCount

### Description
Returns the number of vertices that make up a single ring around the extruded mesh.

### Type
int

### Declaration
`public int SideCount { get; }`
```

--------------------------------

### Get inverted BezierCurve

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.BezierCurve.html

Returns a new BezierCurve representing the same path in the opposite direction.

```csharp
public BezierCurve GetInvertedCurve()
```

--------------------------------

### SplineInstantiate.InstantiableItem Syntax

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineInstantiate.InstantiableItem.html

The definition of the serializable struct used for spline instantiation items.

```csharp
[Serializable]
public struct SplineInstantiate.InstantiableItem
```

--------------------------------

### Retrieving Handle Rotation

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEditor.Splines.SplineTool.html

Gets the current rotation of the handle based on selection and configuration.

```csharp
public static Quaternion handleRotation { get; }
```

--------------------------------

### ExtrudeSettings(int, bool, float2, float, T)

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.ExtrudeSettings-1.html

Creates a new ExtrudeSettings object with specified parameters for segments, capping, range, radius, and the shape template.

```APIDOC
## ExtrudeSettings(int segments, bool capped, float2 range, float radius, T shape)

### Description
Creates a new settings object used by functions in SplineMesh to extrude a shape template along a spline.

### Parameters
- **segments** (int) - The number of segments to divide the extruded spline into when creating vertex rings.
- **capped** (bool) - Defines whether the ends of the extruded spline mesh should be closed.
- **range** (float2) - The start and end points as normalized interpolation values.
- **radius** (float) - Defines the size of the extruded mesh.
- **shape** (T) - The IExtrudeShape template to be used as the shape template when extruding.
```

--------------------------------

### Position Property Declaration

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEditor.Splines.ISelectableElement.html

Gets or sets the position of the spline element in world space.

```csharp
float3 Position { get; set; }
```

--------------------------------

### BezierKnot Constructors

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.BezierKnot.html

Constructors for creating a new BezierKnot instance with varying levels of detail.

```APIDOC
public BezierKnot(float3 position)
public BezierKnot(float3 position, float3 tangentIn, float3 tangentOut)
public BezierKnot(float3 position, float3 tangentIn, float3 tangentOut, quaternion rotation)
```

--------------------------------

### LocalPosition Property Declaration

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEditor.Splines.ISelectableElement.html

Gets or sets the position of the spline element in local space.

```csharp
float3 LocalPosition { get; set; }
```

--------------------------------

### Configuring Custom Spline Handles

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEditor.Splines.SplineToolContext.html

Set useCustomSplineHandles to true to manage spline handle drawing and manipulation manually within a custom tool.

```csharp
public static bool useCustomSplineHandles { set; }
```

--------------------------------

### SplineInfo Methods

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineInfo.html

Methods for equality comparison, hashing, and serialization support.

```csharp
public override bool Equals(object obj)
```

```csharp
public bool Equals(SplineInfo other)
```

```csharp
public override int GetHashCode()
```

```csharp
public void OnAfterDeserialize()
```

```csharp
public void OnBeforeSerialize()
```

--------------------------------

### Range Property Declaration

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.ExtrudeSettings-1.html

Defines the normalized interpolation start and end points of the spline to extrude.

```csharp
public float2 Range { get; set; }
```

--------------------------------

### NextIndex<T>(T, int)

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineUtility.html

Gets the index of a knot that follows a spline index, accounting for spline closure.

```APIDOC
## NextIndex<T>(T, int)

### Description
Gets the index of a knot that follows a spline index. This method uses the Count and Closed properties to ensure that it returns the correct index of the knot.

### Parameters
- **spline** (T) - The spline to consider.
- **index** (int) - The current index to consider.

### Returns
- **int** - The knot index after `index` on the considered spline.
```

--------------------------------

### IExtrudeShape Interface Syntax

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.IExtrudeShape.html

The interface definition for creating custom extrusion shapes.

```csharp
public interface IExtrudeShape
```

--------------------------------

### SideCount

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.ExtrusionShapes.Circle.html

Gets or sets the number of vertices that make up a single ring around the extruded mesh.

```APIDOC
## Property SideCount

### Description
Defines how many vertices make up a revolution for each segment of the extruded mesh.

### Declaration
`public int SideCount { get; set; }`
```

--------------------------------

### DrawGizmos Method Declaration

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEditor.Splines.SplineGizmoUtility.html

Method signature for drawing a line gizmo for an ISplineContainer.

```csharp
public static void DrawGizmos(ISplineContainer container)
```

--------------------------------

### Get Active Selection Element

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEditor.Splines.SplineSelection.html

Retrieves the most recently added element from the provided spline targets.

```csharp
public static ISelectableElement GetActiveElement(IReadOnlyList<SplineInfo> targets)
```

--------------------------------

### Manage SplineComputeBufferScope Lifecycle

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineComputeBufferScope-1.html

Methods to upload spline data to the GPU and release allocated resources.

```csharp
public void Dispose()
```

```csharp
public void Upload()
```

--------------------------------

### SplineMeshHandle Material Property

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEditor.Splines.SplineMeshHandle-1.html

Property to get or set the material used for rendering the cylinder mesh.

```csharp
public Material material { get; set; }
```

--------------------------------

### CreateSquare Method

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineFactory.html

Generates a square spline with sharp corners.

```csharp
public static Spline CreateSquare(float size)
```

--------------------------------

### InstantiableItem Prefab Field

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineInstantiate.InstantiableItem.html

The GameObject field representing the prefab to be instantiated.

```csharp
[FormerlySerializedAs("prefab")]
public GameObject Prefab
```

--------------------------------

### SplineRange(int, int, SliceDirection)

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineRange.html

Creates a new SplineRange from a start index, count, and explicit direction.

```APIDOC
## SplineRange(int start, int count, SliceDirection direction)

### Description
Creates a new SplineRange from a start index, count, and a specified slice direction.

### Parameters
- **start** (int) - The inclusive first index of a range.
- **count** (int) - The number of elements this range encompasses.
- **direction** (SliceDirection) - Whether the range increments from start to start + count, or decrements from start to start - count.
```

--------------------------------

### SplineMeshHandle Constructors

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEditor.Splines.SplineMeshHandle-1.html

Constructors for initializing the mesh handle, optionally with a specific material.

```csharp
public SplineMeshHandle()
```

```csharp
public SplineMeshHandle(Material material)
```

--------------------------------

### DataPoint ToString Method

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.DataPoint-1.html

Returns a string representation of the DataPoint.

```csharp
public override string ToString()
```

--------------------------------

### Get Spline Data Keys

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.Spline.html

Retrieves an enumerable collection of keys for a specific embedded data type.

```csharp
public IEnumerable<string> GetSplineDataKeys(EmbeddedSplineDataType type)
```

--------------------------------

### BezierCurve Constructors

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.BezierCurve.html

Various constructors to initialize a BezierCurve from different point configurations or knots.

```csharp
public BezierCurve(float3 p0, float3 p1)
```

```csharp
public BezierCurve(float3 p0, float3 p1, float3 p2)
```

```csharp
public BezierCurve(float3 p0, float3 p1, float3 p2, float3 p3)
```

```csharp
public BezierCurve(BezierKnot a, BezierKnot b)
```

--------------------------------

### IHasEmptyCurves.EmptyCurves

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.IHasEmptyCurves.html

Gets a collection of knot indices that are considered degenerate curves, creating non-interpolated gaps between curves.

```APIDOC
## Property: EmptyCurves

### Description
A collection of knot indices that should be considered degenerate curves for the purpose of creating a non-interpolated gap between curves.

### Declaration
`IReadOnlyList<int> EmptyCurves { get; }`

### Property Value
- **Type**: `IReadOnlyList<int>`
```

--------------------------------

### Methods

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.DataPoint-1.html

Methods for comparing DataPoints and retrieving string representations.

```APIDOC
### Methods

- **CompareTo(float other)** (int) - Compares the current DataPoint's Index against a float value.
- **CompareTo(DataPoint<TDataType> other)** (int) - Compares the current DataPoint's Index against another DataPoint's Index.
- **ToString()** (string) - Returns a summary of the DataPoint's index and value.
```

--------------------------------

### SplineMeshHandle Do Methods

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEditor.Splines.SplineMeshHandle-1.html

Methods to draw the 3D mesh handle from a spline, with variants for control IDs, colors, and resolution.

```csharp
public void Do(int controlID, T spline, float size, int resolution = 10)
```

```csharp
public void Do(int controlID, T spline, float size, Color color, int resolution = 10)
```

```csharp
public void Do(T spline, float size, int resolution = 10)
```

```csharp
public void Do(T spline, float size, Color color, int resolution = 10)
```

--------------------------------

### Get or Create Spline Data

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.Spline.html

Methods to retrieve a reference to stored SplineData. If the key does not exist, a new entry is created.

```csharp
public SplineData<float4> GetOrCreateFloat4Data(string key)
```

```csharp
public SplineData<float> GetOrCreateFloatData(string key)
```

```csharp
public SplineData<int> GetOrCreateIntData(string key)
```

```csharp
public SplineData<Object> GetOrCreateObjectData(string key)
```

--------------------------------

### CapEnds Property Declaration

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.ExtrudeSettings-1.html

Defines whether the start and end of the mesh are filled. Note that this method assumes convex geometry for the input shape.

```csharp
public bool CapEnds { get; set; }
```

--------------------------------

### OnGUI(Rect, SerializedProperty, GUIContent)

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEditor.Splines.EmbeddedSplineDataPropertyDrawer.html

Renders the custom GUI interface for a SerializedProperty with an EmbeddedSplineData type.

```APIDOC
## OnGUI(Rect, SerializedProperty, GUIContent)

### Description
Creates the custom interface for a SerializedProperty with an EmbeddedSplineData type within the specified screen rectangle.

### Parameters
- **position** (Rect) - Rectangle on the screen to use for the property GUI.
- **property** (SerializedProperty) - The SerializedProperty to make the custom GUI for.
- **label** (GUIContent) - The label of this property.
```

--------------------------------

### SplineMeshHandle Constructors

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEditor.Splines.SplineMeshHandle-1.html

Constructors for initializing a new SplineMeshHandle instance. The class implements IDisposable, so ensure Dispose() is called when finished.

```APIDOC
## SplineMeshHandle()
Creates a new mesh handle.

## SplineMeshHandle(Material material)
Creates a new mesh handle with a specific material.
- **material** (Material) - The material to render the cylinder mesh with.
```

--------------------------------

### Evaluate<T>(T, float, out float3, out float3, out float3)

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineContainer.html

Gets the interpolated position, direction, and upDirection at ratio t for a spline, optimized to reduce redundant computation.

```APIDOC
## Evaluate<T>(T, float, out float3, out float3, out float3)

### Description
Gets the interpolated position, direction, and upDirection at ratio t for a spline. This method is faster than individual evaluations as it reduces redundant computation.

### Parameters
- **spline** (T) - The spline to evaluate.
- **t** (float) - A value between 0 and 1 that represents the ratio along the curve.
- **position** (out float3) - The output variable for the float3 position at t.
- **tangent** (out float3) - The output variable for the float3 tangent at t.
- **upVector** (out float3) - The output variable for the float3 up direction at t.

### Returns
- **bool** - True if a valid set of output variables is computed and false otherwise.
```

--------------------------------

### Extrude mesh with settings object

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineMesh.html

Extrudes a mesh along a spline using an ExtrudeSettings configuration object.

```csharp
public static bool Extrude<T, K>(T spline, Mesh mesh, ExtrudeSettings<K> settings) where T : ISpline where K : IExtrudeShape
```

--------------------------------

### SplineData Constructors

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineData-1.html

Constructors for initializing a new SplineData instance.

```csharp
public SplineData()
```

```csharp
public SplineData(IEnumerable<DataPoint<T>> dataPoints)
```

```csharp
public SplineData(T init)
```

--------------------------------

### NativeSpline Constructors

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.NativeSpline.html

Constructors for creating a NativeSpline from existing knot data or an ISpline object.

```APIDOC
## NativeSpline(IReadOnlyList<BezierKnot>, IReadOnlyList<int>, bool, float4x4, Allocator)

### Description
Creates a new NativeSpline from a collection of BezierKnot objects.

### Parameters
- **knots** (IReadOnlyList<BezierKnot>) - A collection of sequential BezierKnot forming the spline path.
- **splits** (IReadOnlyList<int>) - A collection of knot indices that should be considered degenerate curves.
- **closed** (bool) - Whether the spline is open or closed.
- **transform** (float4x4) - Transformation matrix applied to the control knots.
- **allocator** (Allocator) - Memory allocation method.

## NativeSpline(ISpline, bool, Allocator)

### Description
Creates a new NativeSpline from an existing ISpline object with optional up-vector caching.

### Parameters
- **spline** (ISpline) - The ISpline object to convert.
- **cacheUpVectors** (bool) - Whether to cache Up vectors along the spline.
- **allocator** (Allocator) - Memory allocation method.
```

--------------------------------

### Create BezierCurve from tangents

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.BezierCurve.html

Constructs a new BezierCurve using start/end points and their respective tangent directions and magnitudes.

```csharp
public static BezierCurve FromTangent(float3 pointA, float3 tangentOutA, float3 pointB, float3 tangentInB)
```

--------------------------------

### OnActivated()

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEditor.Splines.SplineToolContext.html

Invoked after this EditorToolContext becomes the active tool context.

```APIDOC
## public override void OnActivated()

### Description
Invoked after this EditorToolContext becomes the active tool context.
```

--------------------------------

### Create Spline index selection fields

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEditor.Splines.SplineGUILayout.html

Methods to create dropdowns for selecting spline indices from SerializedProperties or containers.

```csharp
public static void SplineIndexField(SerializedProperty property, int splineCount)
```

```csharp
public static void SplineIndexField<T>(SerializedProperty property, T container) where T : ISplineContainer
```

--------------------------------

### Spline Constructors

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.Spline.html

Various constructors to initialize a new Spline instance, including empty, from positions, from existing knots, or by copying another spline.

```APIDOC
## Constructors

### Spline()
Creates an empty, open spline.

### Spline(IEnumerable<float3> knotPositions, TangentMode tangentMode, bool closed)
Creates a spline from a collection of positions.

### Spline(IEnumerable<BezierKnot> knots, bool closed)
Creates a spline from a collection of BezierKnot objects.

### Spline(int knotCapacity, bool closed)
Creates a spline with a pre-allocated capacity.

### Spline(Spline spline)
Creates a copy of an existing spline.
```

--------------------------------

### CreateCatmullRom Method

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineFactory.html

Creates a spline from a list of positions with Catmull Rom tangents.

```csharp
public static Spline CreateCatmullRom(IList<float3> positions, bool closed = false)
```

--------------------------------

### Custom Circle Extrusion Shape

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.IExtrudeShape.html

An implementation of IExtrudeShape that creates a circular tube profile, marked as Serializable for Inspector editing.

```csharp
// While not strictly necessary, marking the class as Serializable means that
// this can be edited in the Inspector.
[Serializable]
public class Circle : IExtrudeShape
{
    [SerializeField, Min(2)]
    int m_Sides = 8;

    float m_Rads;

    // We only need to calculate the radians step once, so do it in the Setup method.
    public void Setup(ISpline path, int segmentCount)
    {
        m_Rads = math.radians(360f / SideCount);
    }

    public float2 GetPosition(float t, int index)
    {
        return new float2(math.cos(index * m_Rads), math.sin(index * m_Rads));
    }

    public int SideCount
    {
        get => m_Sides;
        set => m_Sides = value;
    }
}
```

--------------------------------

### DataPoint Comparison Methods

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.DataPoint-1.html

Methods to compare the index of a DataPoint against a float or another DataPoint.

```csharp
public int CompareTo(float other)
```

```csharp
public int CompareTo(DataPoint<TDataType> other)
```

--------------------------------

### SplineSlice Constructors

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineSlice-1.html

Constructors for initializing a new SplineSlice with a reference to a spline and a range, optionally including a transform matrix.

```csharp
public SplineSlice(T spline, SplineRange range)
```

```csharp
public SplineSlice(T spline, SplineRange range, float4x4 transform)
```

--------------------------------

### Construct SplineComputeBufferScope

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineComputeBufferScope-1.html

Initialize a new scope with a specific spline instance.

```csharp
public SplineComputeBufferScope(T spline)
```

--------------------------------

### Insert(int, float3, TangentMode)

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.Spline.html

Creates a BezierKnot from a position and inserts it at the specified index.

```APIDOC
### Method
public void Insert(int index, float3 knotPosition, TangentMode tangentMode = TangentMode.AutoSmooth)

### Parameters
- **index** (int) - The zero-based index to insert the new element at.
- **knotPosition** (float3) - The knot position to convert to a BezierKnot and insert in the spline.
- **tangentMode** (TangentMode) - The TangentMode to apply to the new element. The default value is Autosmooth.
```

--------------------------------

### SplineInstantiate.InstantiableItem

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineInstantiate.InstantiableItem.html

A serializable struct that pairs a GameObject prefab with a float probability value for use in spline-based instantiation systems.

```APIDOC
## Struct: SplineInstantiate.InstantiableItem

### Description
Represents an item configuration for spline instantiation, containing a reference to a prefab and the probability of that prefab being selected.

### Fields
- **Prefab** (GameObject) - The prefab to instantiate.
- **Probability** (float) - The probability weight assigned to this specific prefab.
```

--------------------------------

### TryGetFloatData(string, out SplineData<float>)

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.Spline.html

Retrieves a reference to stored float SplineData by key.

```APIDOC
## TryGetFloatData(string key, out SplineData<float> data)

### Description
Retrieve a SplineData<T> reference for `key` if it exists. Note that this is a reference to the stored SplineData<T>, not a copy.

### Parameters
- **key** (string) - The string key value to search for.
- **data** (SplineData<float>) - The output SplineData<T> if the key is found.

### Returns
- **bool** - True if the key and type combination are found, otherwise false.
```

--------------------------------

### SplineHandleScope Constructor

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEditor.Splines.SplineHandles.SplineHandleScope.html

Initializes a new instance of the SplineHandleScope class.

```csharp
public SplineHandleScope()
```

--------------------------------

### SplinePath Constructor

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplinePath.html

Initializes a new instance of the SplinePath class using a collection of spline slices.

```csharp
public SplinePath(IEnumerable<SplineSlice<Spline>> slices)
```

--------------------------------

### Create a Spline Programmatically

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/index.html

Adds a SplineContainer to a GameObject and initializes a new spline with Bezier knots.

```csharp
using Unity.Mathematics;
using UnityEngine;
using UnityEngine.Splines;

class CreateSplineAtStart : MonoBehaviour
{
    void Start()
    {
        // Add a SplineContainer component to this GameObject.
        var container = gameObject.AddComponent<SplineContainer>();

        // Create a new Spline on the SplineContainer.
        var spline = container.AddSpline();

        // Set some knot values.
        var knots = new BezierKnot[3];
        knots[0] = new BezierKnot(new float3(0f,  0f, 0f));
        knots[1] = new BezierKnot(new float3(1f,  1f, 0f));
        knots[2] = new BezierKnot(new float3(2f, -1f, 0f));
        spline.Knots = knots;
    }
}
```

--------------------------------

### ExtrudeSettings Syntax

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.ExtrudeSettings-1.html

The struct definition for ExtrudeSettings, requiring a type parameter T that implements IExtrudeShape.

```csharp
public struct ExtrudeSettings<T> where T : IExtrudeShape
```

--------------------------------

### PickResolutionMin Constant

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineUtility.html

The minimum resolution allowable when unrolling a curve to hit test while picking.

```csharp
public const int PickResolutionMin = 2
```

--------------------------------

### SlerpFloat3 Syntax

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.Interpolators.SlerpFloat3.html

The structure definition for SlerpFloat3 implementing IInterpolator.

```csharp
public struct SlerpFloat3 : IInterpolator<float3>
```

--------------------------------

### TryGetFloat4Data(string, out SplineData<float4>)

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.Spline.html

Retrieves a reference to stored float4 SplineData by key.

```APIDOC
## TryGetFloat4Data(string key, out SplineData<float4> data)

### Description
Retrieve a SplineData<T> reference for `key` if it exists. Note that this is a reference to the stored SplineData<T>, not a copy.

### Parameters
- **key** (string) - The string key value to search for.
- **data** (SplineData<float4>) - The output SplineData<T> if the key is found.

### Returns
- **bool** - True if the key and type combination are found, otherwise false.
```

--------------------------------

### SplineData<T> Constructors

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineData-1.html

Methods to initialize a new instance of the SplineData class.

```APIDOC
## Constructors

### SplineData()
Creates a new empty SplineData instance.

### SplineData(IEnumerable<DataPoint<T>> dataPoints)
Creates a new SplineData instance initialized with a collection of data points, sorted by index.

### SplineData(T init)
Creates a new SplineData instance with a single value at t = 0.
```

--------------------------------

### SplineInstantiate Properties

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineInstantiate.html

Properties for configuring the SplineInstantiate component.

```csharp
public SplineContainer Container { get; set; }
```

```csharp
public SplineInstantiate.Space CoordinateSpace { get; set; }
```

```csharp
public SplineComponent.AlignAxis ForwardAxis { get; set; }
```

```csharp
public SplineInstantiate.Method InstantiateMethod { get; set; }
```

```csharp
public Vector3 MaxPositionOffset { get; set; }
```

```csharp
public Vector3 MaxRotationOffset { get; set; }
```

```csharp
public Vector3 MaxScaleOffset { get; set; }
```

```csharp
public float MaxSpacing { get; set; }
```

```csharp
public Vector3 MinPositionOffset { get; set; }
```

```csharp
public Vector3 MinRotationOffset { get; set; }
```

```csharp
public Vector3 MinScaleOffset { get; set; }
```

```csharp
public float MinSpacing { get; set; }
```

```csharp
public SplineInstantiate.OffsetSpace PositionSpace { get; set; }
```

```csharp
public SplineInstantiate.OffsetSpace RotationSpace { get; set; }
```

```csharp
public SplineInstantiate.OffsetSpace ScaleSpace { get; set; }
```

```csharp
public int Seed { get; set; }
```

```csharp
public SplineComponent.AlignAxis UpAxis { get; set; }
```

```csharp
public SplineInstantiate.InstantiableItem[] itemsToInstantiate { get; set; }
```

--------------------------------

### GetBounds Extension Methods

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineUtility.html

Calculates the bounding box for an ISpline, with an optional transformation matrix.

```csharp
public static Bounds GetBounds<T>(this T spline) where T : ISpline
```

```csharp
public static Bounds GetBounds<T>(this T spline, float4x4 transform) where T : ISpline
```

--------------------------------

### Clear Method

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.KnotLinkCollection.html

Removes all links from the collection.

```csharp
public void Clear()
```

--------------------------------

### NativeSpline(IReadOnlyList<BezierKnot>, IReadOnlyList<int>, bool, float4x4, bool, Allocator)

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.NativeSpline.html

Constructs a new NativeSpline from a collection of BezierKnot and specific knot indices for degenerate curves.

```APIDOC
## NativeSpline(IReadOnlyList<BezierKnot> knots, IReadOnlyList<int> splits, bool closed, float4x4 transform, bool cacheUpVectors, Allocator allocator)

### Description
Creates a new NativeSpline instance, allowing for the definition of degenerate curves via knot indices to create non-interpolated gaps.

### Parameters
- **knots** (IReadOnlyList<BezierKnot>) - Required - A collection of sequential BezierKnot forming the spline path.
- **splits** (IReadOnlyList<int>) - Required - Knot indices considered degenerate for non-interpolated gaps.
- **closed** (bool) - Required - Whether the spline is open or closed.
- **transform** (float4x4) - Required - A transformation matrix applied to the control knots.
- **cacheUpVectors** (bool) - Required - Whether to pre-compute and cache up vectors along the spline.
- **allocator** (Allocator) - Optional - The memory allocation method (default: Allocator.Temp).
```

--------------------------------

### UpdateInstances()

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.SplineInstantiate.html

Triggers the creation or update of instances along the spline based on the configured prefabs.

```APIDOC
## UpdateInstances()

### Description
Create and update all instances along the spline based on the list of available prefabs/objects.

### Declaration
`public void UpdateInstances()`
```

--------------------------------

### CopyTo(BezierKnot[], int)

Source: https://docs.unity3d.com/Packages/com.unity.splines%402.8/api/UnityEngine.Splines.Spline.html

Copies knots to an array.

```APIDOC
## public void CopyTo(BezierKnot[] array, int arrayIndex)

### Description
Copies the contents of the knot list to an array starting at an index.

### Parameters
- **array** (BezierKnot[]) - The destination array.
- **arrayIndex** (int) - The zero-based index to start copying.
```
Tokens:
Raw