|
|
<!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 `prelude` mod in crate `cgmath`."><meta name="keywords" content="rust, rustlang, rust-lang, prelude"><title>cgmath::prelude - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="../../favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../cgmath/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Module prelude</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#traits">Traits</a></li></ul></div><p class='location'><a href='../index.html'>cgmath</a></p><script>window.sidebarCurrent = {name: 'prelude', ty: 'mod', relpath: '../'};</script><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../../src/cgmath/prelude.rs.html#1-13' title='goto source code'>[src]</a></span><span class='in-band'>Module <a href='../index.html'>cgmath</a>::<wbr><a class="mod" href=''>prelude</a></span></h1><div class='docblock'><p>This module contains the most common traits used in <code>cgmath</code>. By
|
|
|
glob-importing this module, you can avoid the need to import each trait
|
|
|
individually, while still being selective about what types you import.</p>
|
|
|
</div><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="trait" href="trait.Angle.html" title='cgmath::prelude::Angle trait'>Angle</a></td><td class='docblock-short'><p>Angles and their associated trigonometric functions.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="trait" href="trait.Array.html" title='cgmath::prelude::Array trait'>Array</a></td><td class='docblock-short'><p>An array containing elements of type <code>Element</code></p>
|
|
|
</td></tr><tr class='module-item'><td><a class="trait" href="trait.Bounded.html" title='cgmath::prelude::Bounded trait'>Bounded</a></td><td class='docblock-short'><p>Numbers which have upper and lower bounds</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="trait" href="trait.ElementWise.html" title='cgmath::prelude::ElementWise trait'>ElementWise</a></td><td class='docblock-short'><p>Element-wise arithmetic operations. These are supplied for pragmatic
|
|
|
reasons, but will usually fall outside of traditional algebraic properties.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="trait" href="trait.EuclideanSpace.html" title='cgmath::prelude::EuclideanSpace trait'>EuclideanSpace</a></td><td class='docblock-short'><p>Points in a <a href="https://en.wikipedia.org/wiki/Euclidean_space">Euclidean space</a>
|
|
|
with an associated space of displacement vectors.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="trait" href="trait.InnerSpace.html" title='cgmath::prelude::InnerSpace trait'>InnerSpace</a></td><td class='docblock-short'><p>Vectors that also have a <a href="https://en.wikipedia.org/wiki/Dot_product">dot</a>
|
|
|
(or <a href="https://en.wikipedia.org/wiki/Inner_product_space">inner</a>) product.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="trait" href="trait.Matrix.html" title='cgmath::prelude::Matrix trait'>Matrix</a></td><td class='docblock-short'><p>A column-major matrix of arbitrary dimensions.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="trait" href="trait.MetricSpace.html" title='cgmath::prelude::MetricSpace trait'>MetricSpace</a></td><td class='docblock-short'><p>A type with a distance function between values.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="trait" href="trait.One.html" title='cgmath::prelude::One trait'>One</a></td><td class='docblock-short'><p>Defines a multiplicative identity element for <code>Self</code>.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="trait" href="trait.Rotation.html" title='cgmath::prelude::Rotation trait'>Rotation</a></td><td class='docblock-short'><p>A trait for a generic rotation. A rotation is a transformation that
|
|
|
creates a circular motion, and preserves at least one point in the space.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="trait" href="trait.Rotation2.html" title='cgmath::prelude::Rotation2 trait'>Rotation2</a></td><td class='docblock-short'><p>A two-dimensional rotation.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="trait" href="trait.Rotation3.html" title='cgmath::prelude::Rotation3 trait'>Rotation3</a></td><td class='docblock-short'><p>A three-dimensional rotation.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="trait" href="trait.SquareMatrix.html" title='cgmath::prelude::SquareMatrix trait'>SquareMatrix</a></td><td class='docblock-short'><p>A column-major major matrix where the rows and column vectors are of the same dimensions.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="trait" href="trait.Transform.html" title='cgmath::prelude::Transform trait'>Transform</a></td><td class='docblock-short'><p>A trait representing an <a href="https://en.wikipedia.org/wiki/Affine_transformation">affine
|
|
|
transformation</a> that
|
|
|
can be applied to points or vectors. An affine transformation is one which</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="trait" href="trait.Transform2.html" title='cgmath::prelude::Transform2 trait'>Transform2</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="trait" href="trait.Transform3.html" title='cgmath::prelude::Transform3 trait'>Transform3</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="trait" href="trait.VectorSpace.html" title='cgmath::prelude::VectorSpace trait'>VectorSpace</a></td><td class='docblock-short'><p>Vectors that can be <a href="http://mathworld.wolfram.com/VectorAddition.html">added</a>
|
|
|
together and <a href="https://en.wikipedia.org/wiki/Scalar_multiplication">multiplied</a>
|
|
|
by scalars.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="trait" href="trait.Zero.html" title='cgmath::prelude::Zero trait'>Zero</a></td><td class='docblock-short'><p>Defines an additive identity element for <code>Self</code>.</p>
|
|
|
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "cgmath";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |
