Files
phy/rectangle_pack/index.html
Orion Kindel 0ce894e6b0 doc
2025-03-18 10:30:23 -05:00

3 lines
6.9 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="`rectangle-pack` is a library focused on laying out any number of smaller rectangles (both 2d rectangles and 3d rectangular prisms) inside any number of larger rectangles."><title>rectangle_pack - 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="rectangle_pack" 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="../crates.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 mod crate"><!--[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="../rectangle_pack/index.html">rectangle_<wbr>pack</a><span class="version">0.4.2</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#structs">Crate 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="#functions" title="Functions">Functions</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"></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"><h1>Crate <span>rectangle_pack</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/rectangle_pack/lib.rs.html#1-849">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>rectangle-pack</code> is a library focused on laying out any number of smaller rectangles
(both 2d rectangles and 3d rectangular prisms) inside any number of larger rectangles.</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.BinSection.html" title="struct rectangle_pack::BinSection">BinSection</a></div><div class="desc docblock-short">A rectangular section within a target bin that takes up one or more layers</div></li><li><div class="item-name"><a class="struct" href="struct.GroupedRectsToPlace.html" title="struct rectangle_pack::GroupedRectsToPlace">Grouped<wbr>Rects<wbr>ToPlace</a></div><div class="desc docblock-short">Groups of rectangles that need to be placed into bins.</div></li><li><div class="item-name"><a class="struct" href="struct.PackedLocation.html" title="struct rectangle_pack::PackedLocation">Packed<wbr>Location</a></div><div class="desc docblock-short">Describes how and where an incoming rectangle was packed into the target bins</div></li><li><div class="item-name"><a class="struct" href="struct.RectToInsert.html" title="struct rectangle_pack::RectToInsert">Rect<wbr>ToInsert</a></div><div class="desc docblock-short">A rectangle that we want to insert into a target bin</div></li><li><div class="item-name"><a class="struct" href="struct.RectanglePackOk.html" title="struct rectangle_pack::RectanglePackOk">Rectangle<wbr>Pack<wbr>Ok</a></div><div class="desc docblock-short">Information about successfully packed rectangles.</div></li><li><div class="item-name"><a class="struct" href="struct.TargetBin.html" title="struct rectangle_pack::TargetBin">Target<wbr>Bin</a></div><div class="desc docblock-short">A bin that wed like to play our incoming rectangles into</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.RectanglePackError.html" title="enum rectangle_pack::RectanglePackError">Rectangle<wbr>Pack<wbr>Error</a></div><div class="desc docblock-short">An error while attempting to pack rectangles into bins.</div></li></ul><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.contains_smallest_box.html" title="fn rectangle_pack::contains_smallest_box">contains_<wbr>smallest_<wbr>box</a></div><div class="desc docblock-short">Select the container that has the smallest box.</div></li><li><div class="item-name"><a class="fn" href="fn.pack_rects.html" title="fn rectangle_pack::pack_rects">pack_<wbr>rects</a></div><div class="desc docblock-short">Determine how to fit a set of incoming rectangles (2d or 3d) into a set of target bins.</div></li><li><div class="item-name"><a class="fn" href="fn.volume_heuristic.html" title="fn rectangle_pack::volume_heuristic">volume_<wbr>heuristic</a></div><div class="desc docblock-short">The volume of the box</div></li></ul><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.BoxSizeHeuristicFn.html" title="type rectangle_pack::BoxSizeHeuristicFn">BoxSize<wbr>Heuristic<wbr>Fn</a></div><div class="desc docblock-short">Incoming boxes are places into the smallest hole that will fit them.</div></li><li><div class="item-name"><a class="type" href="type.ComparePotentialContainersFn.html" title="type rectangle_pack::ComparePotentialContainersFn">Compare<wbr>Potential<wbr>Containers<wbr>Fn</a></div><div class="desc docblock-short">Given two sets of containers, which of these is the more suitable for our packing.</div></li></ul></section></div></main></body></html>