14 lines
12 KiB
HTML
14 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="API documentation for the Rust `Constraint` trait in crate `example`."><title>Constraint in example::xpbd::constraint - 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="example" 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="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-044be391.svg"></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></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../example/index.html">example</a><span class="version">0.1.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Constraint</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.apply" title="apply">apply</a></li><li><a href="#tymethod.body_idxs" title="body_idxs">body_idxs</a></li><li><a href="#tymethod.init" title="init">init</a></li><li><a href="#tymethod.priority" title="priority">priority</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In example::<wbr>xpbd::<wbr>constraint</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">example</a>::<wbr><a href="../index.html">xpbd</a>::<wbr><a href="index.html">constraint</a></span><h1>Trait <span class="trait">Constraint</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/example/xpbd/constraint/mod.rs.html#14-29">Source</a> </span></div><pre class="rust item-decl"><code>pub trait Constraint: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> {
|
||
// Required methods
|
||
fn <a href="#tymethod.apply" class="fn">apply</a>(&mut self, step: &mut <a class="struct" href="../step/struct.Step.html" title="struct example::xpbd::step::Step">Step</a>);
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.priority" class="fn">priority</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.isize.html">isize</a>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.body_idxs" class="fn">body_idxs</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.84.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>>;
|
||
<span class="item-spacer"></span> fn <a href="#tymethod.init" class="fn">init</a>(&mut self, get_or_insert: impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="struct" href="../../../rapier3d/dynamics/rigid_body_components/struct.RigidBodyHandle.html" title="struct rapier3d::dynamics::rigid_body_components::RigidBodyHandle">RigidBodyHandle</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>);
|
||
}</code></pre><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.apply" class="method"><a class="src rightside" href="../../../src/example/xpbd/constraint/mod.rs.html#16">Source</a><h4 class="code-header">fn <a href="#tymethod.apply" class="fn">apply</a>(&mut self, step: &mut <a class="struct" href="../step/struct.Step.html" title="struct example::xpbd::step::Step">Step</a>)</h4></section></summary><div class="docblock"><p>Apply this constraint, mutating bodies’ next positions.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.priority" class="method"><a class="src rightside" href="../../../src/example/xpbd/constraint/mod.rs.html#19">Source</a><h4 class="code-header">fn <a href="#tymethod.priority" class="fn">priority</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.isize.html">isize</a></h4></section></summary><div class="docblock"><p>Lower values indicate higher priority (0 being highest)</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.body_idxs" class="method"><a class="src rightside" href="../../../src/example/xpbd/constraint/mod.rs.html#24">Source</a><h4 class="code-header">fn <a href="#tymethod.body_idxs" class="fn">body_idxs</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.84.0/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>></h4></section></summary><div class="docblock"><p>Indexes in the body buffer that this constraint
|
||
will mutate. This is used to group mutually exclusive
|
||
constraints to be evaluated in parallel.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.init" class="method"><a class="src rightside" href="../../../src/example/xpbd/constraint/mod.rs.html#28">Source</a><h4 class="code-header">fn <a href="#tymethod.init" class="fn">init</a>(&mut self, get_or_insert: impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="struct" href="../../../rapier3d/dynamics/rigid_body_components/struct.RigidBodyHandle.html" title="struct rapier3d::dynamics::rigid_body_components::RigidBodyHandle">RigidBodyHandle</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>)</h4></section></summary><div class="docblock"><p>Initialize the constraint with the ability to map rigid body handles
|
||
to indices in the <code>bodies</code> buffer passed to <code>apply</code>.</p>
|
||
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.84.0/reference/items/traits.html#object-safety">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-Constraint-for-Constraint" class="impl"><a class="src rightside" href="../../../src/example/xpbd/constraint/impl_/mod.rs.html#181-225">Source</a><a href="#impl-Constraint-for-Constraint" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Constraint.html" title="trait example::xpbd::constraint::Constraint">Constraint</a> for <a class="enum" href="impl_/enum.Constraint.html" title="enum example::xpbd::constraint::impl_::Constraint">Constraint</a></h3></section><section id="impl-Constraint-for-Contact" class="impl"><a class="src rightside" href="../../../src/example/xpbd/constraint/impl_/contact.rs.html#53-68">Source</a><a href="#impl-Constraint-for-Contact" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Constraint.html" title="trait example::xpbd::constraint::Constraint">Constraint</a> for <a class="struct" href="impl_/contact/struct.Contact.html" title="struct example::xpbd::constraint::impl_::contact::Contact">Contact</a></h3></section><section id="impl-Constraint-for-Packed" class="impl"><a class="src rightside" href="../../../src/example/xpbd/constraint/impl_/distance.rs.html#64-103">Source</a><a href="#impl-Constraint-for-Packed" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Constraint.html" title="trait example::xpbd::constraint::Constraint">Constraint</a> for example::xpbd::constraint::impl_::distance::<a class="struct" href="impl_/distance/struct.Packed.html" title="struct example::xpbd::constraint::impl_::distance::Packed">Packed</a></h3></section><section id="impl-Constraint-for-Single" class="impl"><a class="src rightside" href="../../../src/example/xpbd/constraint/impl_/distance.rs.html#137-171">Source</a><a href="#impl-Constraint-for-Single" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Constraint.html" title="trait example::xpbd::constraint::Constraint">Constraint</a> for example::xpbd::constraint::impl_::distance::<a class="struct" href="impl_/distance/struct.Single.html" title="struct example::xpbd::constraint::impl_::distance::Single">Single</a></h3></section><section id="impl-Constraint-for-Packed-1" class="impl"><a class="src rightside" href="../../../src/example/xpbd/constraint/impl_/tetrahedron_volume.rs.html#134-183">Source</a><a href="#impl-Constraint-for-Packed-1" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Constraint.html" title="trait example::xpbd::constraint::Constraint">Constraint</a> for example::xpbd::constraint::impl_::tetrahedron_volume::<a class="struct" href="impl_/tetrahedron_volume/struct.Packed.html" title="struct example::xpbd::constraint::impl_::tetrahedron_volume::Packed">Packed</a></h3></section><section id="impl-Constraint-for-Single-1" class="impl"><a class="src rightside" href="../../../src/example/xpbd/constraint/impl_/tetrahedron_volume.rs.html#55-99">Source</a><a href="#impl-Constraint-for-Single-1" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.Constraint.html" title="trait example::xpbd::constraint::Constraint">Constraint</a> for example::xpbd::constraint::impl_::tetrahedron_volume::<a class="struct" href="impl_/tetrahedron_volume/struct.Single.html" title="struct example::xpbd::constraint::impl_::tetrahedron_volume::Single">Single</a></h3></section></div><script src="../../../trait.impl/example/xpbd/constraint/trait.Constraint.js" async></script></section></div></main></body></html> |