Sophie

Sophie

distrib > Fedora > 14 > x86_64 > media > updates > by-pkgid > 727fa15453fcace956b835e2377d4269 > files > 158

player-doc-3.0.2-5.fc14.noarch.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
   "http://www.w3.org/TR/html4/strict.dtd">

<html>
<!-- $Id: header.html 8799 2010-06-28 04:12:42Z jpgr87 $ -->

<HEAD>


<meta HTTP-EQUIV="Content-Type" CONTENT="text/html;CHARSET=utf-8">
<meta name="keywords" content="stage, robot, simulation, player, player/stage">
<link href="doxygen.css" rel="stylesheet" type="text/css">

<style type="text/css">

.floatright { float: right; margin: 0 0 1em 1em; }

body {
  font-family: sans-serif;
  #font-family: Geneva, Verdana, Helvetica, Arial, sans-serif;
  background-color: #FFF;
  color:#000;
}


a:link { 
	color: #A00;
}

a:visited { 
	color: #800;
}

a { text-decoration: none; }
a:hover { text-decoration: underline; }


.timestamp { text-align:right; background-color: #DDD; font-size:75%;}

h1 { 
  font-size:160%; 
}

h2 {
  font-size:110%;
  #color: #FFF;
  #background-color: #666;
  #padding:3px;
}

h3 { text-align:left; }

img {
  border: 0;
}

ul.menu { 
    position:relative;
    left:-2.5em;
    margin-bottom:0px;
    margin-top:0px;
}

ul.menu1 { 
    position:relative;
    left:-2.1em;
    margin-bottom:0px;
    margin-top:0px;
}

li.menu { 
    list-style-type: none;
    position:relative;
    #left:-0.5em;
}


#sidebar { position: absolute; left:0px; padding:2em; top:0em; width:12em;}

#content { position: absolute; left:12em; top:0em; padding-left:3em; padding-right:3em; padding-bottom:2em; margin-top:1em; margin-right:2em; }

div.box { background-color:#EEE; border: 1px solid #000; padding: 0.5ex 0.4em 0.5ex 0.6em; margin:1em;  }
div.title { font-weight:bold; background-color:#eee; margin-bottom:2px;}

div.topbar { position: absolute; top:0px; left:9em; margin:1em; }

</style>

<TITLE>Player Manual</TITLE>

</HEAD>

<body>

<div id="sidebar"> 

<h2 style="text-align:center;">
<a href="index.html">
<img width=140 src="http://playerstage.sourceforge.net/images/player_button_v3.png" alt="Player logo"><br></a>
</h2>



<div class="box">
<div class=title>Player</div>

<ul class=menu>
<li class=menu><a href="index.html">Frontpage</a>
<li class=menu><a href="modules.html">Contents</a>
</ul>
</div>

<div class="box">
<div class=title>User</div>

<ul class=menu>
<li class=menu><a href="install.html">Installation</a>
<li class=menu><a href="start.html">Quick start</a>
<li class=menu><a href="supported_hardware.html">Supported&nbsp;devices</a>
<li class=menu><a href="group__tutorials.html">Tutorials</a>
<li class=menu><a href="group__utils.html">Utilities</a>
<li class=menu><a href="group__clientlibs.html">Client&nbsp;libraries</a>
<li class=menu><a href="http://playerstage.sourceforge.net/wiki/Basic_FAQ">FAQ</a>
<li class=menu><a href="help.html">Help</a>

</ul>
</div>

<div class=box>
<div class="title">Developer</div>
<ul class=menu>
<li class=menu><a href="architecture.html">Architecture</a>
<li class=menu><a href="group__libplayercore.html">libplayercore</a>
<ul class=menu1>
<li class=menu><a href="group__interfaces.html">interfaces</a></li>
</ul>
<li class=menu><a href="group__libplayerdrivers.html">libplayerdrivers</a>
<ul class=menu1>
<li class=menu><a href="group__drivers.html">drivers</a></li>
</ul>
<li class=menu><a href="group__libplayercommon.html">libplayercommon</a>
<li class=menu><a href="group__libplayerutils.html">libplayerutils</a>
<li class=menu><a href="group__libplayersd.html">libplayersd</a>
<li class=menu><a href="group__libplayertcp.html">libplayertcp</a>
<li class=menu><a href="group__libplayerxdr.html">libplayerxdr</a>
<li class=menu><a href="todo.html">TODO</a>
</ul>
</div>

<div class=box>
<!-- <a href="http://sourceforge.net"><img border=0 src="http://sourceforge.net/sflogo.php?group_id=42445&type=1"></a> -->
<div class="title">Online</div>
<a href="http://playerstage.sourceforge.net">Homepage</a><br>
<a href="http://sourceforge.net/project/showfiles.php?group_id=42445">Download</a><br>
<a href="http://sourceforge.net/projects/playerstage">Project</a><br>
<a href="http://sourceforge.net/tracker/?group_id=42445">Bugs</a><br>
<a href="http://sourceforge.net/mail/?group_id=42445">Help</a>
</div>


</div>

<div id="content" >
<!-- Generated by Doxygen 1.7.1 -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-methods">Protected Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a>  </div>
  <div class="headertitle">
<h1>KineCalc Class Reference</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="KineCalc" -->
<p><a href="classKineCalc-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae863dcb542429eceaa5019d655fd6fde"></a><!-- doxytag: member="KineCalc::CalculateFK" ref="ae863dcb542429eceaa5019d655fd6fde" args="(const double fromJoints[])" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>CalculateFK</b> (const double fromJoints[])</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae0d1f376f6a8ff42397ce1f1cb27f4e2"></a><!-- doxytag: member="KineCalc::CalculateIK" ref="ae0d1f376f6a8ff42397ce1f1cb27f4e2" args="(const EndEffector &amp;fromPosition)" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>CalculateIK</b> (const <a class="el" href="structEndEffector.html">EndEffector</a> &amp;fromPosition)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67f4d623d2a93d66d0e47d9565efd0be"></a><!-- doxytag: member="KineCalc::GetP" ref="a67f4d623d2a93d66d0e47d9565efd0be" args="(void) const " -->
const <a class="el" href="structKineVector.html">KineVector</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetP</b> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa77aa1b93ce3448b25fe062f4ffe5090"></a><!-- doxytag: member="KineCalc::GetN" ref="aa77aa1b93ce3448b25fe062f4ffe5090" args="(void) const " -->
const <a class="el" href="structKineVector.html">KineVector</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetN</b> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab53d37b5fab732ce3dcd961c57b03023"></a><!-- doxytag: member="KineCalc::GetO" ref="ab53d37b5fab732ce3dcd961c57b03023" args="(void) const " -->
const <a class="el" href="structKineVector.html">KineVector</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetO</b> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acb5a29f4dae7d714776eef82431337e5"></a><!-- doxytag: member="KineCalc::GetA" ref="acb5a29f4dae7d714776eef82431337e5" args="(void) const " -->
const <a class="el" href="structKineVector.html">KineVector</a> &amp;&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetA</b> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a17b17c417c308857aacc77394e9744f4"></a><!-- doxytag: member="KineCalc::SetP" ref="a17b17c417c308857aacc77394e9744f4" args="(const KineVector &amp;newP)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetP</b> (const <a class="el" href="structKineVector.html">KineVector</a> &amp;newP)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa6c0e5d61f07d84fbbd9369e81b257d9"></a><!-- doxytag: member="KineCalc::SetN" ref="aa6c0e5d61f07d84fbbd9369e81b257d9" args="(const KineVector &amp;newN)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetN</b> (const <a class="el" href="structKineVector.html">KineVector</a> &amp;newN)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af0d02fa2e9c38447f010da4275edd088"></a><!-- doxytag: member="KineCalc::SetO" ref="af0d02fa2e9c38447f010da4275edd088" args="(const KineVector &amp;newO)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetO</b> (const <a class="el" href="structKineVector.html">KineVector</a> &amp;newO)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9188add612d670fe22ddb410d204b76a"></a><!-- doxytag: member="KineCalc::SetA" ref="a9188add612d670fe22ddb410d204b76a" args="(const KineVector &amp;newA)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetA</b> (const <a class="el" href="structKineVector.html">KineVector</a> &amp;newA)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a37459db47b33e2b402f437f23615bb87"></a><!-- doxytag: member="KineCalc::SetP" ref="a37459db47b33e2b402f437f23615bb87" args="(double newPX, double newPY, double newPZ)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetP</b> (double newPX, double newPY, double newPZ)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af2d51ae0451c93229df164797c008759"></a><!-- doxytag: member="KineCalc::SetN" ref="af2d51ae0451c93229df164797c008759" args="(double newNX, double newNY, double newNZ)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetN</b> (double newNX, double newNY, double newNZ)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af80a80b21e29ca9063be0fc996f3f513"></a><!-- doxytag: member="KineCalc::SetO" ref="af80a80b21e29ca9063be0fc996f3f513" args="(double newOX, double newOY, double newOZ)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetO</b> (double newOX, double newOY, double newOZ)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa4a9e3ec21ac4e77b9ebfe78ea74cfd9"></a><!-- doxytag: member="KineCalc::SetA" ref="aa4a9e3ec21ac4e77b9ebfe78ea74cfd9" args="(double newAX, double newAY, double newAZ)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetA</b> (double newAX, double newAY, double newAZ)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa7faf6441d67f2f1b258a5c7205daffa"></a><!-- doxytag: member="KineCalc::GetTheta" ref="aa7faf6441d67f2f1b258a5c7205daffa" args="(unsigned int index)" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetTheta</b> (unsigned int index)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a637d0cfaf98c3e196832ad1f758c33f7"></a><!-- doxytag: member="KineCalc::GetThetas" ref="a637d0cfaf98c3e196832ad1f758c33f7" args="(void) const " -->
const double *&nbsp;</td><td class="memItemRight" valign="bottom"><b>GetThetas</b> (void) const </td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa861459f52d511f557a12a232ca2c986"></a><!-- doxytag: member="KineCalc::SetTheta" ref="aa861459f52d511f557a12a232ca2c986" args="(unsigned int index, double newVal)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetTheta</b> (unsigned int index, double newVal)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad4b7b25e197cda618c1560a72832a19a"></a><!-- doxytag: member="KineCalc::SetLinkLengths" ref="ad4b7b25e197cda618c1560a72832a19a" args="(double newLink1, double newLink2, double newLink3, double newLink4, double newLink5)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetLinkLengths</b> (double newLink1, double newLink2, double newLink3, double newLink4, double newLink5)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af493f94eb0f74484fbe7ee28ea89bfd1"></a><!-- doxytag: member="KineCalc::SetOffset" ref="af493f94eb0f74484fbe7ee28ea89bfd1" args="(unsigned int joint, double newOffset)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetOffset</b> (unsigned int joint, double newOffset)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a94f60ab495565112d5404fcf2d529e01"></a><!-- doxytag: member="KineCalc::SetJointRange" ref="a94f60ab495565112d5404fcf2d529e01" args="(unsigned int joint, double min, double max)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>SetJointRange</b> (unsigned int joint, double min, double max)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ace1e3d7041c1b779d7ec29e5d5479c9c"></a><!-- doxytag: member="KineCalc::CalculateN" ref="ace1e3d7041c1b779d7ec29e5d5479c9c" args="(const EndEffector &amp;pose)" -->
<a class="el" href="structKineVector.html">KineVector</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>CalculateN</b> (const <a class="el" href="structEndEffector.html">EndEffector</a> &amp;pose)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae1a88a6d18842aff8b11d5fb30119ec9"></a><!-- doxytag: member="KineCalc::Normalise" ref="ae1a88a6d18842aff8b11d5fb30119ec9" args="(const KineVector &amp;vector)" -->
<a class="el" href="structKineVector.html">KineVector</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>Normalise</b> (const <a class="el" href="structKineVector.html">KineVector</a> &amp;vector)</td></tr>
<tr><td colspan="2"><h2><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a80383a1e65f1f179d2b5ff37070cb2f9"></a><!-- doxytag: member="KineCalc::CalcTheta4and5" ref="a80383a1e65f1f179d2b5ff37070cb2f9" args="(double angles[], const EndEffector &amp;fromPosition)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>CalcTheta4and5</b> (double angles[], const <a class="el" href="structEndEffector.html">EndEffector</a> &amp;fromPosition)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a01629251f7275a39994365303eb699d6"></a><!-- doxytag: member="KineCalc::ChooseSolution" ref="a01629251f7275a39994365303eb699d6" args="(const EndEffector &amp;fromPosition, const double solutions[][5])" -->
int&nbsp;</td><td class="memItemRight" valign="bottom"><b>ChooseSolution</b> (const <a class="el" href="structEndEffector.html">EndEffector</a> &amp;fromPosition, const double solutions[][5])</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad821a661d84d178b1c16641e70a3b3d8"></a><!-- doxytag: member="KineCalc::CalcSolutionError" ref="ad821a661d84d178b1c16641e70a3b3d8" args="(const double solution[], const EndEffector &amp;fromPosition)" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>CalcSolutionError</b> (const double solution[], const <a class="el" href="structEndEffector.html">EndEffector</a> &amp;fromPosition)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a75ee1cd098eed42a37314486a7d5ec96"></a><!-- doxytag: member="KineCalc::CalcFKForJoints" ref="a75ee1cd098eed42a37314486a7d5ec96" args="(const double angles[])" -->
<a class="el" href="structEndEffector.html">EndEffector</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>CalcFKForJoints</b> (const double angles[])</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aba8bcc9800ffdbea710cf6facb853bea"></a><!-- doxytag: member="KineCalc::SolutionInRange" ref="aba8bcc9800ffdbea710cf6facb853bea" args="(const double angles[])" -->
bool&nbsp;</td><td class="memItemRight" valign="bottom"><b>SolutionInRange</b> (const double angles[])</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8786d55a4c5e1f4a8c89ba016693f8b6"></a><!-- doxytag: member="KineCalc::PrintEndEffector" ref="a8786d55a4c5e1f4a8c89ba016693f8b6" args="(const EndEffector &amp;endEffector)" -->
void&nbsp;</td><td class="memItemRight" valign="bottom"><b>PrintEndEffector</b> (const <a class="el" href="structEndEffector.html">EndEffector</a> &amp;endEffector)</td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acca193e9e3cc2ea97b0c486cf9cad30a"></a><!-- doxytag: member="KineCalc::endEffector" ref="acca193e9e3cc2ea97b0c486cf9cad30a" args="" -->
<a class="el" href="structEndEffector.html">EndEffector</a>&nbsp;</td><td class="memItemRight" valign="bottom"><b>endEffector</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a12791496115d402fc865570dd20711e4"></a><!-- doxytag: member="KineCalc::joints" ref="a12791496115d402fc865570dd20711e4" args="[5]" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>joints</b> [5]</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abbc82514ee505f243898f8f217563b43"></a><!-- doxytag: member="KineCalc::jointOffsets" ref="abbc82514ee505f243898f8f217563b43" args="[5]" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>jointOffsets</b> [5]</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adeaf0c29c06b149b937bc8df606584a9"></a><!-- doxytag: member="KineCalc::jointMin" ref="adeaf0c29c06b149b937bc8df606584a9" args="[5]" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>jointMin</b> [5]</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad1870656557495ba2159afbb156e9834"></a><!-- doxytag: member="KineCalc::jointMax" ref="ad1870656557495ba2159afbb156e9834" args="[5]" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>jointMax</b> [5]</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa5f385f320c55bdc710d22b2906ec869"></a><!-- doxytag: member="KineCalc::link1" ref="aa5f385f320c55bdc710d22b2906ec869" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>link1</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5073701c15763a2bf395e51216265de4"></a><!-- doxytag: member="KineCalc::link2" ref="a5073701c15763a2bf395e51216265de4" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>link2</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a178261b5de72cfffbefbc48d3732f755"></a><!-- doxytag: member="KineCalc::link3" ref="a178261b5de72cfffbefbc48d3732f755" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>link3</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab2a7b16822d0fc046927dcb1954ab512"></a><!-- doxytag: member="KineCalc::link4" ref="ab2a7b16822d0fc046927dcb1954ab512" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>link4</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a282feed7eb9591769b1bbfe04116ab5f"></a><!-- doxytag: member="KineCalc::link5" ref="a282feed7eb9591769b1bbfe04116ab5f" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>link5</b></td></tr>
</table>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="kinecalc_8h_source.html">kinecalc.h</a></li>
<li>kinecalc.cc</li>
</ul>
</div>
<!-- render the modification time of the source file -->


<div class="timestamp">
<hr>

<table style="width:100%;">
<tr>
<td style="text-align:left;">
Last updated 12 September 2005 21:38:45
<!--
<td style="text-align:right;">
<a href="http://validator.w3.org/check/referer"><img style="vertical-align:middle;border:0;width:88px;height:31px"
          src="http://www.w3.org/Icons/valid-html401"
          alt="Valid HTML 4.01!"></a>

 <a href="http://jigsaw.w3.org/css-validator/">
  <img style="vertical-align:middle;border:0;width:88px;height:31px"
       src="http://jigsaw.w3.org/css-validator/images/vcss"
       alt="Valid CSS!">
 </a>
-->
</tr>
</table>
</div>


</tr>
</table>

</BODY>
</HTML>

Perl :: Catalyst :: PostgreSQL :: RPM Valid HTML 4.01 Transitional