2
0

group__BoxFunctions.html 3.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.3.1"/>
  7. <title>TorqueScript Reference: Box Math</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  12. <link href="t2d-stylesheet-extra.css" rel="stylesheet" type="text/css"/>
  13. </head>
  14. <body>
  15. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  16. <div id="titlearea">
  17. <table cellspacing="0" cellpadding="0">
  18. <tbody>
  19. <tr style="height: 56px;">
  20. <td style="padding-left: 0.5em;">
  21. <div id="projectname">TorqueScript Reference
  22. </div>
  23. </td>
  24. </tr>
  25. </tbody>
  26. </table>
  27. </div>
  28. <!-- end header part -->
  29. <!-- Generated by Doxygen 1.8.3.1 -->
  30. <div id="navrow1" class="tabs">
  31. <ul class="tablist">
  32. <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  33. <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
  34. <li><a href="modules.html"><span>Modules</span></a></li>
  35. <li><a href="annotated.html"><span>Classes</span></a></li>
  36. </ul>
  37. </div>
  38. </div><!-- top -->
  39. <div class="header">
  40. <div class="summary">
  41. <a href="#func-members">Functions</a> </div>
  42. <div class="headertitle">
  43. <div class="title">Box Math<div class="ingroups"><a class="el" href="group__TorqueScriptFunctions.html">Function Categories</a></div></div> </div>
  44. </div><!--header-->
  45. <div class="contents">
  46. <table class="memberdecls">
  47. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
  48. Functions</h2></td></tr>
  49. <tr class="memitem:gae96ba0259e3db816db552ffbd1db55d6"><td class="memItemLeft" align="right" valign="top">const char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__BoxFunctions.html#gae96ba0259e3db816db552ffbd1db55d6">getBoxCenter</a> (box)</td></tr>
  50. <tr class="separator:gae96ba0259e3db816db552ffbd1db55d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  51. </table>
  52. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  53. <h2 class="groupheader">Function Documentation</h2>
  54. <a class="anchor" id="gae96ba0259e3db816db552ffbd1db55d6"></a>
  55. <div class="memitem">
  56. <div class="memproto">
  57. <table class="memname">
  58. <tr>
  59. <td class="memname">const char* getBoxCenter </td>
  60. <td>(</td>
  61. <td class="paramtype">box&#160;</td>
  62. <td class="paramname"></td><td>)</td>
  63. <td></td>
  64. </tr>
  65. </table>
  66. </div><div class="memdoc">
  67. <p>Use the getBoxCenter function to find the centroid of a cube (box). </p>
  68. <dl class="params"><dt>Parameters</dt><dd>
  69. <table class="params">
  70. <tr><td class="paramname">box</td><td>A vector containing two three-element floating-point position vectors: "X1 Y1 Z1 X2 Y2 Z2". </td></tr>
  71. </table>
  72. </dd>
  73. </dl>
  74. <dl class="section return"><dt>Returns</dt><dd>Returns a vector containing a three-element floating-point position vector equal to the centroid of the area defined by box </dd></dl>
  75. </div>
  76. </div>
  77. </div><!-- contents -->
  78. <!-- start footer part -->
  79. <hr class="footer"/><address class="footer"><small>
  80. Generated by &#160;<a href="http://www.doxygen.org/index.html">
  81. <img class="footer" src="doxygen.png" alt="doxygen"/>
  82. </a> 1.8.3.1
  83. </small></address>
  84. </body>
  85. </html>