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

3 lines
15 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="Shapes supported by parry."><title>parry3d::shape - 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="parry3d" 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 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></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../parry3d/index.html">parry3d</a><span class="version">0.18.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module shape</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><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate parry3d</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">parry3d</a></span><h1>Module <span>shape</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/parry3d/shape/mod.rs.html#1-124">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Shapes supported by parry.</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.Ball.html" title="struct parry3d::shape::Ball">Ball</a></div><div class="desc docblock-short">A Ball shape.</div></li><li><div class="item-name"><a class="struct" href="struct.Capsule.html" title="struct parry3d::shape::Capsule">Capsule</a></div><div class="desc docblock-short">A capsule shape defined as a round segment.</div></li><li><div class="item-name"><a class="struct" href="struct.Compound.html" title="struct parry3d::shape::Compound">Compound</a></div><div class="desc docblock-short">A compound shape with an aabb bounding volume.</div></li><li><div class="item-name"><a class="struct" href="struct.Cone.html" title="struct parry3d::shape::Cone">Cone</a></div><div class="desc docblock-short">Cone shape with its principal axis aligned with the <code>y</code> axis.</div></li><li><div class="item-name"><a class="struct" href="struct.ConvexPolyhedron.html" title="struct parry3d::shape::ConvexPolyhedron">Convex<wbr>Polyhedron</a></div><div class="desc docblock-short">A convex polyhedron without degenerate faces.</div></li><li><div class="item-name"><a class="struct" href="struct.Cuboid.html" title="struct parry3d::shape::Cuboid">Cuboid</a></div><div class="desc docblock-short">Shape of a box.</div></li><li><div class="item-name"><a class="struct" href="struct.Cylinder.html" title="struct parry3d::shape::Cylinder">Cylinder</a></div><div class="desc docblock-short">Cylinder shape with its principal axis aligned with the <code>y</code> axis.</div></li><li><div class="item-name"><a class="struct" href="struct.HalfSpace.html" title="struct parry3d::shape::HalfSpace">Half<wbr>Space</a></div><div class="desc docblock-short">A half-space delimited by an infinite plane.</div></li><li><div class="item-name"><a class="struct" href="struct.HeightField.html" title="struct parry3d::shape::HeightField">Height<wbr>Field</a></div><div class="desc docblock-short">A 3D heightfield.</div></li><li><div class="item-name"><a class="struct" href="struct.HeightFieldCellStatus.html" title="struct parry3d::shape::HeightFieldCellStatus">Height<wbr>Field<wbr>Cell<wbr>Status</a></div><div class="desc docblock-short">The status of the cell of an heightfield.</div></li><li><div class="item-name"><a class="struct" href="struct.HeightFieldFlags.html" title="struct parry3d::shape::HeightFieldFlags">Height<wbr>Field<wbr>Flags</a></div><div class="desc docblock-short">Flags controlling the behavior of some operations involving heightfields.</div></li><li><div class="item-name"><a class="struct" href="struct.HeightFieldRadialTriangles.html" title="struct parry3d::shape::HeightFieldRadialTriangles">Height<wbr>Field<wbr>Radial<wbr>Triangles</a></div><div class="desc docblock-short">An iterator through all the triangles around the given point, after vertical projection on the heightfield.</div></li><li><div class="item-name"><a class="struct" href="struct.PackedFeatureId.html" title="struct parry3d::shape::PackedFeatureId">Packed<wbr>Feature<wbr>Id</a></div><div class="desc docblock-short">A feature id where the feature type is packed into the same value as the feature index.</div></li><li><div class="item-name"><a class="struct" href="struct.PolygonalFeature.html" title="struct parry3d::shape::PolygonalFeature">Polygonal<wbr>Feature</a></div><div class="desc docblock-short">A polygonal feature representing the local polygonal approximation of
a vertex, face, or edge of a convex shape.</div></li><li><div class="item-name"><a class="struct" href="struct.Polyline.html" title="struct parry3d::shape::Polyline">Polyline</a></div><div class="desc docblock-short">A polyline.</div></li><li><div class="item-name"><a class="struct" href="struct.RoundShape.html" title="struct parry3d::shape::RoundShape">Round<wbr>Shape</a></div><div class="desc docblock-short">A shape with rounded borders.</div></li><li><div class="item-name"><a class="struct" href="struct.Segment.html" title="struct parry3d::shape::Segment">Segment</a></div><div class="desc docblock-short">A segment shape.</div></li><li><div class="item-name"><a class="struct" href="struct.SharedShape.html" title="struct parry3d::shape::SharedShape">Shared<wbr>Shape</a></div><div class="desc docblock-short">The shape of a collider.</div></li><li><div class="item-name"><a class="struct" href="struct.Tetrahedron.html" title="struct parry3d::shape::Tetrahedron">Tetrahedron</a></div><div class="desc docblock-short">A tetrahedron with 4 vertices.</div></li><li><div class="item-name"><a class="struct" href="struct.TopoFace.html" title="struct parry3d::shape::TopoFace">Topo<wbr>Face</a></div><div class="desc docblock-short">A face of a triangle-meshs half-edge topology.</div></li><li><div class="item-name"><a class="struct" href="struct.TopoHalfEdge.html" title="struct parry3d::shape::TopoHalfEdge">Topo<wbr>Half<wbr>Edge</a></div><div class="desc docblock-short">A half-edge of a triangle-meshs half-edge topology.</div></li><li><div class="item-name"><a class="struct" href="struct.TopoVertex.html" title="struct parry3d::shape::TopoVertex">Topo<wbr>Vertex</a></div><div class="desc docblock-short">A vertex of a triangle-meshs half-edge topology.</div></li><li><div class="item-name"><a class="struct" href="struct.TriMesh.html" title="struct parry3d::shape::TriMesh">TriMesh</a></div><div class="desc docblock-short">A triangle mesh.</div></li><li><div class="item-name"><a class="struct" href="struct.TriMeshConnectedComponents.html" title="struct parry3d::shape::TriMeshConnectedComponents">TriMesh<wbr>Connected<wbr>Components</a></div><div class="desc docblock-short">The connected-components of a triangle mesh.</div></li><li><div class="item-name"><a class="struct" href="struct.TriMeshFlags.html" title="struct parry3d::shape::TriMeshFlags">TriMesh<wbr>Flags</a></div><div class="desc docblock-short">The status of the cell of an heightfield.</div></li><li><div class="item-name"><a class="struct" href="struct.TriMeshPseudoNormals.html" title="struct parry3d::shape::TriMeshPseudoNormals">TriMesh<wbr>Pseudo<wbr>Normals</a></div><div class="desc docblock-short">The set of pseudo-normals of a triangle mesh.</div></li><li><div class="item-name"><a class="struct" href="struct.TriMeshTopology.html" title="struct parry3d::shape::TriMeshTopology">TriMesh<wbr>Topology</a></div><div class="desc docblock-short">The half-edge topology information of a triangle mesh.</div></li><li><div class="item-name"><a class="struct" href="struct.Triangle.html" title="struct parry3d::shape::Triangle">Triangle</a></div><div class="desc docblock-short">A triangle shape.</div></li><li><div class="item-name"><a class="struct" href="struct.TrianglePseudoNormals.html" title="struct parry3d::shape::TrianglePseudoNormals">Triangle<wbr>Pseudo<wbr>Normals</a></div><div class="desc docblock-short">The pseudo-normals of a triangle providing approximations of its features normal cones.</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.FeatureId.html" title="enum parry3d::shape::FeatureId">Feature<wbr>Id</a></div><div class="desc docblock-short">An identifier of a feature of a convex polyhedron.</div></li><li><div class="item-name"><a class="enum" href="enum.SegmentPointLocation.html" title="enum parry3d::shape::SegmentPointLocation">Segment<wbr>Point<wbr>Location</a></div><div class="desc docblock-short">Logical description of the location of a point on a triangle.</div></li><li><div class="item-name"><a class="enum" href="enum.ShapeType.html" title="enum parry3d::shape::ShapeType">Shape<wbr>Type</a></div><div class="desc docblock-short">Enum representing the type of a shape.</div></li><li><div class="item-name"><a class="enum" href="enum.TetrahedronPointLocation.html" title="enum parry3d::shape::TetrahedronPointLocation">Tetrahedron<wbr>Point<wbr>Location</a></div><div class="desc docblock-short">Logical description of the location of a point on a triangle.</div></li><li><div class="item-name"><a class="enum" href="enum.TopologyError.html" title="enum parry3d::shape::TopologyError">Topology<wbr>Error</a></div><div class="desc docblock-short">Indicated an inconsistency in the topology of a triangle mesh.</div></li><li><div class="item-name"><a class="enum" href="enum.TriMeshBuilderError.html" title="enum parry3d::shape::TriMeshBuilderError">TriMesh<wbr>Builder<wbr>Error</a></div><div class="desc docblock-short">Indicated an inconsistency while building a triangle mesh.</div></li><li><div class="item-name"><a class="enum" href="enum.TriangleOrientation.html" title="enum parry3d::shape::TriangleOrientation">Triangle<wbr>Orientation</a></div><div class="desc docblock-short">Orientation of a triangle.</div></li><li><div class="item-name"><a class="enum" href="enum.TrianglePointLocation.html" title="enum parry3d::shape::TrianglePointLocation">Triangle<wbr>Point<wbr>Location</a></div><div class="desc docblock-short">Description of the location of a point on a triangle.</div></li><li><div class="item-name"><a class="enum" href="enum.TypedShape.html" title="enum parry3d::shape::TypedShape">Typed<wbr>Shape</a></div><div class="desc docblock-short">Enum representing the shape with its actual type</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.PolygonalFeatureMap.html" title="trait parry3d::shape::PolygonalFeatureMap">Polygonal<wbr>Feature<wbr>Map</a></div><div class="desc docblock-short">Trait implemented by convex shapes with features with polyhedral approximations.</div></li><li><div class="item-name"><a class="trait" href="trait.Shape.html" title="trait parry3d::shape::Shape">Shape</a></div><div class="desc docblock-short">Trait implemented by shapes usable by Rapier.</div></li><li><div class="item-name"><a class="trait" href="trait.SimdCompositeShape.html" title="trait parry3d::shape::SimdCompositeShape">Simd<wbr>Composite<wbr>Shape</a></div><div class="desc docblock-short">Trait implemented by shapes composed of multiple simpler shapes.</div></li><li><div class="item-name"><a class="trait" href="trait.SupportMap.html" title="trait parry3d::shape::SupportMap">Support<wbr>Map</a></div><div class="desc docblock-short">Traits of convex shapes representable by a support mapping function.</div></li><li><div class="item-name"><a class="trait" href="trait.TypedSimdCompositeShape.html" title="trait parry3d::shape::TypedSimdCompositeShape">Typed<wbr>Simd<wbr>Composite<wbr>Shape</a></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.RoundCone.html" title="type parry3d::shape::RoundCone">Round<wbr>Cone</a></div><div class="desc docblock-short">A cone dilated by a sphere (so it has round corners).</div></li><li><div class="item-name"><a class="type" href="type.RoundConvexPolyhedron.html" title="type parry3d::shape::RoundConvexPolyhedron">Round<wbr>Convex<wbr>Polyhedron</a></div><div class="desc docblock-short">A convex polyhedron dilated by a sphere (so it has round corners).</div></li><li><div class="item-name"><a class="type" href="type.RoundCuboid.html" title="type parry3d::shape::RoundCuboid">Round<wbr>Cuboid</a></div><div class="desc docblock-short">A cuboid dilated by a sphere (so it has round corners).</div></li><li><div class="item-name"><a class="type" href="type.RoundCylinder.html" title="type parry3d::shape::RoundCylinder">Round<wbr>Cylinder</a></div><div class="desc docblock-short">A cylinder dilated by a sphere (so it has round corners).</div></li><li><div class="item-name"><a class="type" href="type.RoundTriangle.html" title="type parry3d::shape::RoundTriangle">Round<wbr>Triangle</a></div><div class="desc docblock-short">A triangle dilated by a sphere (so it has round corners).</div></li></ul></section></div></main></body></html>