|
|
<!DOCTYPE HTML><html lang="de"><head><!-- Generated by javadoc (17) on Thu May 12 14:50:21 CEST 2022 --><title>EgoController</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: controller, class: EgoController"><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/EgoController.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>Field | </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">controller</a></div><h1 title="Class EgoController" class="title">Class EgoController</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="ObjectController.html" title="class in controller">controller.ObjectController</a><div class="inheritance">controller.EgoController</div></div></div><section class="class-description" id="class-description"><dl class="notes"><dt>Direct Known Subclasses:</dt><dd><code><a href="CollisionAwareEgoController.html" title="class in controller">CollisionAwareEgoController</a></code></dd></dl><hr><div class="type-signature"><span class="modifiers">public class </span><span class="element-name type-name-label">EgoController</span><span class="extends-implements">extends <a href="ObjectController.html" title="class in controller">ObjectController</a></span></div><div class="block">Controller using key events for up, down, left, right and space (shooting) to control the ego object behavior.</div></section><section class="summary"><ul class="summary-list"><!-- ======== 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(double)" class="member-name-link">EgoController</a><wbr>(double egoRad)</code></div><div class="col-last even-row-color"><div class="block">constructor that gives the ego controller a radius to stop the ego object when it reaches the level boundaries.</div></div><div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(double,double)" class="member-name-link">EgoController</a><wbr>(double width, double height)</code></div><div class="col-last odd-row-color"><div class="block">constructor that gives the ego controller a width and height to stop the ego object when it reaches the level boundaries.</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>void</code></div><div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#onDown(java.awt.event.KeyEvent,gameobjects.GameObject)" class="member-name-link">onDown</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/awt/event/KeyEvent.html" title="class or interface in java.awt.event" class="external-link">KeyEvent</a> kc, <a href="../gameobjects/GameObject.html" title="class in gameobjects">GameObject</a> ego)</code></div><div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div><div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div><div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#onLeft(java.awt.event.KeyEvent,gameobjects.GameObject)" class="member-name-link">onLeft</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/awt/event/KeyEvent.html" title="class or interface in java.awt.event" class="external-link">KeyEvent</a> kc, <a href="../gameobjects/GameObject.html" title="class in gameobjects">GameObject</a> ego)</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="#onRight(java.awt.event.KeyEvent,gameobjects.GameObject)" class="member-name-link">onRight</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/awt/event/KeyEvent.html" title="class or interface in java.awt.event" class="external-link">KeyEvent</a> kc, <a href="../gameobjects/GameObject.html" title="class in gameobjects">GameObject</a> ego)</code></div><div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div><div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div><div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#onSpace(java.awt.event.KeyEvent,gameobjects.GameObject)" class="member-name-link">onSpace</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/awt/event/KeyEvent.html" title="class or interface in java.awt.event" class="external-link">KeyEvent</a> e, <a href="../gameobjects/GameObject.html" title="class in gameobjects">GameObject</a> ego)</code></div><div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><div class="block">behavior for shooting on key space</div></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="#onStop(java.awt.event.KeyEvent,gameobjects.GameObject)" class="member-name-link">onStop</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/awt/event/KeyEvent.html" title="class or interface in java.awt.event" class="external-link">KeyEvent</a> kc, <a href="../gameobjects/GameObject.html" title="class in gameobjects">GameObject</a> ego)</code></div><div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> </div><div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div><div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#onUp(java.awt.event.KeyEvent,gameobjects.GameObject)" class="member-name-link">onUp</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/awt/event/KeyEvent.html" title="class or interface in java.awt.event" class="external-link">KeyEvent</a> kc, <a href="../gameobjects/GameObject.html" title="class in gameobjects">GameObject</a> ego)</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>boolean</code></div><div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#stopObject()" class="member-name-link">stopObject</a>()</code></div><div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><div class="block">checks the position and respects level boundaries and own radius or width/height set on constructor.</div></div><div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>void</code></div><div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#updateObject()" class="member-name-link">updateObject</a>()</code></div><div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><div class="block">updates position based on key events (mouse currently ignored)</div></div></div></div></div><div class="inherited-list"><h3 id="methods-inherited-from-class-controller.ObjectController">Methods inherited from class controller.<a href="ObjectController.html" title="class in controller">ObjectController</a></h3><code><a href="ObjectController.html#applySpeedVector()">applySpeedVector</a>, <a href="ObjectController.html#getPlayground()">getPlayground</a>, <a href="ObjectController.html#getTimestep()">getTimestep</a>, <a href="ObjectController.html#getVX()">getVX</a>, <a href="ObjectController.html#getVY()">getVY</a>, <a href="ObjectController.html#getX()">getX</a>, <a href="ObjectController.html#getY()">getY</a>, <a href="ObjectController.html#setDummy(java.lang.String)">setDummy</a>, <a href="ObjectController.html#setObject(gameobjects.GameObject)">setObject</a>, <a href="ObjectController.html#setPlayground(playground.Playground)">setPlayground</a>, <a href="ObjectController.html#setVX(double)">setVX</a>, <a href="ObjectController.html#setVY(double)">setVY</a>, <a href="ObjectController.html#setX(double)">setX</a>, <a href="ObjectController.html#setY(double)">setY</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>(double)"><h3>EgoController</h3><div class="member-signature"><span class="modifiers">public</span> <span class="element-name">EgoController</span><wbr><span class="parameters">(double egoRad)</span></div><div class="block">constructor that gives the ego controller a radius to stop the ego object when it reaches the level boundaries.</div><dl class="notes"><dt>Parameters:</dt><dd><code>egoRad</code> - radius to use as a boundary stop for level borders (usually use the same dimensions as your ego object)</dd></dl></section></li><li><section class="detail" id="<init>(double,double)"><h3>EgoController</h3><div class="member-signature"><span class="modifiers">public</span> <span class="element-name">EgoController</span><wbr><span class="parameters">(double width, double height)</span></div><div class="block">constructor that gives the ego controller a width and height to stop the ego object when it reaches the level boundaries.</div><dl class="notes"><dt>Parameters:</dt><dd><code>width</code> - width to use as a boundary stop for level borders (usually use the same dimensions as your ego object)</dd><dd><code>height</code> - height to use as a boundary stop for level borders (usually use the same dimensions as your ego object)</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="onUp(java.awt.event.KeyEvent,gameobjects.GameObject)"><h3>onUp</h3><div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">onUp</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/awt/event/KeyEvent.html" title="class or interface in java.awt.event" class="external-link">KeyEvent</a> kc, <a href="../gameobjects/GameObject.html" title="class in gameobjects">GameObject</a> ego)</span></div></section></li><li><section class="detail" id="onDown(java.awt.event.KeyEvent,gameobjects.GameObject)"><h3>onDown</h3><div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">onDown</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/awt/event/KeyEvent.html" title="class or interface in java.awt.event" class="external-link">KeyEvent</a> kc, <a href="../gameobjects/GameObject.html" title="class in gameobjects">GameObject</a> ego)</span></div></section></li><li><section class="detail" id="onLeft(java.awt.event.KeyEvent,gameobjects.GameObject)"><h3>onLeft</h3><div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">onLeft</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/awt/event/KeyEvent.html" title="class or interface in java.awt.event" class="external-link">KeyEvent</a> kc, <a href="../gameobjects/GameObject.html" title="class in gameobjects">GameObject</a> ego)</span></div></section></li><li><section class="detail" id="onRight(java.awt.event.KeyEvent,gameobjects.GameObject)"><h3>onRight</h3><div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">onRight</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/awt/event/KeyEvent.html" title="class or interface in java.awt.event" class="external-link">KeyEvent</a> kc, <a href="../gameobjects/GameObject.html" title="class in gameobjects">GameObject</a> ego)</span></div></section></li><li><section class="detail" id="onStop(java.awt.event.KeyEvent,gameobjects.GameObject)"><h3>onStop</h3><div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">onStop</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/awt/event/KeyEvent.html" title="class or interface in java.awt.event" class="external-link">KeyEvent</a> kc, <a href="../gameobjects/GameObject.html" title="class in gameobjects">GameObject</a> ego)</span></div></section></li><li><section class="detail" id="stopObject()"><h3>stopObject</h3><div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">stopObject</span>()</div><div class="block">checks the position and respects level boundaries and own radius or width/height set on constructor.</div><dl class="notes"><dt>Returns:</dt><dd>true if the object reached the boundaries of the level, false otherwise</dd></dl></section></li><li><section class="detail" id="onSpace(java.awt.event.KeyEvent,gameobjects.GameObject)"><h3>onSpace</h3><div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">onSpace</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/awt/event/KeyEvent.html" title="class or interface in java.awt.event" class="external-link">KeyEvent</a> e, <a href="../gameobjects/GameObject.html" title="class in gameobjects">GameObject</a> ego)</span></div><div class="block">behavior for shooting on key space</div><dl class="notes"><dt>Parameters:</dt><dd><code>e</code> - KeyEvent of the space key</dd><dd><code>ego</code> - EgoObject instance (used to determine position of shot object's start)</dd></dl></section></li><li><section class="detail" id="updateObject()"><h3>updateObject</h3><div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">updateObject</span>()</div><div class="block">updates position based on key events (mouse currently ignored)</div><dl class="notes"><dt>Specified by:</dt><dd><code><a href="ObjectController.html#updateObject()">updateObject</a></code> in class <code><a href="ObjectController.html" title="class in controller">ObjectController</a></code></dd></dl></section></li></ul></section></li></ul></section><!-- ========= END OF CLASS DATA ========= --></main></div></div></body></html>
|
