Sophie

Sophie

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

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="#nested-classes">Classes</a> &#124;
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<h1>simulation<br/>
<small>
[<a class="el" href="group__playerc__proxies.html">Device proxies</a>]</small>
</h1>  </div>
</div>
<div class="contents">

<p>The simulation proxy is used to interact with objects in a simulation.  
<a href="#_details">More...</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct &nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="structplayerc__simulation__t.html">playerc_simulation_t</a></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Simulation device proxy.  <a href="structplayerc__simulation__t.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="func-members"></a>
Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6219752041b36f5f284c7ece1f51c534"></a><!-- doxytag: member="playerc_proxy_simulation::playerc_simulation_create" ref="ga6219752041b36f5f284c7ece1f51c534" args="(playerc_client_t *client, int index)" -->
PLAYERC_EXPORT <br class="typebreak"/>
<a class="el" href="structplayerc__simulation__t.html">playerc_simulation_t</a> *&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__simulation.html#ga6219752041b36f5f284c7ece1f51c534">playerc_simulation_create</a> (<a class="el" href="struct__playerc__client__t.html">playerc_client_t</a> *client, int index)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Create a new simulation proxy. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac5377ef37082e264c0ff1bc6a7d1546b"></a><!-- doxytag: member="playerc_proxy_simulation::playerc_simulation_destroy" ref="gac5377ef37082e264c0ff1bc6a7d1546b" args="(playerc_simulation_t *device)" -->
PLAYERC_EXPORT void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__simulation.html#gac5377ef37082e264c0ff1bc6a7d1546b">playerc_simulation_destroy</a> (<a class="el" href="structplayerc__simulation__t.html">playerc_simulation_t</a> *device)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destroy a simulation proxy. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gab49768754ebd2ce3d6c826974c8fea46"></a><!-- doxytag: member="playerc_proxy_simulation::playerc_simulation_subscribe" ref="gab49768754ebd2ce3d6c826974c8fea46" args="(playerc_simulation_t *device, int access)" -->
PLAYERC_EXPORT int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__simulation.html#gab49768754ebd2ce3d6c826974c8fea46">playerc_simulation_subscribe</a> (<a class="el" href="structplayerc__simulation__t.html">playerc_simulation_t</a> *device, int access)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Subscribe to the simulation device. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga14a07de97eb850786609e165b66e8b90"></a><!-- doxytag: member="playerc_proxy_simulation::playerc_simulation_unsubscribe" ref="ga14a07de97eb850786609e165b66e8b90" args="(playerc_simulation_t *device)" -->
PLAYERC_EXPORT int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__simulation.html#ga14a07de97eb850786609e165b66e8b90">playerc_simulation_unsubscribe</a> (<a class="el" href="structplayerc__simulation__t.html">playerc_simulation_t</a> *device)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Un-subscribe from the simulation device. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga8b1e39ffff49e7d47ec3897ba0af07bf"></a><!-- doxytag: member="playerc_proxy_simulation::playerc_simulation_set_pose2d" ref="ga8b1e39ffff49e7d47ec3897ba0af07bf" args="(playerc_simulation_t *device, char *name, double gx, double gy, double ga)" -->
PLAYERC_EXPORT int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__simulation.html#ga8b1e39ffff49e7d47ec3897ba0af07bf">playerc_simulation_set_pose2d</a> (<a class="el" href="structplayerc__simulation__t.html">playerc_simulation_t</a> *device, char *name, double gx, double gy, double ga)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the 2D pose of a named simulation object. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0470d60566f8f26ed26be542e8917e8f"></a><!-- doxytag: member="playerc_proxy_simulation::playerc_simulation_get_pose2d" ref="ga0470d60566f8f26ed26be542e8917e8f" args="(playerc_simulation_t *device, char *identifier, double *x, double *y, double *a)" -->
PLAYERC_EXPORT int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__simulation.html#ga0470d60566f8f26ed26be542e8917e8f">playerc_simulation_get_pose2d</a> (<a class="el" href="structplayerc__simulation__t.html">playerc_simulation_t</a> *device, char *identifier, double *x, double *y, double *a)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the 2D pose of a named simulation object. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga878cf49681c60a4b149e294a671839d8"></a><!-- doxytag: member="playerc_proxy_simulation::playerc_simulation_set_pose3d" ref="ga878cf49681c60a4b149e294a671839d8" args="(playerc_simulation_t *device, char *name, double gx, double gy, double gz, double groll, double gpitch, double gyaw)" -->
PLAYERC_EXPORT int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__simulation.html#ga878cf49681c60a4b149e294a671839d8">playerc_simulation_set_pose3d</a> (<a class="el" href="structplayerc__simulation__t.html">playerc_simulation_t</a> *device, char *name, double gx, double gy, double gz, double groll, double gpitch, double gyaw)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set the 3D pose of a named simulation object. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga18db18b1fbfb1b94ec896cbfc4be4b14"></a><!-- doxytag: member="playerc_proxy_simulation::playerc_simulation_get_pose3d" ref="ga18db18b1fbfb1b94ec896cbfc4be4b14" args="(playerc_simulation_t *device, char *identifier, double *x, double *y, double *z, double *roll, double *pitch, double *yaw, double *time)" -->
PLAYERC_EXPORT int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__simulation.html#ga18db18b1fbfb1b94ec896cbfc4be4b14">playerc_simulation_get_pose3d</a> (<a class="el" href="structplayerc__simulation__t.html">playerc_simulation_t</a> *device, char *identifier, double *x, double *y, double *z, double *roll, double *pitch, double *yaw, double *time)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get the 3D pose of a named simulation object. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae9d7d1daede913203f5f7193a7e060e3"></a><!-- doxytag: member="playerc_proxy_simulation::playerc_simulation_set_property" ref="gae9d7d1daede913203f5f7193a7e060e3" args="(playerc_simulation_t *device, char *name, char *property, void *value, size_t value_len)" -->
PLAYERC_EXPORT int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__simulation.html#gae9d7d1daede913203f5f7193a7e060e3">playerc_simulation_set_property</a> (<a class="el" href="structplayerc__simulation__t.html">playerc_simulation_t</a> *device, char *name, char *property, void *value, size_t value_len)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Set a property value. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga34ec8c3760158e550acb117cf439cfb5"></a><!-- doxytag: member="playerc_proxy_simulation::playerc_simulation_get_property" ref="ga34ec8c3760158e550acb117cf439cfb5" args="(playerc_simulation_t *device, char *name, char *property, void *value, size_t value_len)" -->
PLAYERC_EXPORT int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__simulation.html#ga34ec8c3760158e550acb117cf439cfb5">playerc_simulation_get_property</a> (<a class="el" href="structplayerc__simulation__t.html">playerc_simulation_t</a> *device, char *name, char *property, void *value, size_t value_len)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Get a property value. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga177682c3245b6fa3114401948bc883ad"></a><!-- doxytag: member="playerc_proxy_simulation::playerc_simulation_pause" ref="ga177682c3245b6fa3114401948bc883ad" args="(playerc_simulation_t *device)" -->
PLAYERC_EXPORT int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__simulation.html#ga177682c3245b6fa3114401948bc883ad">playerc_simulation_pause</a> (<a class="el" href="structplayerc__simulation__t.html">playerc_simulation_t</a> *device)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">pause / unpause the simulation <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7a75b64de6499e9e71f348fd7f0f381b"></a><!-- doxytag: member="playerc_proxy_simulation::playerc_simulation_reset" ref="ga7a75b64de6499e9e71f348fd7f0f381b" args="(playerc_simulation_t *device)" -->
PLAYERC_EXPORT int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__simulation.html#ga7a75b64de6499e9e71f348fd7f0f381b">playerc_simulation_reset</a> (<a class="el" href="structplayerc__simulation__t.html">playerc_simulation_t</a> *device)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">reset the simulation state <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gae9b5ab59b8476dc1664b6eb40a4f960c"></a><!-- doxytag: member="playerc_proxy_simulation::playerc_simulation_save" ref="gae9b5ab59b8476dc1664b6eb40a4f960c" args="(playerc_simulation_t *device)" -->
PLAYERC_EXPORT int&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__playerc__proxy__simulation.html#gae9b5ab59b8476dc1664b6eb40a4f960c">playerc_simulation_save</a> (<a class="el" href="structplayerc__simulation__t.html">playerc_simulation_t</a> *device)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">make the simulation save the status/world <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The simulation proxy is used to interact with objects in a simulation. </p>
<dl class="todo"><dt><b><a class="el" href="todo.html#_todo000049">Todo:</a></b></dt><dd>write playerc_proxy_simulation description</dd></dl>
</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