<!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"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.14"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>Box2D: b2Shape.h Source File</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="search/search.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="search/searchdata.js"></script> <script type="text/javascript" src="search/search.js"></script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectlogo"><img alt="Logo" src="icon.gif"/></td> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">Box2D  <span id="projectnumber">2.3.0</span> </div> <div id="projectbrief">A 2D Physics Engine for Games</div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.14 --> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ var searchBox = new SearchBox("searchBox", "search",false,'Search'); /* @license-end */ </script> <script type="text/javascript" src="menudata.js"></script> <script type="text/javascript" src="menu.js"></script> <script type="text/javascript"> /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ $(function() { initMenu('',true,false,'search.php','Search'); $(document).ready(function() { init_search(); }); }); /* @license-end */</script> <div id="main-nav"></div> <!-- window showing the filter options --> <div id="MSearchSelectWindow" onmouseover="return searchBox.OnSearchSelectShow()" onmouseout="return searchBox.OnSearchSelectHide()" onkeydown="return searchBox.OnSearchSelectKey(event)"> </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 id="nav-path" class="navpath"> <ul> <li class="navelem"><a class="el" href="dir_a7f953fea4e008d17e00594b3bbaff29.html">Box2D</a></li><li class="navelem"><a class="el" href="dir_f938a2b4566b4bd7e1dc8e6edc30956c.html">Collision</a></li><li class="navelem"><a class="el" href="dir_2b0aaca8962b4c18f14a1e758f920130.html">Shapes</a></li> </ul> </div> </div><!-- top --> <div class="header"> <div class="headertitle"> <div class="title">b2Shape.h</div> </div> </div><!--header--> <div class="contents"> <div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">* Copyright (c) 2006-2009 Erin Catto http://www.box2d.org</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment">*</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment">* This software is provided 'as-is', without any express or implied</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment">* warranty. In no event will the authors be held liable for any damages</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment">* arising from the use of this software.</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment">* Permission is granted to anyone to use this software for any purpose,</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment">* including commercial applications, and to alter it and redistribute it</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment">* freely, subject to the following restrictions:</span></div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment">* 1. The origin of this software must not be misrepresented; you must not</span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment">* claim that you wrote the original software. If you use this software</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment">* in a product, an acknowledgment in the product documentation would be</span></div><div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment">* appreciated but is not required.</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment">* 2. Altered source versions must be plainly marked as such, and must not be</span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">* misrepresented as being the original software.</span></div><div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment">* 3. This notice may not be removed or altered from any source distribution.</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment">*/</span></div><div class="line"><a name="l00018"></a><span class="lineno"> 18</span> </div><div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="preprocessor">#ifndef B2_SHAPE_H</span></div><div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="preprocessor">#define B2_SHAPE_H</span></div><div class="line"><a name="l00021"></a><span class="lineno"> 21</span> </div><div class="line"><a name="l00022"></a><span class="lineno"> 22</span> <span class="preprocessor">#include <Box2D/Common/b2BlockAllocator.h></span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#include <Box2D/Common/b2Math.h></span></div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor">#include <<a class="code" href="b2_collision_8h.html">Box2D/Collision/b2Collision.h</a>></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> </div><div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="structb2_mass_data.html"> 27</a></span> <span class="keyword">struct </span><a class="code" href="structb2_mass_data.html">b2MassData</a></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> {</div><div class="line"><a name="l00030"></a><span class="lineno"><a class="line" href="structb2_mass_data.html#aea85d9595a38d2eed05b8d2ea80d97b1"> 30</a></span>  float32 <a class="code" href="structb2_mass_data.html#aea85d9595a38d2eed05b8d2ea80d97b1">mass</a>;</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> </div><div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="structb2_mass_data.html#a1d59bebc7030c4dded0c2febc57ebdd7"> 33</a></span>  <a class="code" href="structb2_vec2.html">b2Vec2</a> <a class="code" href="structb2_mass_data.html#a1d59bebc7030c4dded0c2febc57ebdd7">center</a>;</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> </div><div class="line"><a name="l00036"></a><span class="lineno"><a class="line" href="structb2_mass_data.html#ad2d06e96e2d79d895df16ae0e5fe0376"> 36</a></span>  float32 <a class="code" href="structb2_mass_data.html#ad2d06e96e2d79d895df16ae0e5fe0376">I</a>;</div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> };</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> </div><div class="line"><a name="l00042"></a><span class="lineno"><a class="line" href="classb2_shape.html"> 42</a></span> <span class="keyword">class </span><a class="code" href="classb2_shape.html">b2Shape</a></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> {</div><div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="keyword">public</span>:</div><div class="line"><a name="l00045"></a><span class="lineno"> 45</span>  </div><div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="keyword">enum</span> Type</div><div class="line"><a name="l00047"></a><span class="lineno"> 47</span>  {</div><div class="line"><a name="l00048"></a><span class="lineno"> 48</span>  e_circle = 0,</div><div class="line"><a name="l00049"></a><span class="lineno"> 49</span>  e_edge = 1,</div><div class="line"><a name="l00050"></a><span class="lineno"> 50</span>  e_polygon = 2,</div><div class="line"><a name="l00051"></a><span class="lineno"> 51</span>  e_chain = 3,</div><div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  e_typeCount = 4</div><div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  };</div><div class="line"><a name="l00054"></a><span class="lineno"> 54</span> </div><div class="line"><a name="l00055"></a><span class="lineno"> 55</span>  <span class="keyword">virtual</span> ~<a class="code" href="classb2_shape.html">b2Shape</a>() {}</div><div class="line"><a name="l00056"></a><span class="lineno"> 56</span> </div><div class="line"><a name="l00058"></a><span class="lineno"> 58</span>  <span class="keyword">virtual</span> <a class="code" href="classb2_shape.html">b2Shape</a>* <a class="code" href="classb2_shape.html#a4716243454bb9cf7c7ee1d9cb23ae634">Clone</a>(<a class="code" href="classb2_block_allocator.html">b2BlockAllocator</a>* allocator) <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00059"></a><span class="lineno"> 59</span> </div><div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  Type <a class="code" href="classb2_shape.html#a600cceee6186d81bb1b8ab142324bba6">GetType</a>() <span class="keyword">const</span>;</div><div class="line"><a name="l00063"></a><span class="lineno"> 63</span> </div><div class="line"><a name="l00065"></a><span class="lineno"> 65</span>  <span class="keyword">virtual</span> int32 <a class="code" href="classb2_shape.html#a05a3c445017d96df9238ceefe6ce37ab">GetChildCount</a>() <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00066"></a><span class="lineno"> 66</span> </div><div class="line"><a name="l00070"></a><span class="lineno"> 70</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classb2_shape.html#a6ac968e403e2d93e8ae46d728a2e50fa">TestPoint</a>(<span class="keyword">const</span> <a class="code" href="structb2_transform.html">b2Transform</a>& xf, <span class="keyword">const</span> <a class="code" href="structb2_vec2.html">b2Vec2</a>& p) <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00071"></a><span class="lineno"> 71</span> </div><div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="classb2_shape.html#aee53a926f4fe64cd03693f6211ef6335">RayCast</a>(<a class="code" href="structb2_ray_cast_output.html">b2RayCastOutput</a>* output, <span class="keyword">const</span> <a class="code" href="structb2_ray_cast_input.html">b2RayCastInput</a>& input,</div><div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  <span class="keyword">const</span> <a class="code" href="structb2_transform.html">b2Transform</a>& transform, int32 childIndex) <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00079"></a><span class="lineno"> 79</span> </div><div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classb2_shape.html#a88e9807fab0c8ca9a98d8926e50a1411">ComputeAABB</a>(<a class="code" href="structb2_a_a_b_b.html">b2AABB</a>* aabb, <span class="keyword">const</span> <a class="code" href="structb2_transform.html">b2Transform</a>& xf, int32 childIndex) <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00085"></a><span class="lineno"> 85</span> </div><div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classb2_shape.html#a61b365526241b47f124789b0309cac69">ComputeMass</a>(<a class="code" href="structb2_mass_data.html">b2MassData</a>* massData, float32 density) <span class="keyword">const</span> = 0;</div><div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div><div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  Type m_type;</div><div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  float32 m_radius;</div><div class="line"><a name="l00094"></a><span class="lineno"> 94</span> };</div><div class="line"><a name="l00095"></a><span class="lineno"> 95</span> </div><div class="line"><a name="l00096"></a><span class="lineno"><a class="line" href="classb2_shape.html#a600cceee6186d81bb1b8ab142324bba6"> 96</a></span> <span class="keyword">inline</span> b2Shape::Type <a class="code" href="classb2_shape.html#a600cceee6186d81bb1b8ab142324bba6">b2Shape::GetType</a>()<span class="keyword"> const</span></div><div class="line"><a name="l00097"></a><span class="lineno"> 97</span> <span class="keyword"></span>{</div><div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  <span class="keywordflow">return</span> m_type;</div><div class="line"><a name="l00099"></a><span class="lineno"> 99</span> }</div><div class="line"><a name="l00100"></a><span class="lineno"> 100</span> </div><div class="line"><a name="l00101"></a><span class="lineno"> 101</span> <span class="preprocessor">#endif</span></div><div class="ttc" id="structb2_transform_html"><div class="ttname"><a href="structb2_transform.html">b2Transform</a></div><div class="ttdef"><b>Definition:</b> b2Math.h:350</div></div> <div class="ttc" id="structb2_mass_data_html_ad2d06e96e2d79d895df16ae0e5fe0376"><div class="ttname"><a href="structb2_mass_data.html#ad2d06e96e2d79d895df16ae0e5fe0376">b2MassData::I</a></div><div class="ttdeci">float32 I</div><div class="ttdoc">The rotational inertia of the shape about the local origin. </div><div class="ttdef"><b>Definition:</b> b2Shape.h:36</div></div> <div class="ttc" id="classb2_block_allocator_html"><div class="ttname"><a href="classb2_block_allocator.html">b2BlockAllocator</a></div><div class="ttdef"><b>Definition:</b> b2BlockAllocator.h:35</div></div> <div class="ttc" id="classb2_shape_html_a05a3c445017d96df9238ceefe6ce37ab"><div class="ttname"><a href="classb2_shape.html#a05a3c445017d96df9238ceefe6ce37ab">b2Shape::GetChildCount</a></div><div class="ttdeci">virtual int32 GetChildCount() const =0</div><div class="ttdoc">Get the number of child primitives. </div></div> <div class="ttc" id="structb2_mass_data_html"><div class="ttname"><a href="structb2_mass_data.html">b2MassData</a></div><div class="ttdoc">This holds the mass data computed for a shape. </div><div class="ttdef"><b>Definition:</b> b2Shape.h:27</div></div> <div class="ttc" id="classb2_shape_html"><div class="ttname"><a href="classb2_shape.html">b2Shape</a></div><div class="ttdef"><b>Definition:</b> b2Shape.h:42</div></div> <div class="ttc" id="b2_collision_8h_html"><div class="ttname"><a href="b2_collision_8h.html">b2Collision.h</a></div></div> <div class="ttc" id="structb2_ray_cast_output_html"><div class="ttname"><a href="structb2_ray_cast_output.html">b2RayCastOutput</a></div><div class="ttdef"><b>Definition:</b> b2Collision.h:155</div></div> <div class="ttc" id="classb2_shape_html_a88e9807fab0c8ca9a98d8926e50a1411"><div class="ttname"><a href="classb2_shape.html#a88e9807fab0c8ca9a98d8926e50a1411">b2Shape::ComputeAABB</a></div><div class="ttdeci">virtual void ComputeAABB(b2AABB *aabb, const b2Transform &xf, int32 childIndex) const =0</div></div> <div class="ttc" id="structb2_a_a_b_b_html"><div class="ttname"><a href="structb2_a_a_b_b.html">b2AABB</a></div><div class="ttdoc">An axis aligned bounding box. </div><div class="ttdef"><b>Definition:</b> b2Collision.h:162</div></div> <div class="ttc" id="structb2_mass_data_html_aea85d9595a38d2eed05b8d2ea80d97b1"><div class="ttname"><a href="structb2_mass_data.html#aea85d9595a38d2eed05b8d2ea80d97b1">b2MassData::mass</a></div><div class="ttdeci">float32 mass</div><div class="ttdoc">The mass of the shape, usually in kilograms. </div><div class="ttdef"><b>Definition:</b> b2Shape.h:30</div></div> <div class="ttc" id="structb2_mass_data_html_a1d59bebc7030c4dded0c2febc57ebdd7"><div class="ttname"><a href="structb2_mass_data.html#a1d59bebc7030c4dded0c2febc57ebdd7">b2MassData::center</a></div><div class="ttdeci">b2Vec2 center</div><div class="ttdoc">The position of the shape&#39;s centroid relative to the shape&#39;s origin. </div><div class="ttdef"><b>Definition:</b> b2Shape.h:33</div></div> <div class="ttc" id="structb2_ray_cast_input_html"><div class="ttname"><a href="structb2_ray_cast_input.html">b2RayCastInput</a></div><div class="ttdoc">Ray-cast input data. The ray extends from p1 to p1 + maxFraction * (p2 - p1). </div><div class="ttdef"><b>Definition:</b> b2Collision.h:147</div></div> <div class="ttc" id="classb2_shape_html_aee53a926f4fe64cd03693f6211ef6335"><div class="ttname"><a href="classb2_shape.html#aee53a926f4fe64cd03693f6211ef6335">b2Shape::RayCast</a></div><div class="ttdeci">virtual bool RayCast(b2RayCastOutput *output, const b2RayCastInput &input, const b2Transform &transform, int32 childIndex) const =0</div></div> <div class="ttc" id="classb2_shape_html_a4716243454bb9cf7c7ee1d9cb23ae634"><div class="ttname"><a href="classb2_shape.html#a4716243454bb9cf7c7ee1d9cb23ae634">b2Shape::Clone</a></div><div class="ttdeci">virtual b2Shape * Clone(b2BlockAllocator *allocator) const =0</div><div class="ttdoc">Clone the concrete shape using the provided allocator. </div></div> <div class="ttc" id="classb2_shape_html_a61b365526241b47f124789b0309cac69"><div class="ttname"><a href="classb2_shape.html#a61b365526241b47f124789b0309cac69">b2Shape::ComputeMass</a></div><div class="ttdeci">virtual void ComputeMass(b2MassData *massData, float32 density) const =0</div></div> <div class="ttc" id="structb2_vec2_html"><div class="ttname"><a href="structb2_vec2.html">b2Vec2</a></div><div class="ttdoc">A 2D column vector. </div><div class="ttdef"><b>Definition:</b> b2Math.h:53</div></div> <div class="ttc" id="classb2_shape_html_a600cceee6186d81bb1b8ab142324bba6"><div class="ttname"><a href="classb2_shape.html#a600cceee6186d81bb1b8ab142324bba6">b2Shape::GetType</a></div><div class="ttdeci">Type GetType() const</div><div class="ttdef"><b>Definition:</b> b2Shape.h:96</div></div> <div class="ttc" id="classb2_shape_html_a6ac968e403e2d93e8ae46d728a2e50fa"><div class="ttname"><a href="classb2_shape.html#a6ac968e403e2d93e8ae46d728a2e50fa">b2Shape::TestPoint</a></div><div class="ttdeci">virtual bool TestPoint(const b2Transform &xf, const b2Vec2 &p) const =0</div></div> </div><!-- fragment --></div><!-- contents --> <!-- start footer part --> <hr class="footer"/><address class="footer"><small> Generated on Fri Sep 21 2018 22:35:06 for Box2D by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/> </a> 1.8.14 </small></address> </body> </html>