<!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="#pub-attribs">Public Attributes</a> </div> <div class="headertitle"> <h1>player_map_data Struct Reference</h1> </div> </div> <div class="contents"> <!-- doxytag: class="player_map_data" --> <p>Request/reply: get grid map tile. <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="player__interfaces_8h_source.html">player_interfaces.h</a>></code></p> <p><a href="structplayer__map__data-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">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__map__data.html#aa7a7307f3e0a13c92f6f45c8712dbf8d">col</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The tile origin [pixels]. <a href="#aa7a7307f3e0a13c92f6f45c8712dbf8d"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__map__data.html#afbf230588c0025517a5f8bf611e0e249">row</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The tile origin [pixels]. <a href="#afbf230588c0025517a5f8bf611e0e249"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__map__data.html#aa1d34f0f131a4bbadb23ad119e4af828">width</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The size of the tile [pixels]. <a href="#aa1d34f0f131a4bbadb23ad119e4af828"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__map__data.html#a203b9bc165ec9688b624e3ea13fe1fab">height</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The size of the tile [pixels]. <a href="#a203b9bc165ec9688b624e3ea13fe1fab"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abc28b36a89e332e23d256ba1a411e90a"></a><!-- doxytag: member="player_map_data::data_count" ref="abc28b36a89e332e23d256ba1a411e90a" args="" --> uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__map__data.html#abc28b36a89e332e23d256ba1a411e90a">data_count</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">The number of cells. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">int8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structplayer__map__data.html#ac97972db8a1ec2aa587cd6fdcf4a2b0e">data</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Cell occupancy value (empty = -1, unknown = 0, occupied = +1). <a href="#ac97972db8a1ec2aa587cd6fdcf4a2b0e"></a><br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Request/reply: get grid map tile. </p> <p>To request a grid map tile, send a <a class="el" href="group__interface__map.html#ga9a8345bca3cb2c263941842f6e12c84d">PLAYER_MAP_REQ_GET_DATA</a> request with the tile origin and size you want. Set data_count to 0 and leave the data field empty. The response will contain origin, size, and occupancy data for a tile. Note that the response tile may not be exactly the same as the tile you requested (e.g., your requested tile is too large or runs off the map). </p> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="aa7a7307f3e0a13c92f6f45c8712dbf8d"></a><!-- doxytag: member="player_map_data::col" ref="aa7a7307f3e0a13c92f6f45c8712dbf8d" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">uint32_t <a class="el" href="structplayer__map__data.html#aa7a7307f3e0a13c92f6f45c8712dbf8d">player_map_data::col</a></td> </tr> </table> </div> <div class="memdoc"> <p>The tile origin [pixels]. </p> <p>Referenced by <a class="el" href="classMapTransform.html#a4a4fc2e74cfd93df0c7c08ad2c1dca73">MapTransform::ProcessMessage()</a>.</p> </div> </div> <a class="anchor" id="ac97972db8a1ec2aa587cd6fdcf4a2b0e"></a><!-- doxytag: member="player_map_data::data" ref="ac97972db8a1ec2aa587cd6fdcf4a2b0e" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">int8_t* <a class="el" href="structplayer__map__data.html#ac97972db8a1ec2aa587cd6fdcf4a2b0e">player_map_data::data</a></td> </tr> </table> </div> <div class="memdoc"> <p>Cell occupancy value (empty = -1, unknown = 0, occupied = +1). </p> <p>Referenced by <a class="el" href="classMapTransform.html#a4a4fc2e74cfd93df0c7c08ad2c1dca73">MapTransform::ProcessMessage()</a>.</p> </div> </div> <a class="anchor" id="a203b9bc165ec9688b624e3ea13fe1fab"></a><!-- doxytag: member="player_map_data::height" ref="a203b9bc165ec9688b624e3ea13fe1fab" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">uint32_t <a class="el" href="structplayer__map__data.html#a203b9bc165ec9688b624e3ea13fe1fab">player_map_data::height</a></td> </tr> </table> </div> <div class="memdoc"> <p>The size of the tile [pixels]. </p> <p>Referenced by <a class="el" href="classMapTransform.html#a4a4fc2e74cfd93df0c7c08ad2c1dca73">MapTransform::ProcessMessage()</a>.</p> </div> </div> <a class="anchor" id="afbf230588c0025517a5f8bf611e0e249"></a><!-- doxytag: member="player_map_data::row" ref="afbf230588c0025517a5f8bf611e0e249" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">uint32_t <a class="el" href="structplayer__map__data.html#afbf230588c0025517a5f8bf611e0e249">player_map_data::row</a></td> </tr> </table> </div> <div class="memdoc"> <p>The tile origin [pixels]. </p> <p>Referenced by <a class="el" href="classMapTransform.html#a4a4fc2e74cfd93df0c7c08ad2c1dca73">MapTransform::ProcessMessage()</a>.</p> </div> </div> <a class="anchor" id="aa1d34f0f131a4bbadb23ad119e4af828"></a><!-- doxytag: member="player_map_data::width" ref="aa1d34f0f131a4bbadb23ad119e4af828" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">uint32_t <a class="el" href="structplayer__map__data.html#aa1d34f0f131a4bbadb23ad119e4af828">player_map_data::width</a></td> </tr> </table> </div> <div class="memdoc"> <p>The size of the tile [pixels]. </p> <p>Referenced by <a class="el" href="classMapTransform.html#a4a4fc2e74cfd93df0c7c08ad2c1dca73">MapTransform::ProcessMessage()</a>.</p> </div> </div> <hr/>The documentation for this struct was generated from the following file:<ul> <li><a class="el" href="player__interfaces_8h_source.html">player_interfaces.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>