filer/docs/_build/html/types.html

281 lines
11 KiB
HTML

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Types &mdash; MathJS 0.0.1 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '0.0.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<link rel="top" title="MathJS 0.0.1 documentation" href="index.html" />
<link rel="next" title="Operations" href="operations.html" />
<link rel="prev" title="Conventions" href="conventions.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="operations.html" title="Operations"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="conventions.html" title="Conventions"
accesskey="P">previous</a> |</li>
<li><a href="index.html">MathJS 0.0.1 documentation</a> &raquo;</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="types">
<h1>Types<a class="headerlink" href="#types" title="Permalink to this headline"></a></h1>
<div class="section" id="matrix">
<h2>Matrix<a class="headerlink" href="#matrix" title="Permalink to this headline"></a></h2>
<p>Creates a new matrix.</p>
<dl class="class">
<dt id="Matrix">
<em class="property">class </em><tt class="descname">Matrix</tt><big>(</big><em>r</em>, <em>c</em><big>)</big><a class="headerlink" href="#Matrix" title="Permalink to this definition"></a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Arguments:</th><td class="field-body"><ul class="first last simple">
<li><strong>r</strong> (<em>number</em>) &#8211; row dimension</li>
<li><strong>c</strong> (<em>number</em>) &#8211; column dimension</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt>
<em class="property">class </em><tt class="descname">Matrix</tt><big>(</big><em>values</em><big>)</big></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Arguments:</th><td class="field-body"><ul class="first last simple">
<li><strong>values</strong> (<em>Array</em>) &#8211; an array of lists containing initial values, one for each matrix row</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
<div class="section" id="vector">
<h2>Vector<a class="headerlink" href="#vector" title="Permalink to this headline"></a></h2>
<p>Creates a new column vector. A vector is represented by a single-column Matrix.</p>
<dl class="class">
<dt id="Vector">
<em class="property">class </em><tt class="descname">Vector</tt><big>(</big><em>d</em><big>)</big><a class="headerlink" href="#Vector" title="Permalink to this definition"></a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Arguments:</th><td class="field-body"><ul class="first last simple">
<li><strong>d</strong> (<em>number</em>) &#8211; dimension</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
<dl class="class">
<dt>
<em class="property">class </em><tt class="descname">Vector</tt><big>(</big><em>values</em><big>)</big></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Arguments:</th><td class="field-body"><ul class="first last simple">
<li><strong>values</strong> (<em>Array</em>) &#8211; an array of initial values</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
<div class="section" id="transform">
<h2>Transform<a class="headerlink" href="#transform" title="Permalink to this headline"></a></h2>
<p>Creates a new affine transform Matrix. A transform is represented by a <tt class="docutils literal"><span class="pre">d+1</span></tt> square Matrix.</p>
<dl class="class">
<dt id="Transform">
<em class="property">class </em><tt class="descname">Transform</tt><big>(</big><em>d</em><big>)</big><a class="headerlink" href="#Transform" title="Permalink to this definition"></a></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Arguments:</th><td class="field-body"><ul class="first last simple">
<li><strong>d</strong> (<em>number</em>) &#8211; dimension</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
<div class="section" id="quaternion">
<h2>Quaternion<a class="headerlink" href="#quaternion" title="Permalink to this headline"></a></h2>
<p>Creates a new quaternion. A quaternion is represented by a 4-dimensional Vector.</p>
<dl class="class">
<dt id="Quaternion">
<em class="property">class </em><tt class="descname">Quaternion</tt><big>(</big><big>)</big><a class="headerlink" href="#Quaternion" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
<dl class="class">
<dt>
<em class="property">class </em><tt class="descname">Quaternion</tt><big>(</big><em>values</em><big>)</big></dt>
<dd><table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-odd field"><th class="field-name">Arguments:</th><td class="field-body"><ul class="first last simple">
<li><strong>values</strong> (<em>Array</em>) &#8211; an array of initial values</li>
</ul>
</td>
</tr>
</tbody>
</table>
</dd></dl>
</div>
<div class="section" id="frustum">
<h2>Frustum<a class="headerlink" href="#frustum" title="Permalink to this headline"></a></h2>
<p>Creates a new frustum.</p>
<dl class="class">
<dt id="Frustum">
<em class="property">class </em><tt class="descname">Frustum</tt><big>(</big><em>left</em>, <em>right</em>, <em>bottom</em>, <em>top</em>, <em>near</em>, <em>far</em><big>)</big><a class="headerlink" href="#Frustum" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</div>
<div class="section" id="perspective">
<h2>Perspective<a class="headerlink" href="#perspective" title="Permalink to this headline"></a></h2>
<p>Creates a new perspective projection matrix.</p>
<dl class="class">
<dt id="Perspective">
<em class="property">class </em><tt class="descname">Perspective</tt><big>(</big><em>fovy</em>, <em>aspect</em>, <em>near</em>, <em>far</em><big>)</big><a class="headerlink" href="#Perspective" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</div>
<div class="section" id="orthographic">
<h2>Orthographic<a class="headerlink" href="#orthographic" title="Permalink to this headline"></a></h2>
<p>Creates a new orthographic projection matrix.</p>
<dl class="class">
<dt id="Orthographic">
<em class="property">class </em><tt class="descname">Orthographic</tt><big>(</big><em>left</em>, <em>right</em>, <em>bottom</em>, <em>top</em>, <em>near</em>, <em>far</em><big>)</big><a class="headerlink" href="#Orthographic" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</div>
<div class="section" id="lookat">
<h2>LookAt<a class="headerlink" href="#lookat" title="Permalink to this headline"></a></h2>
<p>Creates a new look-at matrix.</p>
<dl class="class">
<dt id="LookAt">
<em class="property">class </em><tt class="descname">LookAt</tt><big>(</big><em>eye</em>, <em>center</em>, <em>up</em><big>)</big><a class="headerlink" href="#LookAt" title="Permalink to this definition"></a></dt>
<dd></dd></dl>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Types</a><ul>
<li><a class="reference internal" href="#matrix">Matrix</a></li>
<li><a class="reference internal" href="#vector">Vector</a></li>
<li><a class="reference internal" href="#transform">Transform</a></li>
<li><a class="reference internal" href="#quaternion">Quaternion</a></li>
<li><a class="reference internal" href="#frustum">Frustum</a></li>
<li><a class="reference internal" href="#perspective">Perspective</a></li>
<li><a class="reference internal" href="#orthographic">Orthographic</a></li>
<li><a class="reference internal" href="#lookat">LookAt</a></li>
</ul>
</li>
</ul>
<h4>Previous topic</h4>
<p class="topless"><a href="conventions.html"
title="previous chapter">Conventions</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="operations.html"
title="next chapter">Operations</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/types.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="operations.html" title="Operations"
>next</a> |</li>
<li class="right" >
<a href="conventions.html" title="Conventions"
>previous</a> |</li>
<li><a href="index.html">MathJS 0.0.1 documentation</a> &raquo;</li>
</ul>
</div>
<div class="footer">
&copy; Copyright 2012, Mozilla Foundation.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>