<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>libQGLViewer: WorldConstraint Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link rel="shortcut icon" href="../images/qglviewer.ico" type="image/x-icon" /><link rel="icon" href="../images/qglviewer.icon.png" type="image/png" />
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.5 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="../index.html"><span>Main Page</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label> <u>S</u>earch for </label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul>
</div>
</div>
</div>
<div class="contents">
<h1>WorldConstraint Class Reference</h1><!-- doxytag: class="qglviewer::WorldConstraint" --><!-- doxytag: inherits="qglviewer::AxisPlaneConstraint" -->An <a class="el" href="classqglviewer_1_1AxisPlaneConstraint.html" title="An abstract class for Frame Constraints defined by an axis or a plane.">AxisPlaneConstraint</a> defined in the world coordinate system.
<a href="#_details">More...</a>
<p>
Inherits <a class="el" href="classqglviewer_1_1AxisPlaneConstraint.html">AxisPlaneConstraint</a>.
<p>
<p>
<a href="classqglviewer_1_1WorldConstraint-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classqglviewer_1_1WorldConstraint.html#150934716deed3fda4d4121307d17fd0">~WorldConstraint</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classqglviewer_1_1WorldConstraint.html#dc695bfbc605b5631be663b28a4ea9f6">constrainTranslation</a> (<a class="el" href="classqglviewer_1_1Vec.html">Vec</a> &translation, <a class="el" href="classqglviewer_1_1Frame.html">Frame</a> *const frame)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="classqglviewer_1_1WorldConstraint.html#71c099a2c356f715f8bf34052875cd25">constrainRotation</a> (<a class="el" href="classqglviewer_1_1Quaternion.html">Quaternion</a> &rotation, <a class="el" href="classqglviewer_1_1Frame.html">Frame</a> *const frame)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
An <a class="el" href="classqglviewer_1_1AxisPlaneConstraint.html" title="An abstract class for Frame Constraints defined by an axis or a plane.">AxisPlaneConstraint</a> defined in the world coordinate system.
<p>
The <a class="el" href="classqglviewer_1_1AxisPlaneConstraint.html#431b0d36842122de9db3b4e4f00b8d7c">translationConstraintDirection()</a> and <a class="el" href="classqglviewer_1_1AxisPlaneConstraint.html#f982989dbeb2e0e63c85eecc09bd88d7">rotationConstraintDirection()</a> are expressed in world coordinate system.<p>
See the <a href="../examples/constrainedFrame.html">constrainedFrame</a> and <a href="../examples/multiView.html">multiView</a> examples for an illustration. <hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="150934716deed3fda4d4121307d17fd0"></a><!-- doxytag: member="qglviewer::WorldConstraint::~WorldConstraint" ref="150934716deed3fda4d4121307d17fd0" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual ~WorldConstraint </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Virtual destructor. Empty.
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="dc695bfbc605b5631be663b28a4ea9f6"></a><!-- doxytag: member="qglviewer::WorldConstraint::constrainTranslation" ref="dc695bfbc605b5631be663b28a4ea9f6" args="(Vec &translation, Frame *const frame)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void constrainTranslation </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classqglviewer_1_1Vec.html">Vec</a> & </td>
<td class="paramname"> <em>translation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classqglviewer_1_1Frame.html">Frame</a> *const </td>
<td class="paramname"> <em>frame</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Depending on <a class="el" href="classqglviewer_1_1AxisPlaneConstraint.html#12ad675910ffa86fbabefff2cd6a594a">translationConstraintType()</a>, constrain <code>translation</code> to be along an axis or limited to a plane defined in the world coordinate system by <a class="el" href="classqglviewer_1_1AxisPlaneConstraint.html#431b0d36842122de9db3b4e4f00b8d7c">translationConstraintDirection()</a>.
<p>Reimplemented from <a class="el" href="classqglviewer_1_1AxisPlaneConstraint.html#b7d724965c6765209f47c1abe7f7b7b4">AxisPlaneConstraint</a>.</p>
</div>
</div><p>
<a class="anchor" name="71c099a2c356f715f8bf34052875cd25"></a><!-- doxytag: member="qglviewer::WorldConstraint::constrainRotation" ref="71c099a2c356f715f8bf34052875cd25" args="(Quaternion &rotation, Frame *const frame)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void constrainRotation </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classqglviewer_1_1Quaternion.html">Quaternion</a> & </td>
<td class="paramname"> <em>rotation</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="classqglviewer_1_1Frame.html">Frame</a> *const </td>
<td class="paramname"> <em>frame</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
When <a class="el" href="classqglviewer_1_1AxisPlaneConstraint.html#61a05b9e18948b2b787e355c90b7b85f">rotationConstraintType()</a> is <a class="el" href="classqglviewer_1_1AxisPlaneConstraint.html#1d1cfd8ffb84e947f82999c682b666a71ad785f7d0b0b3a5a52cdd4385785a6b">AxisPlaneConstraint::AXIS</a>, constrain <code>rotation</code> to be a rotation around an axis whose direction is defined in the world coordinate system by <a class="el" href="classqglviewer_1_1AxisPlaneConstraint.html#f982989dbeb2e0e63c85eecc09bd88d7">rotationConstraintDirection()</a>.
<p>Reimplemented from <a class="el" href="classqglviewer_1_1AxisPlaneConstraint.html#5de5f38e75b58476b7926171dba4b31b">AxisPlaneConstraint</a>.</p>
</div>
</div><p>
</div>
<hr size="1"><address style="text-align: right;"><small>libQGLViewer 2.3.1 documentation generated by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.5 </small></address>
</body>
</html>
