|
|
<!DOCTYPE HTML><html lang="de"><head><!-- Generated by javadoc (17) on Thu May 12 14:50:21 CEST 2022 --><title>TextObject</title><meta name="viewport" content="width=device-width, initial-scale=1"><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="dc.created" content="2022-05-12"><meta name="description" content="declaration: package: gameobjects, class: TextObject"><meta name="generator" content="javadoc/ClassWriterImpl"><link rel="stylesheet" type="text/css" href="../stylesheet.css" title="Style"><link rel="stylesheet" type="text/css" href="../script-dir/jquery-ui.min.css" title="Style"><link rel="stylesheet" type="text/css" href="../jquery-ui.overrides.css" title="Style"><script type="text/javascript" src="../script.js"></script><script type="text/javascript" src="../script-dir/jquery-3.5.1.min.js"></script><script type="text/javascript" src="../script-dir/jquery-ui.min.js"></script></head><body class="class-declaration-page"><script type="text/javascript">var evenRowColor = "even-row-color";var oddRowColor = "odd-row-color";var tableTab = "table-tab";var activeTableTab = "active-table-tab";var pathtoroot = "../";loadScripts(document, 'script');</script><noscript><div>JavaScript is disabled on your browser.</div></noscript><div class="flex-box"><header role="banner" class="flex-header"><nav role="navigation"><!-- ========= START OF TOP NAVBAR ======= --><div class="top-nav" id="navbar-top"><div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div><ul id="navbar-top-firstrow" class="nav-list" title="Navigation"><li><a href="../index.html">Overview</a></li><li><a href="package-summary.html">Package</a></li><li class="nav-bar-cell1-rev">Class</li><li><a href="class-use/TextObject.html">Use</a></li><li><a href="package-tree.html">Tree</a></li><li><a href="../index-files/index-1.html">Index</a></li><li><a href="../help-doc.html#class">Help</a></li></ul></div><div class="sub-nav"><div><ul class="sub-nav-list"><li>Summary: </li><li>Nested | </li><li><a href="#field-summary">Field</a> | </li><li><a href="#constructor-summary">Constr</a> | </li><li><a href="#method-summary">Method</a></li></ul><ul class="sub-nav-list"><li>Detail: </li><li>Field | </li><li><a href="#constructor-detail">Constr</a> | </li><li><a href="#method-detail">Method</a></li></ul></div><div class="nav-list-search"><label for="search-input">SEARCH:</label><input type="text" id="search-input" value="search" disabled="disabled"><input type="reset" id="reset-button" value="reset" disabled="disabled"></div></div><!-- ========= END OF TOP NAVBAR ========= --><span class="skip-nav" id="skip-navbar-top"></span></nav></header><div class="flex-content"><main role="main"><!-- ======== START OF CLASS DATA ======== --><div class="header"><div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">gameobjects</a></div><h1 title="Class TextObject" class="title">Class TextObject</h1></div><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><div class="inheritance"><a href="GameObject.html" title="class in gameobjects">gameobjects.GameObject</a><div class="inheritance">gameobjects.TextObject</div></div></div><section class="class-description" id="class-description"><hr><div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">TextObject</span><span class="extends-implements">extends <a href="GameObject.html" title="class in gameobjects">GameObject</a></span></div><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 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 well. However, a single call to the overwritten method <a href="#generateColliders()"><code>generateColliders()</code></a> will in fact generate a <a href="../collider/RectCollider.html" title="class in collider"><code>RectCollider</code></a> of just the right size for the text.</div></section><section class="summary"><ul class="summary-list"><!-- =========== FIELD SUMMARY =========== --><li><section class="field-summary" id="field-summary"><h2>Field Summary</h2><div class="inherited-list"><h3 id="fields-inherited-from-class-gameobjects.GameObject">Fields inherited from class gameobjects.<a href="GameObject.html" title="class in gameobjects">GameObject</a></h3><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></section></li><!-- ======== CONSTRUCTOR SUMMARY ======== --><li><section class="constructor-summary" id="constructor-summary"><h2>Constructor Summary</h2><div class="caption"><span>Constructors</span></div><div class="summary-table two-column-summary"><div class="table-header col-first">Constructor</div><div class="table-header col-last">Description</div><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> id, <a href="../playground/Playground.html" title="class in playground">Playground</a> playground, double x, double y, double vx, double vy, <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> text, int size, <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> textColor)</code></div><div class="col-last even-row-color"><div class="block">Constructor.</div></div></div></section></li><!-- ========== METHOD SUMMARY =========== --><li><section class="method-summary" id="method-summary"><h2>Method Summary</h2><div id="method-summary-table"><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><div id="method-summary-table.tabpanel" role="tabpanel"><div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"><div class="table-header col-first">Modifier and Type</div><div class="table-header col-second">Method</div><div class="table-header col-last">Description</div><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><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><div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><div class="block">generates and sets collider(s) for this GameObject.</div></div><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><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><div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div><div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div><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> s)</code></div><div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div></div></div></div><div class="inherited-list"><h3 id="methods-inherited-from-class-gameobjects.GameObject">Methods inherited from class gameobjects.<a href="GameObject.html" title="class in gameobjects">GameObject</a></h3><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><div class="inherited-list"><h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class 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><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></section></li></ul></section><section class="details"><ul class="details-list"><!-- ========= CONSTRUCTOR DETAIL ======== --><li><section class="constructor-details" id="constructor-detail"><h2>Constructor Details</h2><ul class="member-list"><li><section class="detail" id="<init>(java.lang.String,playground.Playground,double,double,double,double,java.lang.String,int,java.awt.Color)"><h3>TextObject</h3><div class="member-signature"><span class="modifiers">public</span> <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> id, <a href="../playground/Playground.html" title="class in playground">Playground</a> playground, double x, double y, double vx, double vy, <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> text, int size, <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> textColor)</span></div><div class="block">Constructor.</div><dl class="notes"><dt>Parameters:</dt><dd><code>id</code> - object name</dd><dd><code>playground</code> - containing <a href="../playground/Playground.html" title="class in playground"><code>Playground</code></a> instance</dd><dd><code>x</code> - positionx</dd><dd><code>y</code> - positiony</dd><dd><code>vx</code> - speedx</dd><dd><code>vy</code> - speedy</dd><dd><code>size</code> - font size in Pixel</dd><dd><code>text</code> - String to be displayed</dd><dd><code>textColor</code> - text color, see java.awt.Color</dd></dl></section></li></ul></section></li><!-- ============ METHOD DETAIL ========== --><li><section class="method-details" id="method-detail"><h2>Method Details</h2><ul class="member-list"><li><section class="detail" id="getText()"><h3>getText</h3><div class="member-signature"><span class="modifiers">public</span> <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> <span class="element-name">getText</span>()</div></section></li><li><section class="detail" id="setText(java.lang.String)"><h3>setText</h3><div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <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> s)</span></div></section></li><li><section class="detail" id="generateColliders()"><h3>generateColliders</h3><div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="TextObject.html" title="class in gameobjects">TextObject</a></span> <span class="element-name">generateColliders</span>()</div><div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="GameObject.html#generateColliders()">GameObject</a></code></span></div><div class="block">generates and sets collider(s) for this GameObject. This implementation does nothing. Intended to be overridden by subclasses.</div><dl class="notes"><dt>Overrides:</dt><dd><code><a href="GameObject.html#generateColliders()">generateColliders</a></code> in class <code><a href="GameObject.html" title="class in gameobjects">GameObject</a></code></dd><dt>Returns:</dt><dd>instance of this GameObject (this).</dd></dl></section></li></ul></section></li></ul></section><!-- ========= END OF CLASS DATA ========= --></main></div></div></body></html>
|
