11 lines
12 KiB
HTML
11 lines
12 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="Implement this on cubic splines that can generate a cyclic cubic curve from their spline parameters."><title>CyclicCubicGenerator in 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 trait"><!--[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="#">Cyclic<wbr>Cubic<wbr>Generator</a></h2><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Error" title="Error">Error</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.to_curve_cyclic" title="to_curve_cyclic">to_curve_cyclic</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In bevy_<wbr>math::<wbr>cubic_<wbr>splines</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>::<wbr><a href="index.html">cubic_splines</a></span><h1>Trait <span class="trait">CyclicCubicGenerator</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#891-898">Source</a> </span></div><pre class="rust item-decl"><code>pub trait CyclicCubicGenerator<P: <a class="trait" href="../common_traits/trait.VectorSpace.html" title="trait bevy_math::common_traits::VectorSpace">VectorSpace</a>> {
|
|
type <a href="#associatedtype.Error" class="associatedtype">Error</a>;
|
|
|
|
// Required method
|
|
fn <a href="#tymethod.to_curve_cyclic" class="fn">to_curve_cyclic</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.CubicCurve.html" title="struct bevy_math::cubic_splines::CubicCurve">CubicCurve</a><P>, Self::<a class="associatedtype" href="trait.CyclicCubicGenerator.html#associatedtype.Error" title="type bevy_math::cubic_splines::CyclicCubicGenerator::Error">Error</a>>;
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Implement this on cubic splines that can generate a cyclic cubic curve from their spline parameters.</p>
|
|
<p>This makes sense only when the control data can be interpreted cyclically.</p>
|
|
</div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedtype.Error" class="method"><a class="src rightside" href="../../src/bevy_math/cubic_splines.rs.html#893">Source</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a></h4></section></summary><div class="docblock"><p>An error type indicating why construction might fail.</p>
|
|
</div></details></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.to_curve_cyclic" class="method"><a class="src rightside" href="../../src/bevy_math/cubic_splines.rs.html#897">Source</a><h4 class="code-header">fn <a href="#tymethod.to_curve_cyclic" class="fn">to_curve_cyclic</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="struct.CubicCurve.html" title="struct bevy_math::cubic_splines::CubicCurve">CubicCurve</a><P>, Self::<a class="associatedtype" href="trait.CyclicCubicGenerator.html#associatedtype.Error" title="type bevy_math::cubic_splines::CyclicCubicGenerator::Error">Error</a>></h4></section></summary><div class="docblock"><p>Build a cyclic <a href="struct.CubicCurve.html" title="struct bevy_math::cubic_splines::CubicCurve"><code>CubicCurve</code></a> by computing the interpolation coefficients for each curve segment,
|
|
treating the control data as cyclic so that the result is a closed curve.</p>
|
|
</div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><details class="toggle implementors-toggle"><summary><section id="impl-CyclicCubicGenerator%3CP%3E-for-CubicBSpline%3CP%3E" class="impl"><a class="src rightside" href="../../src/bevy_math/cubic_splines.rs.html#473-499">Source</a><a href="#impl-CyclicCubicGenerator%3CP%3E-for-CubicBSpline%3CP%3E" class="anchor">§</a><h3 class="code-header">impl<P: <a class="trait" href="../common_traits/trait.VectorSpace.html" title="trait bevy_math::common_traits::VectorSpace">VectorSpace</a>> <a class="trait" href="trait.CyclicCubicGenerator.html" title="trait bevy_math::cubic_splines::CyclicCubicGenerator">CyclicCubicGenerator</a><P> for <a class="struct" href="struct.CubicBSpline.html" title="struct bevy_math::cubic_splines::CubicBSpline">CubicBSpline</a><P></h3></section></summary><div class="impl-items"><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="../../src/bevy_math/cubic_splines.rs.html#474">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a> = <a class="struct" href="struct.InsufficientDataError.html" title="struct bevy_math::cubic_splines::InsufficientDataError">InsufficientDataError</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CyclicCubicGenerator%3CP%3E-for-CubicCardinalSpline%3CP%3E" class="impl"><a class="src rightside" href="../../src/bevy_math/cubic_splines.rs.html#338-379">Source</a><a href="#impl-CyclicCubicGenerator%3CP%3E-for-CubicCardinalSpline%3CP%3E" class="anchor">§</a><h3 class="code-header">impl<P: <a class="trait" href="../common_traits/trait.VectorSpace.html" title="trait bevy_math::common_traits::VectorSpace">VectorSpace</a>> <a class="trait" href="trait.CyclicCubicGenerator.html" title="trait bevy_math::cubic_splines::CyclicCubicGenerator">CyclicCubicGenerator</a><P> for <a class="struct" href="struct.CubicCardinalSpline.html" title="struct bevy_math::cubic_splines::CubicCardinalSpline">CubicCardinalSpline</a><P></h3></section></summary><div class="impl-items"><section id="associatedtype.Error-2" class="associatedtype trait-impl"><a class="src rightside" href="../../src/bevy_math/cubic_splines.rs.html#339">Source</a><a href="#associatedtype.Error-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a> = <a class="struct" href="struct.InsufficientDataError.html" title="struct bevy_math::cubic_splines::InsufficientDataError">InsufficientDataError</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CyclicCubicGenerator%3CP%3E-for-CubicHermite%3CP%3E" class="impl"><a class="src rightside" href="../../src/bevy_math/cubic_splines.rs.html#199-223">Source</a><a href="#impl-CyclicCubicGenerator%3CP%3E-for-CubicHermite%3CP%3E" class="anchor">§</a><h3 class="code-header">impl<P: <a class="trait" href="../common_traits/trait.VectorSpace.html" title="trait bevy_math::common_traits::VectorSpace">VectorSpace</a>> <a class="trait" href="trait.CyclicCubicGenerator.html" title="trait bevy_math::cubic_splines::CyclicCubicGenerator">CyclicCubicGenerator</a><P> for <a class="struct" href="struct.CubicHermite.html" title="struct bevy_math::cubic_splines::CubicHermite">CubicHermite</a><P></h3></section></summary><div class="impl-items"><section id="associatedtype.Error-3" class="associatedtype trait-impl"><a class="src rightside" href="../../src/bevy_math/cubic_splines.rs.html#200">Source</a><a href="#associatedtype.Error-3" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a> = <a class="struct" href="struct.InsufficientDataError.html" title="struct bevy_math::cubic_splines::InsufficientDataError">InsufficientDataError</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CyclicCubicGenerator%3CP%3E-for-LinearSpline%3CP%3E" class="impl"><a class="src rightside" href="../../src/bevy_math/cubic_splines.rs.html#846-869">Source</a><a href="#impl-CyclicCubicGenerator%3CP%3E-for-LinearSpline%3CP%3E" class="anchor">§</a><h3 class="code-header">impl<P: <a class="trait" href="../common_traits/trait.VectorSpace.html" title="trait bevy_math::common_traits::VectorSpace">VectorSpace</a>> <a class="trait" href="trait.CyclicCubicGenerator.html" title="trait bevy_math::cubic_splines::CyclicCubicGenerator">CyclicCubicGenerator</a><P> for <a class="struct" href="struct.LinearSpline.html" title="struct bevy_math::cubic_splines::LinearSpline">LinearSpline</a><P></h3></section></summary><div class="impl-items"><section id="associatedtype.Error-4" class="associatedtype trait-impl"><a class="src rightside" href="../../src/bevy_math/cubic_splines.rs.html#847">Source</a><a href="#associatedtype.Error-4" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a> = <a class="struct" href="struct.InsufficientDataError.html" title="struct bevy_math::cubic_splines::InsufficientDataError">InsufficientDataError</a></h4></section></div></details></div><script src="../../trait.impl/bevy_math/cubic_splines/trait.CyclicCubicGenerator.js" async></script></section></div></main></body></html> |