Namespace UnityEngine.Splines | Splines | 2.6.0 (2024)

A collection of methods for extracting information about BezierCurve types.

Wrapper for accessing a SplineData<T> value stored on Spline through one of theembedded key value collections. It is not required to use this class to access embeddedSplineData<T>, however it does provide some convenient functionality for working with this datain the Inspector.

Attribute used to make an EmbeddedSplineData variable show in the Inspector with a filtered setof fields editable. Use this in situations where you want to specify EmbeddedSplineData parametersin code and not allow them to be modified in the Inspector.to a ISplineContainer.

InterpolatorUtility provides easy access to all the different IInterpolator implementations.

A collection of KnotLinks to track how spline knots are linked and the utilities toupdate these links when splines are modified.

The Spline class is a collection of BezierKnot, the closed/open state, and editing representation.

A component to animate an object along a spline.

Base class for SplineInstantiate and SplineExtrude, contains common elements to both of these Components

A component that holds a list of Spline objects.

The SplineData{T} class is used to store information relative to a Spline without coupling datadirectly to the Spline class. SplineData can store any type of data, and provides options for how to indexDataPoints.

A component for creating a tube mesh from a Spline at runtime.

Methods to create spline shapes.

Attribute used to make an integer variable show in the Inspector as a popup menu with spline choices relativeto a ISplineContainer.

SplineInstantiate is used to automatically instantiate prefabs or objects along a spline.

The SplineJobs class contains utility methods for evaluating spline data using the Jobs system.

Assorted utility functions for math equations commonly used when working with Splines.

Utility methods for creating and working with meshes.

The SplinePath type is an implementation of ISpline that is composed of multiple sections ofother splines (see SplineSlice<T>). This is useful when you want to evaluate a path that followsmultiple splines, typically in the case where splines share linked knots.

This class is a data structure that defines the range of curves to associate together. This class is not meant to beused intensively for runtime evaluation because it is not performant. Data is not meant to bestored in that struct and that struct is not reactive to spline changes. The GameObject that contains thisslice can be scaled and the knots of the targeted spline that can moved around the curve length cannot be storedhere so evaluating positions, tangents and up vectors is expensive.

If performance is a critical requirement, create a new Spline orNativeSpline from your SplinePath<T>. Note that you might pass a SplinePath<T>to constructors for both Spline and NativeSpline.

The SplinePath type is an implementation of ISpline that is composed of multiple sections ofother splines (see SplineSlice<T>). This is useful when you want to evaluate a path that followsmultiple splines, typically in the case where splines share linked knots.

If performance is a critical requirement, create a new Spline orNativeSpline from your SplinePath<T>. Note that you might pass a SplinePath<T>to constructors for both Spline and NativeSpline.

A collection of methods for extracting information about Spline types.

Control points for a cubic Bezier curve.

Points P0 through P3 are in sequential order, describing the starting point, second, third, and ending controlsfor a cubic Bezier curve.

This struct contains position and tangent data for a knot. The position is a scalar point and the tangents are vectors.The Spline class stores a collection of BezierKnot that form a series of connectedBezierCurve. Each knot contains a Position, Tangent In, and Tangent Out. When a spline is notclosed, the first and last knots will contain an extraneous tangent (in and out, respectively).

A pair containing an interpolation ratio and {TDataType} value.

A key-value pair associating a distance to interpolation ratio ('t') value. This is used when evaluating Splineattributes to ensure uniform distribution of sampling points.

Provides methods to calculate, in parallel, the positions along NativeSpline.

A job struct for calculating in parallel the position, tangent, and normal (up) vectors along aNativeSpline.

A read-only representation of Spline that is optimized for efficient access and queries.NativeSpline can be constructed with a spline and Transform. If a transform is applied, all values will berelative to the transformed knot positions.

SplineComputeBufferScope is a convenient way to extract from a spline the information necessary to evaluatespline values in a ComputeShader.To access Spline evaluation methods in a shader, include the "Splines.cginc" file:

#include "Packages/com.unity.splines/Shader/Spline.cginc"

SplineInfo is used to wrap a reference to the SplineContainer and index within that container todescribe a Spline.

Describe the item prefab to instantiate and associate it with a probability

Provides a tuple to define a couple (Spline index, Knot index) that identifies a particular knot on a spline.This tuple is used by KnotLinkCollection to maintain links between knots.

Describes a subset of knot indices in a Spline. The range might iterate in either theforward or backward direction.

A struct for iterating a SplineRange.

SplineSlice represents a partial or complete range of curves from another Spline.A SplineSlice<T> by itself does not store any BezierKnots. It stores a reference toa separate Spline, then retrieves knots by iterating the SplineRange.Use SplineSlice<T> in conjunction with SplinePath to create seamless paths fromdiscrete Spline segments.

This class is a data structure that defines the range of curves to associate together. This class is not meant to beused intensively for runtime evaluation because it is not performant. Data is not meant to bestored in that struct and that struct is not reactive to spline changes. The GameObject that contains thisslice can be scaled and the knots of the targeted spline that can moved around the curve length cannot be storedhere so evaluating positions, tangents and up vectors is expensive.

If performance is a critical requirement, create a new Spline orNativeSpline from the relevant SplinePath<T> or SplineSlice<T>.Note that you might pass a SplineSlice<T> to constructors for both Spline and NativeSpline.

Defines an interpolation ratio 't' for a Data Point.

This interface defines a collection of knot indices that should be considered disconnected from the followingknot indices when creating a BezierCurve.

To calculate a value at some distance along a spline, interpolation is required. The IInterpolator interfaceallows you to define how data is interpreted given a start value, end value, and normalized interpolation value(commonly referred to as 't').

ISpline defines the interface from which Spline types inherit.

An interface that represents ISplineContainer on a MonoBehaviour to enable Spline tools in the Editor.

Interface for Spline mesh vertex data. Implement this interface if you are extruding custom mesh data anddo not want to use the vertex layout provided by SplineMesh."/>.

Describes the direction of a BezierKnot tangent. A spline is composed of a list ofBezierKnot, where every knot can be either the start or end of a BezierCurve. TheBezierTangent enum indicates which tangent should be used to construct a curve.

Describes the fields on an EmbeddedSplineData type.

Describes a type of data stored by a SplineData<T> collection embedded in Spline.

Describes the unit of measurement used by DataPoint<TDataType>.

Describes the direction that a SplineRange interpolates. Use SplineSlice<T> andSplineRange to create paths that interpolate along a Spline in either a forwardor backward direction.

Describes the ways the object can be aligned when animating along the spline.

Describes the different ways the object's animation along the spline can be eased.

Describes the different ways the object's animation along the Spline can be looped.

Describes the different methods that can be used to animated an object along a spline.

Describes the different types of object alignment axes.

Describe the possible methods to instantiate instances along the spline.

The space in which to interpret the offset, this can be different from the orientation space used to instantiate objects.

Describes the coordinate space that is used to orient the instantiated object.

Describes the different types of changes that can occur to a spline.

Describes the different ways a tool might interact with a tangent handle.