<!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="headertitle"> <h1>graphics3d<br/> <small> [<a class="el" href="group__interfaces.html">Interface specifications</a>]</small> </h1> </div> </div> <div class="contents"> <p>Three-dimensional graphics interface. <a href="#_details">More...</a></p> <table class="memberdecls"> <tr><td colspan="2"><p><a class="anchor" id="amgrpd41d8cd98f00b204e9800998ecf8427e"></a> </p> <br/><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gaba5bdd64092ca6de17e12456b9f57e00"></a><!-- doxytag: member="interface_graphics3d::PLAYER_GRAPHICS3D_CMD_CLEAR" ref="gaba5bdd64092ca6de17e12456b9f57e00" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__graphics3d.html#gaba5bdd64092ca6de17e12456b9f57e00">PLAYER_GRAPHICS3D_CMD_CLEAR</a> 1</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Command subtype: clear the drawing area (send an empty message). <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6b6e217b906d340dcf22e6e25ddf0073"></a><!-- doxytag: member="interface_graphics3d::PLAYER_GRAPHICS3D_CMD_DRAW" ref="ga6b6e217b906d340dcf22e6e25ddf0073" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__graphics3d.html#ga6b6e217b906d340dcf22e6e25ddf0073">PLAYER_GRAPHICS3D_CMD_DRAW</a> 2</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Command subtype: draw items. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gac60efc49b27126381970043cc2deeded"></a><!-- doxytag: member="interface_graphics3d::PLAYER_GRAPHICS3D_CMD_TRANSLATE" ref="gac60efc49b27126381970043cc2deeded" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__graphics3d.html#gac60efc49b27126381970043cc2deeded">PLAYER_GRAPHICS3D_CMD_TRANSLATE</a> 3</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Command subtype: translate coordinate system. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gabc344a4724f917c20e397969a045c0ac"></a><!-- doxytag: member="interface_graphics3d::PLAYER_GRAPHICS3D_CMD_ROTATE" ref="gabc344a4724f917c20e397969a045c0ac" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__graphics3d.html#gabc344a4724f917c20e397969a045c0ac">PLAYER_GRAPHICS3D_CMD_ROTATE</a> 4</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Command subtype: rotate coordinate system. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga1b19b20ab083b619f7159e13f34fd9e3"></a><!-- doxytag: member="interface_graphics3d::PLAYER_GRAPHICS3D_CMD_PUSH" ref="ga1b19b20ab083b619f7159e13f34fd9e3" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__graphics3d.html#ga1b19b20ab083b619f7159e13f34fd9e3">PLAYER_GRAPHICS3D_CMD_PUSH</a> 5</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Command subtype: push current coordinate system onto stack. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga4b14d47ed786367232d3f32ca64fb259"></a><!-- doxytag: member="interface_graphics3d::PLAYER_GRAPHICS3D_CMD_POP" ref="ga4b14d47ed786367232d3f32ca64fb259" args="" --> #define </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__graphics3d.html#ga4b14d47ed786367232d3f32ca64fb259">PLAYER_GRAPHICS3D_CMD_POP</a> 6</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Command subtype: pop coordinate system from stack to become current. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">enum </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__graphics3d.html#ga1e4e2488dcfd0748b07768275de6e1cb">player_graphics3d_draw_mode</a> { <br/> <b>PLAYER_DRAW_POINTS</b>, <b>PLAYER_DRAW_LINES</b>, <b>PLAYER_DRAW_LINE_STRIP</b>, <b>PLAYER_DRAW_LINE_LOOP</b>, <br/> <b>PLAYER_DRAW_TRIANGLES</b>, <b>PLAYER_DRAW_TRIANGLE_STRIP</b>, <b>PLAYER_DRAW_TRIANGLE_FAN</b>, <b>PLAYER_DRAW_QUADS</b>, <br/> <b>PLAYER_DRAW_QUAD_STRIP</b>, <b>PLAYER_DRAW_POLYGON</b> <br/> }</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Drawmode: enumeration that defines the drawing mode. </p> <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga7bb9ca841ac76c9f883ed76c55b12aeb"></a><!-- doxytag: member="interface_graphics3d::player_graphics3d_draw_mode_t" ref="ga7bb9ca841ac76c9f883ed76c55b12aeb" args="" --> typedef enum <br class="typebreak"/> <a class="el" href="group__interface__graphics3d.html#ga1e4e2488dcfd0748b07768275de6e1cb">player_graphics3d_draw_mode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__graphics3d.html#ga7bb9ca841ac76c9f883ed76c55b12aeb">player_graphics3d_draw_mode_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Drawmode: enumeration that defines the drawing mode. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/> <a class="el" href="structplayer__graphics3d__cmd__draw.html">player_graphics3d_cmd_draw</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__graphics3d.html#ga5767a8be10f650c2d04d69870b5963a6">player_graphics3d_cmd_draw_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Data: This interface produces no data. <a href="#ga5767a8be10f650c2d04d69870b5963a6"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga2c189094d0e42ede0d86e4d3aa63a817"></a><!-- doxytag: member="interface_graphics3d::player_graphics3d_cmd_translate_t" ref="ga2c189094d0e42ede0d86e4d3aa63a817" args="" --> typedef struct <br class="typebreak"/> <a class="el" href="structplayer__graphics3d__cmd__translate.html">player_graphics3d_cmd_translate</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__graphics3d.html#ga2c189094d0e42ede0d86e4d3aa63a817">player_graphics3d_cmd_translate_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Command: Translate coordinate system (<a class="el" href="group__interface__graphics3d.html#gac60efc49b27126381970043cc2deeded">PLAYER_GRAPHICS3D_CMD_TRANSLATE</a>) Translate the current coordinate system. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga5013fa6d4592c9a3e03216f45eddedfa"></a><!-- doxytag: member="interface_graphics3d::player_graphics3d_cmd_rotate_t" ref="ga5013fa6d4592c9a3e03216f45eddedfa" args="" --> typedef struct <br class="typebreak"/> <a class="el" href="structplayer__graphics3d__cmd__rotate.html">player_graphics3d_cmd_rotate</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__interface__graphics3d.html#ga5013fa6d4592c9a3e03216f45eddedfa">player_graphics3d_cmd_rotate_t</a></td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Command: Rotate coordinate system (<a class="el" href="group__interface__graphics3d.html#gabc344a4724f917c20e397969a045c0ac">PLAYER_GRAPHICS3D_CMD_ROTATE</a>) Rotate the current coordinate system by a given angle around the given vector. <br/></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>Three-dimensional graphics interface. </p> <p>The <code>graphics3d</code> interface provides an interface to graphics devices. Drivers can implement this interface to provide clients and other drivers with graphics output.</p> <p>The interface uses an openGL style of command where a type is specified along with a series of verticies. The interpretation depends on the command type</p> <p>Graphics items should be accumulated until an explicit clear command is issued </p> <hr/><h2>Typedef Documentation</h2> <a class="anchor" id="ga5767a8be10f650c2d04d69870b5963a6"></a><!-- doxytag: member="player_interfaces.h::player_graphics3d_cmd_draw_t" ref="ga5767a8be10f650c2d04d69870b5963a6" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef struct <a class="el" href="structplayer__graphics3d__cmd__draw.html">player_graphics3d_cmd_draw</a> <a class="el" href="structplayer__graphics3d__cmd__draw.html">player_graphics3d_cmd_draw_t</a></td> </tr> </table> </div> <div class="memdoc"> <p>Data: This interface produces no data. </p> <p>Requests: This interface accepts no requests. Command: Draw points (PLAYER_GRAPHICS3D_CMD_POINTS) Draw some points. </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>