docs.unity3d.com
    Show / Hide Table of Contents

    Namespace UnityEngine.Splines

    Classes

    CurveUtility

    A collection of methods for extracting information about BezierCurve types.

    Spline

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

    SplineContainer

    A Component that holds a Spline object.

    SplineData<T>

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

    SplineFactory

    Methods to create spline shapes.

    SplineUtility

    A collection of methods for extracting information about Spline types.

    Structs

    BezierCurve

    Control points for a cubic bezier curve.

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

    BezierKnot

    This struct contains position and tangent data for a knot. The Spline class stores a collection of BezierKnot that form a series of connected BezierCurve. Each knot contains a Position, Tangent In, and Tangent Out. When a Spline is not closed, the first and last knots will contain an extraneous tangent (in and out, respectively).

    Keyframe<T>

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

    NativeSpline

    A readonly 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 be relative to the transformed knot positions.

    Interfaces

    IInterpolator<T>

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

    IKeyframe

    Defines an interpolation ratio 't' for a keyframe.

    ISpline

    ISpline defines the interface from which Spline types inherit.

    ISplineProvider

    Implement ISplineProvider on a MonoBehaviour to enable Spline tools in the Editor.

    Enums

    PathIndexUnit

    Describes the unit of measurement used by Keyframe<T>.

    SplineType

    Describes the different supported Spline representations.

    Back to top
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023