You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

251 lines
17 KiB

  1. <!DOCTYPE HTML>
  2. <html lang="de">
  3. <head>
  4. <!-- Generated by javadoc (17) on Fri May 13 10:01:19 CEST 2022 -->
  5. <title>RectObject</title>
  6. <meta name="viewport" content="width=device-width, initial-scale=1">
  7. <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
  8. <meta name="dc.created" content="2022-05-13">
  9. <meta name="description" content="declaration: package: gameobjects, class: RectObject">
  10. <meta name="generator" content="javadoc/ClassWriterImpl">
  11. <link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style">
  12. <link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style">
  13. <link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style">
  14. <script type="text/javascript" src="../script.js"></script>
  15. <script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script>
  16. <script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script>
  17. </head>
  18. <body class="class-declaration-page">
  19. <script type="text/javascript">var evenRowColor = "even-row-color";
  20. var oddRowColor = "odd-row-color";
  21. var tableTab = "table-tab";
  22. var activeTableTab = "active-table-tab";
  23. var pathtoroot = "../";
  24. loadScripts(document, 'script');</script>
  25. <noscript>
  26. <div>JavaScript is disabled on your browser.</div>
  27. </noscript>
  28. <div class="flex-box">
  29. <header role="banner" class="flex-header">
  30. <nav role="navigation">
  31. <!-- ========= START OF TOP NAVBAR ======= -->
  32. <div class="top-nav" id="navbar-top">
  33. <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div>
  34. <ul id="navbar-top-firstrow" class="nav-list" title="Navigation">
  35. <li><a href="../index.html">Overview</a></li>
  36. <li><a href="package-summary.html">Package</a></li>
  37. <li class="nav-bar-cell1-rev">Class</li>
  38. <li><a href="class-use/RectObject.html">Use</a></li>
  39. <li><a href="package-tree.html">Tree</a></li>
  40. <li><a href="../index-files/index-1.html">Index</a></li>
  41. <li><a href="../help-doc.html#class">Help</a></li>
  42. </ul>
  43. </div>
  44. <div class="sub-nav">
  45. <div>
  46. <ul class="sub-nav-list">
  47. <li>Summary:&nbsp;</li>
  48. <li>Nested&nbsp;|&nbsp;</li>
  49. <li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
  50. <li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
  51. <li><a href="#method-summary">Method</a></li>
  52. </ul>
  53. <ul class="sub-nav-list">
  54. <li>Detail:&nbsp;</li>
  55. <li>Field&nbsp;|&nbsp;</li>
  56. <li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</li>
  57. <li><a href="#method-detail">Method</a></li>
  58. </ul>
  59. </div>
  60. <div class="nav-list-search"><label for="search-input">SEARCH:</label>
  61. <input type="text" id="search-input" value="search" disabled="disabled">
  62. <input type="reset" id="reset-button" value="reset" disabled="disabled">
  63. </div>
  64. </div>
  65. <!-- ========= END OF TOP NAVBAR ========= -->
  66. <span class="skip-nav" id="skip-navbar-top"></span></nav>
  67. </header>
  68. <div class="flex-content">
  69. <main role="main">
  70. <!-- ======== START OF CLASS DATA ======== -->
  71. <div class="header">
  72. <div class="sub-title"><span class="package-label-in-type">Package</span>&nbsp;<a href="package-summary.html">gameobjects</a></div>
  73. <h1 title="Class RectObject" class="title">Class RectObject</h1>
  74. </div>
  75. <div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
  76. <div class="inheritance"><a href="GameObject.html" title="class in gameobjects">gameobjects.GameObject</a>
  77. <div class="inheritance">gameobjects.RectObject</div>
  78. </div>
  79. </div>
  80. <section class="class-description" id="class-description">
  81. <hr>
  82. <div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">RectObject</span>
  83. <span class="extends-implements">extends <a href="GameObject.html" title="class in gameobjects">GameObject</a></span></div>
  84. <div class="block">A rectangle object. <br>
  85. If <a href="#generateColliders()"><code>generateColliders()</code></a> is called, it generates a RectCollider with id-prefix
  86. "shotcollider_" and registers it for this RectObject.</div>
  87. </section>
  88. <section class="summary">
  89. <ul class="summary-list">
  90. <!-- =========== FIELD SUMMARY =========== -->
  91. <li>
  92. <section class="field-summary" id="field-summary">
  93. <h2>Field Summary</h2>
  94. <div class="inherited-list">
  95. <h3 id="fields-inherited-from-class-gameobjects.GameObject">Fields inherited from class&nbsp;gameobjects.<a href="GameObject.html" title="class in gameobjects">GameObject</a></h3>
  96. <code><a href="GameObject.html#id">id</a>, <a href="GameObject.html#MASK">MASK</a>, <a href="GameObject.html#RADIUS">RADIUS</a>, <a href="GameObject.html#RECTANGLE">RECTANGLE</a>, <a href="GameObject.html#scol">scol</a></code></div>
  97. </section>
  98. </li>
  99. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  100. <li>
  101. <section class="constructor-summary" id="constructor-summary">
  102. <h2>Constructor Summary</h2>
  103. <div class="caption"><span>Constructors</span></div>
  104. <div class="summary-table two-column-summary">
  105. <div class="table-header col-first">Constructor</div>
  106. <div class="table-header col-last">Description</div>
  107. <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,playground.Playground,double,double,double,double,double,double,java.awt.Color)" class="member-name-link">RectObject</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;id,
  108. <a href="../playground/Playground.html" title="class in playground">Playground</a>&nbsp;pg,
  109. double&nbsp;x,
  110. double&nbsp;y,
  111. double&nbsp;vx,
  112. double&nbsp;vy,
  113. double&nbsp;width,
  114. double&nbsp;height,
  115. <a href="https://docs.oracle.com/javase/8/docs/api/java/awt/Color.html" title="class or interface in java.awt" class="external-link">Color</a>&nbsp;color)</code></div>
  116. <div class="col-last even-row-color">
  117. <div class="block">Initializes the RectObject with a suitable RectArtist for drawing the RectObject.</div>
  118. </div>
  119. </div>
  120. </section>
  121. </li>
  122. <!-- ========== METHOD SUMMARY =========== -->
  123. <li>
  124. <section class="method-summary" id="method-summary">
  125. <h2>Method Summary</h2>
  126. <div id="method-summary-table">
  127. <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab4" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab4', 3)" class="table-tab">Concrete Methods</button></div>
  128. <div id="method-summary-table.tabpanel" role="tabpanel">
  129. <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
  130. <div class="table-header col-first">Modifier and Type</div>
  131. <div class="table-header col-second">Method</div>
  132. <div class="table-header col-last">Description</div>
  133. <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="RectObject.html" title="class in gameobjects">RectObject</a></code></div>
  134. <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#generateColliders()" class="member-name-link">generateColliders</a>()</code></div>
  135. <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
  136. <div class="block">generates a new <a href="../collider/RectCollider.html" title="class in collider"><code>RectCollider</code></a> with id-prefix "shotcollider_" and registers it for 'this'
  137. [@link RectObject}.</div>
  138. </div>
  139. <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
  140. <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getHeight()" class="member-name-link">getHeight</a>()</code></div>
  141. <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
  142. <div class="block">Getter for the height</div>
  143. </div>
  144. <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div>
  145. <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getWidth()" class="member-name-link">getWidth</a>()</code></div>
  146. <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
  147. <div class="block">Getter for the width</div>
  148. </div>
  149. </div>
  150. </div>
  151. </div>
  152. <div class="inherited-list">
  153. <h3 id="methods-inherited-from-class-gameobjects.GameObject">Methods inherited from class&nbsp;gameobjects.<a href="GameObject.html" title="class in gameobjects">GameObject</a></h3>
  154. <code><a href="GameObject.html#addArtist(rendering.Artist)">addArtist</a>, <a href="GameObject.html#addCollider(collider.Collider)">addCollider</a>, <a href="GameObject.html#addController(controller.ObjectController)">addController</a>, <a href="GameObject.html#collisionDetection(gameobjects.GameObject)">collisionDetection</a>, <a href="GameObject.html#draw(java.awt.Graphics2D)">draw</a>, <a href="GameObject.html#getGameTime()">getGameTime</a>, <a href="GameObject.html#getId()">getId</a>, <a href="GameObject.html#getObjectController()">getObjectController</a>, <a href="GameObject.html#getObjectFlag(java.lang.String)">getObjectFlag</a>, <a href="GameObject.html#getOrCreateObjectFlag(java.lang.String,java.lang.Object)">getOrCreateObjectFlag</a>, <a href="GameObject.html#getPlayground()">getPlayground</a>, <a href="GameObject.html#getVX()">getVX</a>, <a href="GameObject.html#getVY()">getVY</a>, <a href="GameObject.html#getX()">getX</a>, <a href="GameObject.html#getY()">getY</a>, <a href="GameObject.html#isActive()">isActive</a>, <a href="GameObject.html#setActive(boolean)">setActive</a>, <a href="GameObject.html#setColliders(java.util.LinkedList)">setColliders</a>, <a href="GameObject.html#setComponentProperty(java.lang.String,java.lang.String,java.lang.Object)">setComponentProperty</a>, <a href="GameObject.html#setObjectController(controller.ObjectController)">setObjectController</a>, <a href="GameObject.html#setObjectFlag(java.lang.String,java.lang.Object)">setObjectFlag</a>, <a href="GameObject.html#setPlayground(playground.Playground)">setPlayground</a>, <a href="GameObject.html#setVX(double)">setVX</a>, <a href="GameObject.html#setVY(double)">setVY</a>, <a href="GameObject.html#setX(double)">setX</a>, <a href="GameObject.html#setY(double)">setY</a>, <a href="GameObject.html#updateObject()">updateObject</a></code></div>
  155. <div class="inherited-list">
  156. <h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
  157. <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div>
  158. </section>
  159. </li>
  160. </ul>
  161. </section>
  162. <section class="details">
  163. <ul class="details-list">
  164. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  165. <li>
  166. <section class="constructor-details" id="constructor-detail">
  167. <h2>Constructor Details</h2>
  168. <ul class="member-list">
  169. <li>
  170. <section class="detail" id="&lt;init&gt;(java.lang.String,playground.Playground,double,double,double,double,double,double,java.awt.Color)">
  171. <h3>RectObject</h3>
  172. <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">RectObject</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html" title="class or interface in java.lang" class="external-link">String</a>&nbsp;id,
  173. <a href="../playground/Playground.html" title="class in playground">Playground</a>&nbsp;pg,
  174. double&nbsp;x,
  175. double&nbsp;y,
  176. double&nbsp;vx,
  177. double&nbsp;vy,
  178. double&nbsp;width,
  179. double&nbsp;height,
  180. <a href="https://docs.oracle.com/javase/8/docs/api/java/awt/Color.html" title="class or interface in java.awt" class="external-link">Color</a>&nbsp;color)</span></div>
  181. <div class="block">Initializes the RectObject with a suitable RectArtist for drawing the RectObject.</div>
  182. <dl class="notes">
  183. <dt>Parameters:</dt>
  184. <dd><code>id</code> - String unique name to be used.</dd>
  185. <dd><code>pg</code> - <a href="../playground/Playground.html" title="class in playground"><code>Playground</code></a> instance this RectObject belongs to (the level it belongs to).</dd>
  186. <dd><code>x</code> - position in horizontal direction in pixels (zero or positive number).</dd>
  187. <dd><code>y</code> - position in vertical direction in pixels (zero or positive number).</dd>
  188. <dd><code>vx</code> - speed/velocity in horizontal direction in pixels (negative, zero or positive number).</dd>
  189. <dd><code>vy</code> - speed/velocity in vertical direction in pixels (negative, zero or positive number).</dd>
  190. <dd><code>width</code> - in pixels</dd>
  191. <dd><code>height</code> - in pixels</dd>
  192. <dd><code>color</code> - solid color for the whole object, used to initialize an instance of
  193. <a href="../rendering/RectArtist.html" title="class in rendering"><code>RectArtist</code></a> used for this RectObject.</dd>
  194. </dl>
  195. </section>
  196. </li>
  197. </ul>
  198. </section>
  199. </li>
  200. <!-- ============ METHOD DETAIL ========== -->
  201. <li>
  202. <section class="method-details" id="method-detail">
  203. <h2>Method Details</h2>
  204. <ul class="member-list">
  205. <li>
  206. <section class="detail" id="generateColliders()">
  207. <h3>generateColliders</h3>
  208. <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="RectObject.html" title="class in gameobjects">RectObject</a></span>&nbsp;<span class="element-name">generateColliders</span>()</div>
  209. <div class="block">generates a new <a href="../collider/RectCollider.html" title="class in collider"><code>RectCollider</code></a> with id-prefix "shotcollider_" and registers it for 'this'
  210. [@link RectObject}. The <a href="../collider/RectCollider.html" title="class in collider"><code>RectCollider</code></a> uses the same dimensions (<code>width</code> and <code>height</code>) as this RectObject.</div>
  211. <dl class="notes">
  212. <dt>Overrides:</dt>
  213. <dd><code><a href="GameObject.html#generateColliders()">generateColliders</a></code>&nbsp;in class&nbsp;<code><a href="GameObject.html" title="class in gameobjects">GameObject</a></code></dd>
  214. <dt>Returns:</dt>
  215. <dd>this RectObject itself</dd>
  216. </dl>
  217. </section>
  218. </li>
  219. <li>
  220. <section class="detail" id="getWidth()">
  221. <h3>getWidth</h3>
  222. <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">getWidth</span>()</div>
  223. <div class="block">Getter for the width</div>
  224. <dl class="notes">
  225. <dt>Returns:</dt>
  226. <dd>double width value as set by constructor</dd>
  227. </dl>
  228. </section>
  229. </li>
  230. <li>
  231. <section class="detail" id="getHeight()">
  232. <h3>getHeight</h3>
  233. <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">getHeight</span>()</div>
  234. <div class="block">Getter for the height</div>
  235. <dl class="notes">
  236. <dt>Returns:</dt>
  237. <dd>double height value as set by constructor</dd>
  238. </dl>
  239. </section>
  240. </li>
  241. </ul>
  242. </section>
  243. </li>
  244. </ul>
  245. </section>
  246. <!-- ========= END OF CLASS DATA ========= -->
  247. </main>
  248. </div>
  249. </div>
  250. </body>
  251. </html>