26 lines
7.3 KiB
HTML
26 lines
7.3 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="The `ShapeSample` trait, allowing random sampling from geometric shapes."><title>bevy_math::sampling::shape_sampling - 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 shape_<wbr>sampling</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="#traits" title="Traits">Traits</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="../index.html">In bevy_<wbr>math::<wbr>sampling</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">sampling</a></span><h1>Module <span>shape_sampling</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/sampling/shape_sampling.rs.html#1-640">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The <a href="trait.ShapeSample.html" title="trait bevy_math::sampling::shape_sampling::ShapeSample"><code>ShapeSample</code></a> trait, allowing random sampling from geometric shapes.</p>
|
|
<p>At the most basic level, this allows sampling random points from the interior and boundary of
|
|
geometric primitives. For example:</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="comment">// Get some `Rng`:
|
|
</span><span class="kw">let </span>rng = <span class="kw-2">&mut </span>StdRng::from_entropy();
|
|
<span class="comment">// Make a circle of radius 2:
|
|
</span><span class="kw">let </span>circle = Circle::new(<span class="number">2.0</span>);
|
|
<span class="comment">// Get a point inside this circle uniformly at random:
|
|
</span><span class="kw">let </span>interior_pt = circle.sample_interior(rng);
|
|
<span class="comment">// Get a point on the circle's boundary uniformly at random:
|
|
</span><span class="kw">let </span>boundary_pt = circle.sample_boundary(rng);</code></pre></div>
|
|
<p>For repeated sampling, <code>ShapeSample</code> also includes methods for accessing a <a href="../../../rand/distributions/distribution/trait.Distribution.html" title="trait rand::distributions::distribution::Distribution"><code>Distribution</code></a>:</p>
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="comment">// Use a rectangle this time:
|
|
</span><span class="kw">let </span>rectangle = Rectangle::new(<span class="number">1.0</span>, <span class="number">2.0</span>);
|
|
<span class="comment">// Get an iterator that spits out random interior points:
|
|
</span><span class="kw">let </span>interior_iter = rectangle.interior_dist().sample_iter(rng1);
|
|
<span class="comment">// Collect random interior points from the iterator:
|
|
</span><span class="kw">let </span>interior_pts: Vec<Vec2> = interior_iter.take(<span class="number">1000</span>).collect();
|
|
<span class="comment">// Similarly, get an iterator over many random boundary points and collect them:
|
|
</span><span class="kw">let </span>boundary_pts: Vec<Vec2> = rectangle.boundary_dist().sample_iter(rng2).take(<span class="number">1000</span>).collect();</code></pre></div>
|
|
<p>In any case, the <a href="../../../rand/rng/trait.Rng.html" title="trait rand::rng::Rng"><code>Rng</code></a> used as the source of randomness must be provided explicitly.</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.BoundaryOf.html" title="struct bevy_math::sampling::shape_sampling::BoundaryOf">Boundary<wbr>Of</a></div><div class="desc docblock-short">A wrapper struct that allows boundary sampling from a <a href="trait.ShapeSample.html" title="trait bevy_math::sampling::shape_sampling::ShapeSample"><code>ShapeSample</code></a> type directly as
|
|
a <a href="../../../rand/distributions/distribution/trait.Distribution.html" title="trait rand::distributions::distribution::Distribution"><code>Distribution</code></a>.</div></li><li><div class="item-name"><a class="struct" href="struct.InteriorOf.html" title="struct bevy_math::sampling::shape_sampling::InteriorOf">Interior<wbr>Of</a></div><div class="desc docblock-short">A wrapper struct that allows interior sampling from a <a href="trait.ShapeSample.html" title="trait bevy_math::sampling::shape_sampling::ShapeSample"><code>ShapeSample</code></a> type directly as
|
|
a <a href="../../../rand/distributions/distribution/trait.Distribution.html" title="trait rand::distributions::distribution::Distribution"><code>Distribution</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.ShapeSample.html" title="trait bevy_math::sampling::shape_sampling::ShapeSample">Shape<wbr>Sample</a></div><div class="desc docblock-short">Exposes methods to uniformly sample a variety of primitive shapes.</div></li></ul></section></div></main></body></html> |