|
|
<!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 `Rotation3` trait in crate `cgmath`."><meta name="keywords" content="rust, rustlang, rust-lang, Rotation3"><title>cgmath::Rotation3 - 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 trait"><!--[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'>Trait Rotation3</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.from_axis_angle">from_axis_angle</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.from_angle_x">from_angle_x</a><a href="#method.from_angle_y">from_angle_y</a><a href="#method.from_angle_z">from_angle_z</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>cgmath</a></p><script>window.sidebarCurrent = {name: 'Rotation3', ty: 'trait', 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/rotation.rs.html#73-98' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='index.html'>cgmath</a>::<wbr><a class="trait" href=''>Rotation3</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait Rotation3<S: <a class="trait" href="../cgmath/trait.BaseFloat.html" title="trait cgmath::BaseFloat">BaseFloat</a>>: <a class="trait" href="../cgmath/prelude/trait.Rotation.html" title="trait cgmath::prelude::Rotation">Rotation</a><<a class="struct" href="../cgmath/struct.Point3.html" title="struct cgmath::Point3">Point3</a><S>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../cgmath/struct.Matrix3.html" title="struct cgmath::Matrix3">Matrix3</a><S>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../cgmath/struct.Basis3.html" title="struct cgmath::Basis3">Basis3</a><S>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../cgmath/struct.Quaternion.html" title="struct cgmath::Quaternion">Quaternion</a><S>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="../cgmath/struct.Euler.html" title="struct cgmath::Euler">Euler</a><<a class="struct" href="../cgmath/struct.Rad.html" title="struct cgmath::Rad">Rad</a><S>>> {
|
|
|
fn <a href='#tymethod.from_axis_angle' class='fnname'>from_axis_angle</a><A: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../cgmath/struct.Rad.html" title="struct cgmath::Rad">Rad</a><S>>>(axis: <a class="struct" href="../cgmath/struct.Vector3.html" title="struct cgmath::Vector3">Vector3</a><S>, angle: A) -> Self;
|
|
|
|
|
|
fn <a href='#method.from_angle_x' class='fnname'>from_angle_x</a><A: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../cgmath/struct.Rad.html" title="struct cgmath::Rad">Rad</a><S>>>(theta: A) -> Self { ... }
|
|
|
<div class='item-spacer'></div> fn <a href='#method.from_angle_y' class='fnname'>from_angle_y</a><A: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../cgmath/struct.Rad.html" title="struct cgmath::Rad">Rad</a><S>>>(theta: A) -> Self { ... }
|
|
|
<div class='item-spacer'></div> fn <a href='#method.from_angle_z' class='fnname'>from_angle_z</a><A: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../cgmath/struct.Rad.html" title="struct cgmath::Rad">Rad</a><S>>>(theta: A) -> Self { ... }
|
|
|
}</pre></div><div class='docblock'><p>A three-dimensional rotation.</p>
|
|
|
</div>
|
|
|
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.from_axis_angle' class='method'><code id='from_axis_angle.v'>fn <a href='#tymethod.from_axis_angle' class='fnname'>from_axis_angle</a><A: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../cgmath/struct.Rad.html" title="struct cgmath::Rad">Rad</a><S>>>(axis: <a class="struct" href="../cgmath/struct.Vector3.html" title="struct cgmath::Vector3">Vector3</a><S>, angle: A) -> Self</code></h3><div class='docblock'><p>Create a rotation using an angle around a given axis.</p>
|
|
|
<p>The specified axis <strong>must be normalized</strong>, or it represents an invalid rotation.</p>
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
<h2 id='provided-methods' class='small-section-header'>Provided methods<a href='#provided-methods' class='anchor'></a></h2><div class='methods'><h3 id='method.from_angle_x' class='method'><code id='from_angle_x.v'>fn <a href='#method.from_angle_x' class='fnname'>from_angle_x</a><A: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../cgmath/struct.Rad.html" title="struct cgmath::Rad">Rad</a><S>>>(theta: A) -> Self</code></h3><div class='docblock'><p>Create a rotation from an angle around the <code>x</code> axis (pitch).</p>
|
|
|
</div><h3 id='method.from_angle_y' class='method'><code id='from_angle_y.v'>fn <a href='#method.from_angle_y' class='fnname'>from_angle_y</a><A: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../cgmath/struct.Rad.html" title="struct cgmath::Rad">Rad</a><S>>>(theta: A) -> Self</code></h3><div class='docblock'><p>Create a rotation from an angle around the <code>y</code> axis (yaw).</p>
|
|
|
</div><h3 id='method.from_angle_z' class='method'><code id='from_angle_z.v'>fn <a href='#method.from_angle_z' class='fnname'>from_angle_z</a><A: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../cgmath/struct.Rad.html" title="struct cgmath::Rad">Rad</a><S>>>(theta: A) -> Self</code></h3><div class='docblock'><p>Create a rotation from an angle around the <code>z</code> axis (roll).</p>
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'><h3 id='impl-Rotation3%3CS%3E' class='impl'><code class='in-band'>impl<S: <a class="trait" href="../cgmath/trait.BaseFloat.html" title="trait cgmath::BaseFloat">BaseFloat</a>> Rotation3<S> for <a class="struct" href="../cgmath/struct.Quaternion.html" title="struct cgmath::Quaternion">Quaternion</a><S></code><a href='#impl-Rotation3%3CS%3E' class='anchor'></a><a class='srclink' href='../src/cgmath/quaternion.rs.html#743-749' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from_axis_angle' class="method hidden"><code id='from_axis_angle.v-1'>fn <a href='#method.from_axis_angle' class='fnname'>from_axis_angle</a><A: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../cgmath/struct.Rad.html" title="struct cgmath::Rad">Rad</a><S>>>(axis: <a class="struct" href="../cgmath/struct.Vector3.html" title="struct cgmath::Vector3">Vector3</a><S>, angle: A) -> <a class="struct" href="../cgmath/struct.Quaternion.html" title="struct cgmath::Quaternion">Quaternion</a><S></code><a class='srclink' href='../src/cgmath/quaternion.rs.html#745-748' title='goto source code'>[src]</a></h4></div><h3 id='impl-Rotation3%3CS%3E-1' class='impl'><code class='in-band'>impl<S: <a class="trait" href="../cgmath/trait.BaseFloat.html" title="trait cgmath::BaseFloat">BaseFloat</a>> Rotation3<S> for <a class="struct" href="../cgmath/struct.Basis3.html" title="struct cgmath::Basis3">Basis3</a><S></code><a href='#impl-Rotation3%3CS%3E-1' class='anchor'></a><a class='srclink' href='../src/cgmath/rotation.rs.html#408-432' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from_axis_angle-1' class="method hidden"><code id='from_axis_angle.v-2'>fn <a href='#method.from_axis_angle-1' class='fnname'>from_axis_angle</a><A: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../cgmath/struct.Rad.html" title="struct cgmath::Rad">Rad</a><S>>>(axis: <a class="struct" href="../cgmath/struct.Vector3.html" title="struct cgmath::Vector3">Vector3</a><S>, angle: A) -> <a class="struct" href="../cgmath/struct.Basis3.html" title="struct cgmath::Basis3">Basis3</a><S></code><a class='srclink' href='../src/cgmath/rotation.rs.html#409-413' title='goto source code'>[src]</a></h4><h4 id='method.from_angle_x-1' class="method hidden"><code id='from_angle_x.v-1'>fn <a href='#method.from_angle_x-1' class='fnname'>from_angle_x</a><A: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../cgmath/struct.Rad.html" title="struct cgmath::Rad">Rad</a><S>>>(theta: A) -> <a class="struct" href="../cgmath/struct.Basis3.html" title="struct cgmath::Basis3">Basis3</a><S></code><a class='srclink' href='../src/cgmath/rotation.rs.html#415-419' title='goto source code'>[src]</a></h4><h4 id='method.from_angle_y-1' class="method hidden"><code id='from_angle_y.v-1'>fn <a href='#method.from_angle_y-1' class='fnname'>from_angle_y</a><A: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../cgmath/struct.Rad.html" title="struct cgmath::Rad">Rad</a><S>>>(theta: A) -> <a class="struct" href="../cgmath/struct.Basis3.html" title="struct cgmath::Basis3">Basis3</a><S></code><a class='srclink' href='../src/cgmath/rotation.rs.html#421-425' title='goto source code'>[src]</a></h4><h4 id='method.from_angle_z-1' class="method hidden"><code id='from_angle_z.v-1'>fn <a href='#method.from_angle_z-1' class='fnname'>from_angle_z</a><A: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><<a class="struct" href="../cgmath/struct.Rad.html" title="struct cgmath::Rad">Rad</a><S>>>(theta: A) -> <a class="struct" href="../cgmath/struct.Basis3.html" title="struct cgmath::Basis3">Basis3</a><S></code><a class='srclink' href='../src/cgmath/rotation.rs.html#427-431' title='goto source code'>[src]</a></h4></div></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
|
|
src="../implementors/cgmath/trait.Rotation3.js">
|
|
|
</script></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> |
