13 lines
10 KiB
HTML
13 lines
10 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Provides types for building cubic splines for rendering curves and use with animation easing."><title>bevy_math::cubic_splines - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="bevy_math" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="icon" href="https://bevyengine.org/assets/icon.png"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button><a class="logo-container" href="../../bevy_math/index.html"><img src="https://bevyengine.org/assets/icon.png" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../../bevy_math/index.html"><img src="https://bevyengine.org/assets/icon.png" alt="logo"></a><h2><a href="../../bevy_math/index.html">bevy_<wbr>math</a><span class="version">0.15.1</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module cubic_<wbr>splines</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#traits" title="Traits">Traits</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate bevy_<wbr>math</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">bevy_math</a></span><h1>Module <span>cubic_splines</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/bevy_math/cubic_splines.rs.html#1-1769">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Provides types for building cubic splines for rendering curves and use with animation easing.</p>
|
||
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.CubicBSpline.html" title="struct bevy_math::cubic_splines::CubicBSpline">CubicB<wbr>Spline</a></div><div class="desc docblock-short">A spline interpolated continuously across the nearest four control points. The curve does not
|
||
necessarily pass through any of the control points.</div></li><li><div class="item-name"><a class="struct" href="struct.CubicBezier.html" title="struct bevy_math::cubic_splines::CubicBezier">Cubic<wbr>Bezier</a></div><div class="desc docblock-short">A spline composed of a single cubic Bezier curve.</div></li><li><div class="item-name"><a class="struct" href="struct.CubicBezierError.html" title="struct bevy_math::cubic_splines::CubicBezierError">Cubic<wbr>Bezier<wbr>Error</a></div><div class="desc docblock-short">An error returned during cubic curve generation for cubic Bezier curves indicating that a
|
||
segment of control points was not present.</div></li><li><div class="item-name"><a class="struct" href="struct.CubicCardinalSpline.html" title="struct bevy_math::cubic_splines::CubicCardinalSpline">Cubic<wbr>Cardinal<wbr>Spline</a></div><div class="desc docblock-short">A spline interpolated continuously across the nearest four control points, with the position of
|
||
the curve specified at every control point and the tangents computed automatically. The associated <a href="struct.CubicCurve.html" title="struct bevy_math::cubic_splines::CubicCurve"><code>CubicCurve</code></a>
|
||
has one segment between each pair of adjacent control points.</div></li><li><div class="item-name"><a class="struct" href="struct.CubicCurve.html" title="struct bevy_math::cubic_splines::CubicCurve">Cubic<wbr>Curve</a></div><div class="desc docblock-short">A collection of <a href="struct.CubicSegment.html" title="struct bevy_math::cubic_splines::CubicSegment"><code>CubicSegment</code></a>s chained into a single parametric curve. It is a <a href="../curve/trait.Curve.html" title="trait bevy_math::curve::Curve"><code>Curve</code></a>
|
||
with domain <code>[0, N]</code>, where <code>N</code> is its number of segments.</div></li><li><div class="item-name"><a class="struct" href="struct.CubicHermite.html" title="struct bevy_math::cubic_splines::CubicHermite">Cubic<wbr>Hermite</a></div><div class="desc docblock-short">A spline interpolated continuously between the nearest two control points, with the position and
|
||
velocity of the curve specified at both control points. This curve passes through all control
|
||
points, with the specified velocity which includes direction and parametric speed.</div></li><li><div class="item-name"><a class="struct" href="struct.CubicNurbs.html" title="struct bevy_math::cubic_splines::CubicNurbs">Cubic<wbr>Nurbs</a></div><div class="desc docblock-short">Non-uniform Rational B-Splines (NURBS) are a powerful generalization of the <a href="struct.CubicBSpline.html" title="struct bevy_math::cubic_splines::CubicBSpline"><code>CubicBSpline</code></a> which can
|
||
represent a much more diverse class of curves (like perfect circles and ellipses).</div></li><li><div class="item-name"><a class="struct" href="struct.CubicSegment.html" title="struct bevy_math::cubic_splines::CubicSegment">Cubic<wbr>Segment</a></div><div class="desc docblock-short">A segment of a cubic curve, used to hold precomputed coefficients for fast interpolation.
|
||
It is a <a href="../curve/trait.Curve.html" title="trait bevy_math::curve::Curve"><code>Curve</code></a> with domain <code>[0, 1]</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.InsufficientDataError.html" title="struct bevy_math::cubic_splines::InsufficientDataError">Insufficient<wbr>Data<wbr>Error</a></div><div class="desc docblock-short">An error indicating that a spline construction didn’t have enough control points to generate a curve.</div></li><li><div class="item-name"><a class="struct" href="struct.LinearSpline.html" title="struct bevy_math::cubic_splines::LinearSpline">Linear<wbr>Spline</a></div><div class="desc docblock-short">A spline interpolated linearly between the nearest 2 points.</div></li><li><div class="item-name"><a class="struct" href="struct.RationalCurve.html" title="struct bevy_math::cubic_splines::RationalCurve">Rational<wbr>Curve</a></div><div class="desc docblock-short">A collection of <a href="struct.RationalSegment.html" title="struct bevy_math::cubic_splines::RationalSegment"><code>RationalSegment</code></a>s chained into a single parametric curve. It is a <a href="../curve/trait.Curve.html" title="trait bevy_math::curve::Curve"><code>Curve</code></a>
|
||
with domain <code>[0, N]</code>, where <code>N</code> is the number of segments.</div></li><li><div class="item-name"><a class="struct" href="struct.RationalSegment.html" title="struct bevy_math::cubic_splines::RationalSegment">Rational<wbr>Segment</a></div><div class="desc docblock-short">A segment of a rational cubic curve, used to hold precomputed coefficients for fast interpolation.
|
||
It is a <a href="../curve/trait.Curve.html" title="trait bevy_math::curve::Curve"><code>Curve</code></a> with domain <code>[0, 1]</code>.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.CubicNurbsError.html" title="enum bevy_math::cubic_splines::CubicNurbsError">Cubic<wbr>Nurbs<wbr>Error</a></div><div class="desc docblock-short">Error during construction of <a href="struct.CubicNurbs.html" title="struct bevy_math::cubic_splines::CubicNurbs"><code>CubicNurbs</code></a></div></li></ul><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.CubicGenerator.html" title="trait bevy_math::cubic_splines::CubicGenerator">Cubic<wbr>Generator</a></div><div class="desc docblock-short">Implement this on cubic splines that can generate a cubic curve from their spline parameters.</div></li><li><div class="item-name"><a class="trait" href="trait.CyclicCubicGenerator.html" title="trait bevy_math::cubic_splines::CyclicCubicGenerator">Cyclic<wbr>Cubic<wbr>Generator</a></div><div class="desc docblock-short">Implement this on cubic splines that can generate a cyclic cubic curve from their spline parameters.</div></li><li><div class="item-name"><a class="trait" href="trait.RationalGenerator.html" title="trait bevy_math::cubic_splines::RationalGenerator">Rational<wbr>Generator</a></div><div class="desc docblock-short">Implement this on cubic splines that can generate a rational cubic curve from their spline parameters.</div></li></ul></section></div></main></body></html> |