Sophie

Sophie

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

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-attribs">Public Attributes</a>  </div>
  <div class="headertitle">
<h1>playerc_position3d_t Struct Reference<br/>
<small>
[<a class="el" href="group__playerc__proxy__position3d.html">position3d</a>]</small>
</h1>  </div>
</div>
<div class="contents">
<!-- doxytag: class="playerc_position3d_t" -->
<p>Position3d device data.  
<a href="#_details">More...</a></p>

<p><code>#include &lt;<a class="el" href="playerc_8h_source.html">playerc.h</a>&gt;</code></p>

<p><a href="structplayerc__position3d__t-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="struct__playerc__device__t.html">playerc_device_t</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structplayerc__position3d__t.html#a0afaebddbc31fdefe77e606da22ec52d">info</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classDevice.html" title="Encapsulates a device (i.e., a driver bound to an interface).">Device</a> info; must be at the start of all device structures.  <a href="#a0afaebddbc31fdefe77e606da22ec52d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structplayerc__position3d__t.html#a77a1eb674652ef022b99b93e14b4d8c3">pose</a> [3]</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Robot geometry in robot cs: pose gives the position3d and orientation, size gives the extent.  <a href="#a77a1eb674652ef022b99b93e14b4d8c3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a107cf4ff32a1da4693208809c3191be9"></a><!-- doxytag: member="playerc_position3d_t::size" ref="a107cf4ff32a1da4693208809c3191be9" args="[2]" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>size</b> [2]</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structplayerc__position3d__t.html#aa87015a8f76541ee653d06911a30b366">pos_x</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classDevice.html" title="Encapsulates a device (i.e., a driver bound to an interface).">Device</a> position (m).  <a href="#aa87015a8f76541ee653d06911a30b366"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ad9907ac3504a87e3a941bb0f79398052"></a><!-- doxytag: member="playerc_position3d_t::pos_y" ref="ad9907ac3504a87e3a941bb0f79398052" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>pos_y</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4c03907177bb3664b413e6bfc81ff72c"></a><!-- doxytag: member="playerc_position3d_t::pos_z" ref="a4c03907177bb3664b413e6bfc81ff72c" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>pos_z</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structplayerc__position3d__t.html#a591e4cfdb1807f690289d51d0d1e18c5">pos_roll</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight"><a class="el" href="classDevice.html" title="Encapsulates a device (i.e., a driver bound to an interface).">Device</a> orientation (radians).  <a href="#a591e4cfdb1807f690289d51d0d1e18c5"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aee5b9e8dc07ec98743c230b5c2640d1a"></a><!-- doxytag: member="playerc_position3d_t::pos_pitch" ref="aee5b9e8dc07ec98743c230b5c2640d1a" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>pos_pitch</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abc078121743585b895ef09306a5989a2"></a><!-- doxytag: member="playerc_position3d_t::pos_yaw" ref="abc078121743585b895ef09306a5989a2" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>pos_yaw</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structplayerc__position3d__t.html#adb9c2fb28d555f23c30f9d59eb073050">vel_x</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Linear velocity (m/s).  <a href="#adb9c2fb28d555f23c30f9d59eb073050"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a95200dce23d554089e2bf99d65d85ea0"></a><!-- doxytag: member="playerc_position3d_t::vel_y" ref="a95200dce23d554089e2bf99d65d85ea0" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>vel_y</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af8d28a92309e0a07b596e3840c129896"></a><!-- doxytag: member="playerc_position3d_t::vel_z" ref="af8d28a92309e0a07b596e3840c129896" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>vel_z</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">double&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structplayerc__position3d__t.html#a246fcdf0c40d5b8706df582bc830d6a3">vel_roll</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Angular velocity (radians/sec).  <a href="#a246fcdf0c40d5b8706df582bc830d6a3"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a912240e843dc8fd4e05c1bb274a50a6b"></a><!-- doxytag: member="playerc_position3d_t::vel_pitch" ref="a912240e843dc8fd4e05c1bb274a50a6b" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>vel_pitch</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8710a538b26df105a7750bde554d3b55"></a><!-- doxytag: member="playerc_position3d_t::vel_yaw" ref="a8710a538b26df105a7750bde554d3b55" args="" -->
double&nbsp;</td><td class="memItemRight" valign="bottom"><b>vel_yaw</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structplayerc__position3d__t.html#acce4a2ff70bc6c28ba000c6a537a772e">stall</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Stall flag [0, 1].  <a href="#acce4a2ff70bc6c28ba000c6a537a772e"></a><br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Position3d device data. </p>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a0afaebddbc31fdefe77e606da22ec52d"></a><!-- doxytag: member="playerc_position3d_t::info" ref="a0afaebddbc31fdefe77e606da22ec52d" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="struct__playerc__device__t.html">playerc_device_t</a> <a class="el" href="structplayerc__position3d__t.html#a0afaebddbc31fdefe77e606da22ec52d">playerc_position3d_t::info</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p><a class="el" href="classDevice.html" title="Encapsulates a device (i.e., a driver bound to an interface).">Device</a> info; must be at the start of all device structures. </p>

