<!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::SE3StateSpace::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_1SE3StateSpace.html">SE3StateSpace</a> </li>
<li class="navelem"><a class="el" href="classompl_1_1base_1_1SE3StateSpace_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::SE3StateSpace::StateType Class Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="ompl::base::SE3StateSpace::StateType" --><!-- doxytag: inherits="ompl::base::CompoundState" -->
<p>A state in SE(3): position = (x, y, z), quaternion = (x, y, z, w)
<a href="classompl_1_1base_1_1SE3StateSpace_1_1StateType.html#details">More...</a></p>
<p><code>#include <<a class="el" href="SE3StateSpace_8h_source.html">SE3StateSpace.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ompl::base::SE3StateSpace::StateType:</div>
<div class="dyncontent">
<div class="center"><img src="classompl_1_1base_1_1SE3StateSpace_1_1StateType__inherit__graph.png" border="0" usemap="#ompl_1_1base_1_1SE3StateSpace_1_1StateType_inherit__map" alt="Inheritance graph"/></div>
<map name="ompl_1_1base_1_1SE3StateSpace_1_1StateType_inherit__map" id="ompl_1_1base_1_1SE3StateSpace_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_1SE3StateSpace_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="abb4f8e3361ec2c6d8fae0ee3af110691"></a><!-- doxytag: member="ompl::base::SE3StateSpace::StateType::getX" ref="abb4f8e3361ec2c6d8fae0ee3af110691" args="(void) const " -->
double </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1SE3StateSpace_1_1StateType.html#abb4f8e3361ec2c6d8fae0ee3af110691">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="ab125708f22ec1815503a71f25730c4c7"></a><!-- doxytag: member="ompl::base::SE3StateSpace::StateType::getY" ref="ab125708f22ec1815503a71f25730c4c7" args="(void) const " -->
double </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1SE3StateSpace_1_1StateType.html#ab125708f22ec1815503a71f25730c4c7">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="ad455e9b4048cb1fe65b47c3f4a422f24"></a><!-- doxytag: member="ompl::base::SE3StateSpace::StateType::getZ" ref="ad455e9b4048cb1fe65b47c3f4a422f24" args="(void) const " -->
double </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1SE3StateSpace_1_1StateType.html#ad455e9b4048cb1fe65b47c3f4a422f24">getZ</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the Z component of the state. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a3eef19382a3965917f8a81097bd8e5eb"></a><!-- doxytag: member="ompl::base::SE3StateSpace::StateType::rotation" ref="a3eef19382a3965917f8a81097bd8e5eb" args="(void) const " -->
const <a class="el" href="classompl_1_1base_1_1SO3StateSpace_1_1StateType.html">SO3StateSpace::StateType</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1SE3StateSpace_1_1StateType.html#a3eef19382a3965917f8a81097bd8e5eb">rotation</a> (void) const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the rotation component of the state. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa74527306fe83a197654ade4218927ba"></a><!-- doxytag: member="ompl::base::SE3StateSpace::StateType::rotation" ref="aa74527306fe83a197654ade4218927ba" args="(void)" -->
<a class="el" href="classompl_1_1base_1_1SO3StateSpace_1_1StateType.html">SO3StateSpace::StateType</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1SE3StateSpace_1_1StateType.html#aa74527306fe83a197654ade4218927ba">rotation</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the rotation component of the state and allow changing it as well. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a0751796d34a2d0de27c2103093345aea"></a><!-- doxytag: member="ompl::base::SE3StateSpace::StateType::setX" ref="a0751796d34a2d0de27c2103093345aea" args="(double x)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1SE3StateSpace_1_1StateType.html#a0751796d34a2d0de27c2103093345aea">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="a4858f00d5ba6b03f85e59e6de7a2cd08"></a><!-- doxytag: member="ompl::base::SE3StateSpace::StateType::setY" ref="a4858f00d5ba6b03f85e59e6de7a2cd08" args="(double y)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1SE3StateSpace_1_1StateType.html#a4858f00d5ba6b03f85e59e6de7a2cd08">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="ab478a95c3f0c06c4e095b7ac859f1410"></a><!-- doxytag: member="ompl::base::SE3StateSpace::StateType::setZ" ref="ab478a95c3f0c06c4e095b7ac859f1410" args="(double z)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1SE3StateSpace_1_1StateType.html#ab478a95c3f0c06c4e095b7ac859f1410">setZ</a> (double z)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the Z component of the state. <br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a31582a7c0aa334e70d07f9b57939269e"></a><!-- doxytag: member="ompl::base::SE3StateSpace::StateType::setXYZ" ref="a31582a7c0aa334e70d07f9b57939269e" args="(double x, double y, double z)" -->
void </td><td class="memItemRight" valign="bottom"><a class="el" href="classompl_1_1base_1_1SE3StateSpace_1_1StateType.html#a31582a7c0aa334e70d07f9b57939269e">setXYZ</a> (double x, double y, double z)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the X, Y and Z components of the state. <br/></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>A state in SE(3): position = (x, y, z), quaternion = (x, y, z, w) </p>
<p>Definition at line <a class="el" href="SE3StateSpace_8h_source.html#l00055">55</a> of file <a class="el" href="SE3StateSpace_8h_source.html">SE3StateSpace.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="SE3StateSpace_8h_source.html">SE3StateSpace.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:31 by <a href="http://www.doxygen.org/index.html">doxygen</a> 1.7.4</div>
</div>
</div>
</body>
</html>
