ceph/src/boost/libs/qvm/doc/Views.html

   1 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
   2 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
   3 <html xmlns='http://www.w3.org/1999/xhtml' xml:lang='en' lang='en'>
   4 <head>
   5         <meta http-equiv='Content-Type' content='text/html; charset=utf-8'/>
   6         <title>Views</title>
   7         <link href='reno.css' type='text/css' rel='stylesheet'/>
   8 </head>
   9 <body>
  10 <div class="body-0">
  11 <div class="body-1">
  12 <div class="body-2">
  13 <div>
  14 <h1>QVM: Quaternions, Vectors, Matrices</h1>
  15 </div>
  16 <!-- Copyright (c) 2008-2016 Emil Dotchevski and Reverge Studios, Inc. -->
  17 <!-- Distributed under the Boost Software License, Version 1.0. (See accompanying -->
  18 <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
  19 <div class="RenoIncludeDIV"><div class="RenoAutoDIV"><h3>Views</h3>
  20 </div>
  21 <p>Boost QVM defines various function templates that provide static mapping between (possibly user-defined) quaternion, vector and matrix types. The example below multiplies column 1 (Boost QVM indexes are always zero-based) of the matrix <i>m</i> by a scalar:</p>
  22 <pre>void multiply_column1( float33 &amp; m, float scalar )
  23 {
  24     <span class="RenoLink"><a href="col.html">col</a></span>&lt;1&gt;(m) <span class="RenoLink"><a href="operator_mul_eq_vec_scalar_.html">*=</a></span> scalar;
  25 }</pre>
  26 <p>The expression <i><span class="RenoLink"><a href="col.html">col</a></span>&lt;1&gt;(m)</i> is a lvalue of an unspecified 3D vector type that refers to column 1 of <i>m</i>. Note however that this does not create any temporary objects; instead <i><span class="RenoLink"><a href="operator_mul_eq_vec_scalar_.html">operator*=</a></span></i> above works directly with a reference to <i>m</i>.</p>
  27 <p>Here is another example, multiplying a transposed view of a matrix by a vector of some user-defined type <i>float3</i>:</p>
  28 <pre>float3 v = {0,0,7};
  29 float3 vrot = <span class="RenoLink"><a href="transposed.html">transposed</a></span>(<span class="RenoLink"><a href="rotx_mat_scalar_.html">rotx_mat</a></span>&lt;3&gt;(3.14159f)) <span class="RenoLink"><a href="operator_times_mat_vec_.html">*</a></span> v;</pre>
  30 <p>In general, the various view functions return references of unspecified, non-copyable types that refer to the original object. They can be assigned from or converted to any compatible vector or matrix type.</p>
  31 <p>For more details, see <span class="RenoLink"><a href="view_proxy.html">View Proxies</a></span>.</p>
  32 </div><div class="RenoIncludeDIV"><div class="RenoHR"><hr/></div>
  33 <p><b>Tutorial navigation:</b> <span class="RenoLink"><a href="quaternions_vectors_matrices.html">Quaternions, Vectors, Matrices</a></span> | <span class="RenoLink"><a href="c_arrays.html">C Arrays</a></span> | <span class="RenoLink">Views</span> | <span class="RenoLink"><a href="Swizzling.html">Swizzling</a></span> | <span class="RenoLink"><a href="Interoperability.html">Interoperability</a></span><span class="RenoBR">&nbsp;</span><br/><span class="RenoBR">&nbsp;</span><br/>See also: <span class="RenoLink"><a href="index.html">Boost QVM</a></span></p>
  34 </div><!-- Copyright (c) 2008-2016 Emil Dotchevski and Reverge Studios, Inc. -->
  35 <!-- Distributed under the Boost Software License, Version 1.0. (See accompanying -->
  36 <!-- file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) -->
  37 <div id="footer">
  38 <p>
  39 <a class="logo" href="http://jigsaw.w3.org/css-validator/check/referer"><img class="logo_pic" src="valid-css.png" alt="Valid CSS" height="31" width="88"/></a>
  40 <a class="logo" href="http://validator.w3.org/check?uri=referer"><img class="logo_pic" src="valid-xhtml.png" alt="Valid XHTML 1.0" height="31" width="88"/></a>
  41 <small>Copyright (c) 2008-2016 by Emil Dotchevski and Reverge Studios, Inc.<br/>
  42 Distributed under the <a href="http://www.boost.org/LICENSE_1_0.txt">Boost Software License, Version 1.0</a>.</small>
  43 </p>
  44 </div>
  45 </div>
  46 </div>
  47 </div>
  48 </body>
  49 </html>