<!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 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 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> |
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle">
<h1>General-purpose message structures.<br/>
<small>
[<a class="el" href="group__message__basics.html">Messaging basics</a>]</small>
</h1> </div>
</div>
<div class="contents">
<p>These structures often appear inside other structures.
<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 </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__point__2d.html">player_point_2d</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A point in the plane. <a href="structplayer__point__2d.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__point__3d.html">player_point_3d</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A point in 3D space. <a href="structplayer__point__3d.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__orientation__3d.html">player_orientation_3d</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An angle in 3D space. <a href="structplayer__orientation__3d.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__pose2d.html">player_pose2d</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A pose in the plane. <a href="structplayer__pose2d.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__pose3d.html">player_pose3d</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A pose in space. <a href="structplayer__pose3d.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__bbox2d.html">player_bbox2d</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A rectangular bounding box, used to define the size of an object. <a href="structplayer__bbox2d.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__bbox3d.html">player_bbox3d</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A rectangular bounding box, used to define the size of an object. <a href="structplayer__bbox3d.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__blackboard__entry.html">player_blackboard_entry</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Vectormap feature data. <a href="structplayer__blackboard__entry.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__segment.html">player_segment</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A line segment, used to construct vector-based maps. <a href="structplayer__segment.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__extent2d.html">player_extent2d</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A rectangular bounding box, used to define the origin and bounds of an object. <a href="structplayer__extent2d.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__color.html">player_color</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A color descriptor. <a href="structplayer__color.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__bool.html">player_bool</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A boolean variable, 0 for false anything else for true. <a href="structplayer__bool.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__uint32.html">player_uint32</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Structure for messages returning a single integer. <a href="structplayer__uint32.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0f06557520715f0f2dd3fb268005ba88"></a><!-- doxytag: member="utility_structs::player_point_2d_t" ref="ga0f06557520715f0f2dd3fb268005ba88" args="" -->
typedef struct <a class="el" href="structplayer__point__2d.html">player_point_2d</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__utility__structs.html#ga0f06557520715f0f2dd3fb268005ba88">player_point_2d_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A point in the plane. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga513b86679e488f42c0ce0d2fb1b109d4"></a><!-- doxytag: member="utility_structs::player_point_3d_t" ref="ga513b86679e488f42c0ce0d2fb1b109d4" args="" -->
typedef struct <a class="el" href="structplayer__point__3d.html">player_point_3d</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__utility__structs.html#ga513b86679e488f42c0ce0d2fb1b109d4">player_point_3d_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A point in 3D space. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gafef73931729c57bd29348743796acd15"></a><!-- doxytag: member="utility_structs::player_orientation_3d_t" ref="gafef73931729c57bd29348743796acd15" args="" -->
typedef struct <br class="typebreak"/>
<a class="el" href="structplayer__orientation__3d.html">player_orientation_3d</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__utility__structs.html#gafef73931729c57bd29348743796acd15">player_orientation_3d_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">An angle in 3D space. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga3fb594c0c59d10e5f0ca5ae1566bde7a"></a><!-- doxytag: member="utility_structs::player_pose2d_t" ref="ga3fb594c0c59d10e5f0ca5ae1566bde7a" args="" -->
typedef struct <a class="el" href="structplayer__pose2d.html">player_pose2d</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__utility__structs.html#ga3fb594c0c59d10e5f0ca5ae1566bde7a">player_pose2d_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A pose in the plane. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1046052cc4005c867943901e4a3d9b3e"></a><!-- doxytag: member="utility_structs::player_pose3d_t" ref="ga1046052cc4005c867943901e4a3d9b3e" args="" -->
typedef struct <a class="el" href="structplayer__pose3d.html">player_pose3d</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__utility__structs.html#ga1046052cc4005c867943901e4a3d9b3e">player_pose3d_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A pose in space. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga615e45cd492b3da3bcd808882b39de0f"></a><!-- doxytag: member="utility_structs::player_bbox2d_t" ref="ga615e45cd492b3da3bcd808882b39de0f" args="" -->
typedef struct <a class="el" href="structplayer__bbox2d.html">player_bbox2d</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__utility__structs.html#ga615e45cd492b3da3bcd808882b39de0f">player_bbox2d_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A rectangular bounding box, used to define the size of an object. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga5ba908a4eac2868a8a67482163cfcbe1"></a><!-- doxytag: member="utility_structs::player_bbox3d_t" ref="ga5ba908a4eac2868a8a67482163cfcbe1" args="" -->
typedef struct <a class="el" href="structplayer__bbox3d.html">player_bbox3d</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__utility__structs.html#ga5ba908a4eac2868a8a67482163cfcbe1">player_bbox3d_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A rectangular bounding box, used to define the size of an object. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
<a class="el" href="structplayer__blackboard__entry.html">player_blackboard_entry</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__utility__structs.html#gaef8a9e68a89996a5b113add0e2300273">player_blackboard_entry_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Vectormap feature data. <a href="#gaef8a9e68a89996a5b113add0e2300273"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7e876286fb84d4868e91503bd2942096"></a><!-- doxytag: member="utility_structs::player_segment_t" ref="ga7e876286fb84d4868e91503bd2942096" args="" -->
typedef struct <a class="el" href="structplayer__segment.html">player_segment</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__utility__structs.html#ga7e876286fb84d4868e91503bd2942096">player_segment_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A line segment, used to construct vector-based maps. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structplayer__extent2d.html">player_extent2d</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__utility__structs.html#gad353d78210a44b05f30711798e83cf24">player_extent2d_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A rectangular bounding box, used to define the origin and bounds of an object. <a href="#gad353d78210a44b05f30711798e83cf24"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0cf2bb96f30f847ec4c8eac1e664e481"></a><!-- doxytag: member="utility_structs::player_color_t" ref="ga0cf2bb96f30f847ec4c8eac1e664e481" args="" -->
typedef struct <a class="el" href="structplayer__color.html">player_color</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__utility__structs.html#ga0cf2bb96f30f847ec4c8eac1e664e481">player_color_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A color descriptor. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gacd840679cb887c729ded4948957f8b0c"></a><!-- doxytag: member="utility_structs::player_bool_t" ref="gacd840679cb887c729ded4948957f8b0c" args="" -->
typedef struct <a class="el" href="structplayer__bool.html">player_bool</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__utility__structs.html#gacd840679cb887c729ded4948957f8b0c">player_bool_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A boolean variable, 0 for false anything else for true. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga23199b58336c5446e0ea1c1aa82b6272"></a><!-- doxytag: member="utility_structs::player_uint32_t" ref="ga23199b58336c5446e0ea1c1aa82b6272" args="" -->
typedef struct <a class="el" href="structplayer__uint32.html">player_uint32</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__utility__structs.html#ga23199b58336c5446e0ea1c1aa82b6272">player_uint32_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Structure for messages returning a single integer. <br/></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>These structures often appear inside other structures. </p>
<hr/><h2>Typedef Documentation</h2>
<a class="anchor" id="gaef8a9e68a89996a5b113add0e2300273"></a><!-- doxytag: member="player.h::player_blackboard_entry_t" ref="gaef8a9e68a89996a5b113add0e2300273" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structplayer__blackboard__entry.html">player_blackboard_entry</a> <a class="el" href="structplayer__blackboard__entry.html">player_blackboard_entry_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Vectormap feature data. </p>
</div>
</div>
<a class="anchor" id="gad353d78210a44b05f30711798e83cf24"></a><!-- doxytag: member="player.h::player_extent2d_t" ref="gad353d78210a44b05f30711798e83cf24" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="structplayer__extent2d.html">player_extent2d</a> <a class="el" href="structplayer__extent2d.html">player_extent2d_t</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>A rectangular bounding box, used to define the origin and bounds of an object. </p>
<p>It is expected that x0 is less than x1 and y0 is less than y1. The points (x0,y0) and (x1,y1) represent opposite sides of the rectangle. </p>
</div>
</div>
</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>
distrib
>
Fedora
>
14
>
x86_64
>
media
>
updates
>
by-pkgid
>
727fa15453fcace956b835e2377d4269
>
files
>
833
