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.

237 lines
17 KiB

  1. <!DOCTYPE HTML>
  2. <html lang="de">
  3. <head>
  4. <!-- Generated by javadoc (17) on Fri Jun 17 12:42:43 CEST 2022 -->
  5. <title>TextObject</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-06-17">
  9. <meta name="description" content="declaration: package: gameobjects, class: TextObject">
  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/TextObject.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 TextObject" class="title">Class TextObject</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.TextObject</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">TextObject</span>
  83. <span class="extends-implements">extends <a href="GameObject.html" title="class in gameobjects">GameObject</a></span></div>
  84. <div class="block">Convenience Class subclassing <a href="GameObject.html" title="class in gameobjects"><code>GameObject</code></a>, directly instanciating <a href="../rendering/TextArtist.html" title="class in rendering"><code>TextArtist</code></a> a
  85. subclass of <a href="../rendering/Artist.html" title="class in rendering"><code>Artist</code></a> that draws a text. The controller is left undefined, the collider as
  86. well. However, a single call to the overwritten method <a href="#generateColliders()"><code>generateColliders()</code></a> will in fact
  87. generate a <a href="../collider/RectCollider.html" title="class in collider"><code>RectCollider</code></a> of just the right size for the text.</div>
  88. </section>
  89. <section class="summary">
  90. <ul class="summary-list">
  91. <!-- =========== FIELD SUMMARY =========== -->
  92. <li>
  93. <section class="field-summary" id="field-summary">
  94. <h2>Field Summary</h2>
  95. <div class="inherited-list">
  96. <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>
  97. <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>
  98. </section>
  99. </li>
  100. <!-- ======== CONSTRUCTOR SUMMARY ======== -->
  101. <li>
  102. <section class="constructor-summary" id="constructor-summary">
  103. <h2>Constructor Summary</h2>
  104. <div class="caption"><span>Constructors</span></div>
  105. <div class="summary-table two-column-summary">
  106. <div class="table-header col-first">Constructor</div>
  107. <div class="table-header col-last">Description</div>
  108. <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(java.lang.String,playground.Playground,double,double,double,double,java.lang.String,int,java.awt.Color)" class="member-name-link">TextObject</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,
  109. <a href="../playground/Playground.html" title="class in playground">Playground</a>&nbsp;playground,
  110. double&nbsp;x,
  111. double&nbsp;y,
  112. double&nbsp;vx,
  113. double&nbsp;vy,
  114. <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;text,
  115. int&nbsp;size,
  116. <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;textColor)</code></div>
  117. <div class="col-last even-row-color">
  118. <div class="block">Constructor.</div>
  119. </div>
  120. </div>
  121. </section>
  122. </li>
  123. <!-- ========== METHOD SUMMARY =========== -->
  124. <li>
  125. <section class="method-summary" id="method-summary">
  126. <h2>Method Summary</h2>
  127. <div id="method-summary-table">
  128. <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>
  129. <div id="method-summary-table.tabpanel" role="tabpanel">
  130. <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0">
  131. <div class="table-header col-first">Modifier and Type</div>
  132. <div class="table-header col-second">Method</div>
  133. <div class="table-header col-last">Description</div>
  134. <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="TextObject.html" title="class in gameobjects">TextObject</a></code></div>
  135. <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>
  136. <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
  137. <div class="block">generates and sets collider(s) for this GameObject.</div>
  138. </div>
  139. <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><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></code></div>
  140. <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getText()" class="member-name-link">getText</a>()</code></div>
  141. <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
  142. <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div>
  143. <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setText(java.lang.String)" class="member-name-link">setText</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;s)</code></div>
  144. <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">&nbsp;</div>
  145. </div>
  146. </div>
  147. </div>
  148. <div class="inherited-list">
  149. <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>
  150. <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>
  151. <div class="inherited-list">
  152. <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>
  153. <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>
  154. </section>
  155. </li>
  156. </ul>
  157. </section>
  158. <section class="details">
  159. <ul class="details-list">
  160. <!-- ========= CONSTRUCTOR DETAIL ======== -->
  161. <li>
  162. <section class="constructor-details" id="constructor-detail">
  163. <h2>Constructor Details</h2>
  164. <ul class="member-list">
  165. <li>
  166. <section class="detail" id="&lt;init&gt;(java.lang.String,playground.Playground,double,double,double,double,java.lang.String,int,java.awt.Color)">
  167. <h3>TextObject</h3>
  168. <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">TextObject</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,
  169. <a href="../playground/Playground.html" title="class in playground">Playground</a>&nbsp;playground,
  170. double&nbsp;x,
  171. double&nbsp;y,
  172. double&nbsp;vx,
  173. double&nbsp;vy,
  174. <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;text,
  175. int&nbsp;size,
  176. <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;textColor)</span></div>
  177. <div class="block">Constructor.</div>
  178. <dl class="notes">
  179. <dt>Parameters:</dt>
  180. <dd><code>id</code> - object name</dd>
  181. <dd><code>playground</code> - containing <a href="../playground/Playground.html" title="class in playground"><code>Playground</code></a> instance</dd>
  182. <dd><code>x</code> - positionx</dd>
  183. <dd><code>y</code> - positiony</dd>
  184. <dd><code>vx</code> - speedx</dd>
  185. <dd><code>vy</code> - speedy</dd>
  186. <dd><code>size</code> - font size in Pixel</dd>
  187. <dd><code>text</code> - String to be displayed</dd>
  188. <dd><code>textColor</code> - text color, see java.awt.Color</dd>
  189. </dl>
  190. </section>
  191. </li>
  192. </ul>
  193. </section>
  194. </li>
  195. <!-- ============ METHOD DETAIL ========== -->
  196. <li>
  197. <section class="method-details" id="method-detail">
  198. <h2>Method Details</h2>
  199. <ul class="member-list">
  200. <li>
  201. <section class="detail" id="getText()">
  202. <h3>getText</h3>
  203. <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><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></span>&nbsp;<span class="element-name">getText</span>()</div>
  204. </section>
  205. </li>
  206. <li>
  207. <section class="detail" id="setText(java.lang.String)">
  208. <h3>setText</h3>
  209. <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setText</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;s)</span></div>
  210. </section>
  211. </li>
  212. <li>
  213. <section class="detail" id="generateColliders()">
  214. <h3>generateColliders</h3>
  215. <div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type"><a href="TextObject.html" title="class in gameobjects">TextObject</a></span>&nbsp;<span class="element-name">generateColliders</span>()</div>
  216. <div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="GameObject.html#generateColliders()">GameObject</a></code></span></div>
  217. <div class="block">generates and sets collider(s) for this GameObject. This implementation does nothing. Intended
  218. to be overridden by subclasses.</div>
  219. <dl class="notes">
  220. <dt>Overrides:</dt>
  221. <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>
  222. <dt>Returns:</dt>
  223. <dd>instance of this GameObject (this).</dd>
  224. </dl>
  225. </section>
  226. </li>
  227. </ul>
  228. </section>
  229. </li>
  230. </ul>
  231. </section>
  232. <!-- ========= END OF CLASS DATA ========= -->
  233. </main>
  234. </div>
  235. </div>
  236. </body>
  237. </html>