Skip to main content

CubicSplineUtils

Utility methods involving cubic splines.

Types​

CubicSplineNode​

</>
interface CubicSplineNode {
t: number
p: T
v: T
}

A node that can be used as part of a cubic spline.

Functions​

newSplineNode​

</>
CubicSplineUtils.newSplineNode(
t: number,
position: T,
velocity: T
) → CubicSplineNode<T>

Creates a new spline node.

tween​

</>
CubicSplineUtils.tween(
nodeList: {CubicSplineNode<T>},--

Should be sorted.

t: number
) → CubicSplineNode<T>

Interpolates between the nodes at a given point.

cloneSplineNode​

</>
CubicSplineUtils.cloneSplineNode(node: CubicSplineNode<T>) → CubicSplineNode<T>

Clones a cubic spline.

tweenSplineNodes​

</>
CubicSplineUtils.tweenSplineNodes(
node0: CubicSplineNode<T>,
node1: CubicSplineNode<T>,
t: number
) → CubicSplineNode<T>

Interpolates between 2 cubic spline nodes.

sort​

</>
CubicSplineUtils.sort(nodeList: {CubicSplineNode<T>}) → ()

Sorts a cubic spline nodme based upon the time stamp

populateVelocities​

</>
CubicSplineUtils.populateVelocities(
nodeList: {CubicSplineNode<T>},
index0: number?,
index1: number?
) → ()

For a given node list, populates the velocity values of the nodes.

Show raw api
{
    "functions": [
        {
            "name": "newSplineNode",
            "desc": "Creates a new spline node.",
            "params": [
                {
                    "name": "t",
                    "desc": "",
                    "lua_type": "number"
                },
                {
                    "name": "position",
                    "desc": "",
                    "lua_type": "T"
                },
                {
                    "name": "velocity",
                    "desc": "",
                    "lua_type": "T"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CubicSplineNode<T>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 37,
                "path": "src/cubicspline/src/Shared/CubicSplineUtils.lua"
            }
        },
        {
            "name": "tween",
            "desc": "Interpolates between the nodes at a given point.",
            "params": [
                {
                    "name": "nodeList",
                    "desc": "Should be sorted.",
                    "lua_type": "{ CubicSplineNode<T> }"
                },
                {
                    "name": "t",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CubicSplineNode<T>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 51,
                "path": "src/cubicspline/src/Shared/CubicSplineUtils.lua"
            }
        },
        {
            "name": "cloneSplineNode",
            "desc": "Clones a cubic spline.",
            "params": [
                {
                    "name": "node",
                    "desc": "",
                    "lua_type": "CubicSplineNode<T>"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CubicSplineNode<T>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 78,
                "path": "src/cubicspline/src/Shared/CubicSplineUtils.lua"
            }
        },
        {
            "name": "tweenSplineNodes",
            "desc": "Interpolates between 2 cubic spline nodes.",
            "params": [
                {
                    "name": "node0",
                    "desc": "",
                    "lua_type": "CubicSplineNode<T>"
                },
                {
                    "name": "node1",
                    "desc": "",
                    "lua_type": "CubicSplineNode<T>"
                },
                {
                    "name": "t",
                    "desc": "",
                    "lua_type": "number"
                }
            ],
            "returns": [
                {
                    "desc": "",
                    "lua_type": "CubicSplineNode<T>"
                }
            ],
            "function_type": "static",
            "source": {
                "line": 89,
                "path": "src/cubicspline/src/Shared/CubicSplineUtils.lua"
            }
        },
        {
            "name": "sort",
            "desc": "Sorts a cubic spline nodme based upon the time stamp",
            "params": [
                {
                    "name": "nodeList",
                    "desc": "",
                    "lua_type": "{ CubicSplineNode<T> }"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 107,
                "path": "src/cubicspline/src/Shared/CubicSplineUtils.lua"
            }
        },
        {
            "name": "populateVelocities",
            "desc": "For a given node list, populates the velocity values of the nodes.",
            "params": [
                {
                    "name": "nodeList",
                    "desc": "",
                    "lua_type": "{ CubicSplineNode<T> }"
                },
                {
                    "name": "index0",
                    "desc": "",
                    "lua_type": "number?"
                },
                {
                    "name": "index1",
                    "desc": "",
                    "lua_type": "number?"
                }
            ],
            "returns": [],
            "function_type": "static",
            "source": {
                "line": 128,
                "path": "src/cubicspline/src/Shared/CubicSplineUtils.lua"
            }
        }
    ],
    "properties": [],
    "types": [
        {
            "name": "CubicSplineNode",
            "desc": "A node that can be used as part of a cubic spline.",
            "fields": [
                {
                    "name": "t",
                    "lua_type": "number",
                    "desc": ""
                },
                {
                    "name": "p",
                    "lua_type": "T",
                    "desc": ""
                },
                {
                    "name": "v",
                    "lua_type": "T",
                    "desc": ""
                }
            ],
            "source": {
                "line": 23,
                "path": "src/cubicspline/src/Shared/CubicSplineUtils.lua"
            }
        }
    ],
    "name": "CubicSplineUtils",
    "desc": "Utility methods involving cubic splines.",
    "source": {
        "line": 6,
        "path": "src/cubicspline/src/Shared/CubicSplineUtils.lua"
    }
}