<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml; charset=UTF-8"/> <title>OMPL: ompl::base::SE2StateSpace::StateType Class Reference</title> <meta name="author" content="Ioan A. Șucan, Mark Moll, Lydia E. Kavraki"> <link rel="stylesheet" href="../css/screen.css" type="text/css" media="screen, projection"> <link rel="stylesheet" href="../css/print.css" type="text/css" media="print"> <!--[if lt IE 7]> <script type="text/javascript" src="../js/jquery/jquery.js"></script> <script type="text/javascript" src="../js/jquery/jquery.dropdown.js"></script> <![endif]--> <script type="text/javaScript" src="search/search.js"></script> <script type="text/javascript"> var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-9156598-2']); _gaq.push(['_trackPageview']); (function() { var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); })(); </script> </head> <body onload='searchBox.OnSelectItem(0);'> <script type="text/javascript"><!-- var searchBox = new SearchBox("searchBox", "search",false,'Search API'); --></script> <div class="navigation" id="top"> <div class="tabs" id="ompltitle"> <ul class="tablist"> <li>The Open Motion Planning Library</li> <li id="searchli"> <div id="MSearchBox" class="MSearchBoxInactive"> <span class="left"> <img id="MSearchSelect" src="search/mag_sel.png" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" alt=""/> <input type="text" id="MSearchField" value="Search API" accesskey="S" onfocus="searchBox.OnSearchFieldFocus(true)" onblur="searchBox.OnSearchFieldFocus(false)" onkeyup="searchBox.OnSearchFieldChange(event)"/> </span><span class="right"> <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a> </span> </div> </li> </ul> </div> <ul id="nav" class="dropdown"> <li class="first"><a href="index.html">Home</a></li> <li><a href="download.html">Download</a></li> <li><a href="documentation.html">Documentation</a></li> <li><span class="dir">Code API</span> <ul> <li><a href="api_overview.html">API Overview</a></li> <li><a href="namespaces.html">Namespaces</a></li> <li><a href="annotated.html">Classes</a></li> <li><a href="files.html">Files</a></li> <li><a href="dirs.html">Directories</a></li> </ul> </li> <li><span class="dir">Community</span> <ul> <li><a href="developers.html">Developers</a></li> <li><a href="thirdparty.html">Contributions</a></li> <li><a href="education.html">Education</a></li> <li><a href="gallery.html">Gallery</a></li> </ul> </li> <li><span class="dir">About</span> <ul> <li><a href="license.html">License</a></li> <li><a href="citations.html">Citations</a></li> <li><a href="acknowledgements.html">Acknowledgments</a></li> <li><a href="contact.html">Contact Us</a></li> </ul> </li> </ul> </div> <!--- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="" frameborder="0"name="MSearchResults" id="MSearchResults"></iframe> </div> <div class="container"> <div class="span-22 push-2 first last"> <div> <!-- Generated by Doxygen 1.7.4 --> <script type="text/javascript"><!-- var searchBox = new SearchBox("searchBox", "search",false,'Search'); --></script> <div id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="namespaceompl.html">ompl</a> </li> <li class="navelem"><a class="el" href="namespaceompl_1_1base.html">base</a> </li> <li class="navelem"><a class="el" href="classompl_1_1base_1_1SE2StateSpace.html">SE2StateSpace</a> </li> <li class="navelem"><a class="el" href="classompl_1_1base_1_1SE2StateSpace_1_1StateType.html">StateType</a> </li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#pub-methods">Public Member Functions</a> </div> <div class="headertitle"> <div class="title">ompl::base::SE2StateSpace::StateType Class Reference</div> </div> </div> <div class="contents"> <!-- doxytag: class="ompl::base::SE2StateSpace::StateType" --><!-- doxytag: inherits="ompl::base::CompoundState" --> <p>A state in SE(2): (x, y, yaw) <a href="classompl_1_1base_1_1SE2StateSpace_1_1StateType.html#details">More...</a></p> <p><code>#include <<a class="el" href="SE2StateSpace_8h_source.html">SE2StateSpace.h</a>></code></p> <div class="dynheader"> Inheritance diagram for ompl::base::SE2StateSpace::StateType:</div> <div class="dyncontent"> <div class="center"><img src="classompl_1_1base_1_1SE2StateSpace_1_1StateType__inherit__graph.png" border="0" usemap="#ompl_1_1base_1_1SE2StateSpace_1_1StateType_inherit__map" alt="Inheritance graph"/></div> <map name="ompl_1_1base_1_1SE2StateSpace_1_1StateType_inherit__map" id="ompl_1_1base_1_1SE2StateSpace_1_1StateType_inherit__map"> <area shape="rect" id="node2" href="classompl_1_1base_1_1CompoundState.html" title="Definition of a compound state." alt="" coords="21,83,243,112"/><area shape="rect" id="node4" href="classompl_1_1base_1_1State.html" title="Definition of an abstract state." alt="" coords="69,5,195,35"/></map> <center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div> <p><a href="classompl_1_1base_1_1SE2StateSpace_1_1StateType-members.html">List of all members.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a78894bdbbf88045312c8938b5259e76f"></a><!-- doxytag: member="ompl::base::SE2StateSpace::StateType::getX" ref="a78894bdbbf88045312c8938b5259e76f" args="(void) const " --> double </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1SE2StateSpace_1_1StateType.html#a78894bdbbf88045312c8938b5259e76f">getX</a> (void) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the X component of the state. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a38a7258bbe8ec9088c2cd4cf1c539775"></a><!-- doxytag: member="ompl::base::SE2StateSpace::StateType::getY" ref="a38a7258bbe8ec9088c2cd4cf1c539775" args="(void) const " --> double </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1SE2StateSpace_1_1StateType.html#a38a7258bbe8ec9088c2cd4cf1c539775">getY</a> (void) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the Y component of the state. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab5afd55557c4c6fe1ba882da00c1f5c3"></a><!-- doxytag: member="ompl::base::SE2StateSpace::StateType::getYaw" ref="ab5afd55557c4c6fe1ba882da00c1f5c3" args="(void) const " --> double </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1SE2StateSpace_1_1StateType.html#ab5afd55557c4c6fe1ba882da00c1f5c3">getYaw</a> (void) const </td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Get the yaw component of the state. This is the rotation in plane, with respect to the Z axis. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9df0f4ee9efab3c90148bec5080e1dc8"></a><!-- doxytag: member="ompl::base::SE2StateSpace::StateType::setX" ref="a9df0f4ee9efab3c90148bec5080e1dc8" args="(double x)" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1SE2StateSpace_1_1StateType.html#a9df0f4ee9efab3c90148bec5080e1dc8">setX</a> (double x)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the X component of the state. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4dd59df1ffc4f868556d0e507984a07b"></a><!-- doxytag: member="ompl::base::SE2StateSpace::StateType::setY" ref="a4dd59df1ffc4f868556d0e507984a07b" args="(double y)" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1SE2StateSpace_1_1StateType.html#a4dd59df1ffc4f868556d0e507984a07b">setY</a> (double y)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the Y component of the state. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a404c1c0e98be35ce2b35885e8180a616"></a><!-- doxytag: member="ompl::base::SE2StateSpace::StateType::setXY" ref="a404c1c0e98be35ce2b35885e8180a616" args="(double x, double y)" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1SE2StateSpace_1_1StateType.html#a404c1c0e98be35ce2b35885e8180a616">setXY</a> (double x, double y)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the X and Y components of the state. <br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abc32a6219bee45cf35d0323d2deb7de3"></a><!-- doxytag: member="ompl::base::SE2StateSpace::StateType::setYaw" ref="abc32a6219bee45cf35d0323d2deb7de3" args="(double yaw)" --> void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1SE2StateSpace_1_1StateType.html#abc32a6219bee45cf35d0323d2deb7de3">setYaw</a> (double yaw)</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">Set the yaw component of the state. This is the rotation in plane, with respect to the Z axis. <br/></td></tr> </table> <hr/><a name="details" id="details"></a><h2>Detailed Description</h2> <div class="textblock"><p>A state in SE(2): (x, y, yaw) </p> <p>Definition at line <a class="el" href="SE2StateSpace_8h_source.html#l00055">55</a> of file <a class="el" href="SE2StateSpace_8h_source.html">SE2StateSpace.h</a>.</p> </div><hr/>The documentation for this class was generated from the following file:<ul> <li>src/ompl/base/spaces/<a class="el" href="SE2StateSpace_8h_source.html">SE2StateSpace.h</a></li> </ul> </div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerator</a></div> <!-- iframe showing the search results (closed by default) --> <div id="MSearchResultsWindow"> <iframe src="javascript:void(0)" frameborder="0" name="MSearchResults" id="MSearchResults"> </iframe> </div> </div> <div class="footer span-22 push-2 last"> <a href="http://www.kavrakilab.org">Physical and Biological Computing Group</a> • <a href="http://www.cs.rice.edu">Department of Computer Science</a> • <a href="http://www.rice.edu">Rice University</a><br> <div class="gray">Generated on Sun Oct 9 2011 23:04:42 by <a href="http://www.doxygen.org/index.html">doxygen</a> 1.7.4</div> </div> </div> </body> </html>