TombEngine/doc/classes/Rotation.html

245 lines
5.3 KiB
HTML
Raw Normal View History

2021-08-12 20:16:28 +01:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<head>
<title>Reference</title>
<link rel="stylesheet" href="../ldoc.css" type="text/css" />
</head>
<body>
<div id="container">
<div id="product">
<div id="product_logo"></div>
<div id="product_name"><big><b></b></big></div>
<div id="product_description"></div>
</div> <!-- id="product" -->
<div id="main">
<!-- Menu -->
<div id="navigation">
<br/>
<h1>TombEngine</h1>
<ul>
<li><a href="../index.html">Index</a></li>
</ul>
<h2>Contents</h2>
<ul>
<li><a href="#Members">Members</a></li>
<li><a href="#Functions">Functions</a></li>
<li><a href="#Metamethods">Metamethods</a></li>
</ul>
<h2>Classes</h2>
<ul class="nowrap">
<li><a href="../classes/AIObject.html">AIObject</a></li>
2021-08-15 23:08:05 +01:00
<li><a href="../classes/AudioTrack.html">AudioTrack</a></li>
2021-08-12 20:16:28 +01:00
<li><a href="../classes/CameraInfo.html">CameraInfo</a></li>
<li><a href="../classes/Color.html">Color</a></li>
<li><a href="../classes/InventoryObject.html">InventoryObject</a></li>
<li><a href="../classes/ItemInfo.html">ItemInfo</a></li>
<li><a href="../classes/Level.html">Level</a></li>
<li><a href="../classes/MeshInfo.html">MeshInfo</a></li>
<li><a href="../classes/Mirror.html">Mirror</a></li>
<li><a href="../classes/Position.html">Position</a></li>
<li><strong>Rotation</strong></li>
2021-08-16 12:55:22 +01:00
<li><a href="../classes/Settings.html">Settings</a></li>
2021-08-12 20:16:28 +01:00
<li><a href="../classes/SinkInfo.html">SinkInfo</a></li>
<li><a href="../classes/SkyLayer.html">SkyLayer</a></li>
<li><a href="../classes/SoundSourceInfo.html">SoundSourceInfo</a></li>
<li><a href="../classes/InvItem.html">InvItem</a></li>
<li><a href="../classes/ObjID.html">ObjID</a></li>
</ul>
<h2>Modules</h2>
<ul class="nowrap">
<li><a href="../modules/gameflow.html">gameflow</a></li>
<li><a href="../modules/gamelogic.html">gamelogic</a></li>
</ul>
</div>
<div id="content">
<h1>Class <code>Rotation</code></h1>
<p>Represents a rotation as a combination of individual
angles, in degrees, about each axis.</p>
<p>All values will be clamped to [-32768, 32767].</p>
<h2><a href="#Members">Members</a></h2>
<table class="function_list">
<tr>
<td class="name" ><a href="#Rotation.x">Rotation.x</a></td>
<td class="summary">(int) rotation about x axis</td>
</tr>
<tr>
<td class="name" ><a href="#Rotation.y">Rotation.y</a></td>
<td class="summary">(int) rotation about x axis</td>
</tr>
<tr>
<td class="name" ><a href="#Rotation.z">Rotation.z</a></td>
<td class="summary">(int) rotation about x axis</td>
</tr>
</table>
<h2><a href="#Functions">Functions</a></h2>
<table class="function_list">
<tr>
<td class="name" ><a href="#Rotation.new">Rotation.new (X, Y, Z)</a></td>
<td class="summary">
</td>
</tr>
</table>
<h2><a href="#Metamethods">Metamethods</a></h2>
<table class="function_list">
<tr>
<td class="name" ><a href="#Rotation:__tostring">Rotation:__tostring (rotation)</a></td>
<td class="summary">
</td>
</tr>
</table>
<br/>
<br/>
<h2 class="section-header "><a name="Members"></a>Members</h2>
<dl class="function">
<dt>
<a name = "Rotation.x"></a>
<strong>Rotation.x</strong>
</dt>
<dd>
(int) rotation about x axis
</dd>
<dt>
<a name = "Rotation.y"></a>
<strong>Rotation.y</strong>
</dt>
<dd>
(int) rotation about x axis
</dd>
<dt>
<a name = "Rotation.z"></a>
<strong>Rotation.z</strong>
</dt>
<dd>
(int) rotation about x axis
</dd>
</dl>
<h2 class="section-header "><a name="Functions"></a>Functions</h2>
Methods
<dl class="function">
<dt>
<a name = "Rotation.new"></a>
<strong>Rotation.new (X, Y, Z)</strong>
</dt>
<dd>
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">X</span>
<span class="types"><span class="type">int</span></span>
rotation about x axis
</li>
<li><span class="parameter">Y</span>
<span class="types"><span class="type">int</span></span>
rotation about y axis
</li>
<li><span class="parameter">Z</span>
<span class="types"><span class="type">int</span></span>
rotation about z axis
</li>
</ul>
<h3>Returns:</h3>
<ol>
A Rotation object.
</ol>
</dd>
</dl>
<h2 class="section-header "><a name="Metamethods"></a>Metamethods</h2>
<dl class="function">
<dt>
<a name = "Rotation:__tostring"></a>
<strong>Rotation:__tostring (rotation)</strong>
</dt>
<dd>
<h3>Parameters:</h3>
<ul>
<li><span class="parameter">rotation</span>
<span class="types"><a class="type" href="../classes/Rotation.html#">Rotation</a></span>
this rotation
</li>
</ul>
<h3>Returns:</h3>
<ol>
<span class="types"><a class="type" href="https://www.lua.org/manual/5.3/manual.html#6.4">string</a></span>
A string showing the x, y, and z values of the rotation
</ol>
</dd>
</dl>
</div> <!-- id="content" -->
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
2021-08-16 12:55:22 +01:00
<i style="float:right;">Last updated 2021-08-16 12:53:44 </i>
2021-08-12 20:16:28 +01:00
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
</html>