</div>
</div>
<a class="anchor" id="a591e4cfdb1807f690289d51d0d1e18c5"></a><!-- doxytag: member="playerc_position3d_t::pos_roll" ref="a591e4cfdb1807f690289d51d0d1e18c5" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="structplayerc__position3d__t.html#a591e4cfdb1807f690289d51d0d1e18c5">playerc_position3d_t::pos_roll</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p><a class="el" href="classDevice.html" title="Encapsulates a device (i.e., a driver bound to an interface).">Device</a> orientation (radians). </p>

</div>
</div>
<a class="anchor" id="aa87015a8f76541ee653d06911a30b366"></a><!-- doxytag: member="playerc_position3d_t::pos_x" ref="aa87015a8f76541ee653d06911a30b366" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="structplayerc__position3d__t.html#aa87015a8f76541ee653d06911a30b366">playerc_position3d_t::pos_x</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p><a class="el" href="classDevice.html" title="Encapsulates a device (i.e., a driver bound to an interface).">Device</a> position (m). </p>

</div>
</div>
<a class="anchor" id="a77a1eb674652ef022b99b93e14b4d8c3"></a><!-- doxytag: member="playerc_position3d_t::pose" ref="a77a1eb674652ef022b99b93e14b4d8c3" args="[3]" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="structplayerc__position3d__t.html#a77a1eb674652ef022b99b93e14b4d8c3">playerc_position3d_t::pose</a>[3]</td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Robot geometry in robot cs: pose gives the position3d and orientation, size gives the extent. </p>
<p>These values are filled in by <a class="el" href="group__playerc__proxy__position3d.html#ga4a7b4cef5f6a3f5ed21cae5edf252687" title="Get the position3d geometry.">playerc_position3d_get_geom()</a>. </p>

</div>
</div>
<a class="anchor" id="acce4a2ff70bc6c28ba000c6a537a772e"></a><!-- doxytag: member="playerc_position3d_t::stall" ref="acce4a2ff70bc6c28ba000c6a537a772e" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="structplayerc__position3d__t.html#acce4a2ff70bc6c28ba000c6a537a772e">playerc_position3d_t::stall</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Stall flag [0, 1]. </p>

</div>
</div>
<a class="anchor" id="a246fcdf0c40d5b8706df582bc830d6a3"></a><!-- doxytag: member="playerc_position3d_t::vel_roll" ref="a246fcdf0c40d5b8706df582bc830d6a3" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="structplayerc__position3d__t.html#a246fcdf0c40d5b8706df582bc830d6a3">playerc_position3d_t::vel_roll</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Angular velocity (radians/sec). </p>

</div>
</div>
<a class="anchor" id="adb9c2fb28d555f23c30f9d59eb073050"></a><!-- doxytag: member="playerc_position3d_t::vel_x" ref="adb9c2fb28d555f23c30f9d59eb073050" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">double <a class="el" href="structplayerc__position3d__t.html#adb9c2fb28d555f23c30f9d59eb073050">playerc_position3d_t::vel_x</a></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Linear velocity (m/s). </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="playerc_8h_source.html">playerc.h</a></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>