|
|
<!DOCTYPE HTML><html lang="de"><head><!-- Generated by javadoc (17) on Fri Jun 03 11:30:18 CEST 2022 --><title>Collider</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-06-03"><meta name="description" content="declaration: package: collider, class: Collider"><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/Collider.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><a href="#field-detail">Field</a> | </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">collider</a></div><h1 title="Class Collider" class="title">Class Collider</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">collider.Collider</div></div><section class="class-description" id="class-description"><dl class="notes"><dt>Direct Known Subclasses:</dt><dd><code><a href="CircleCollider.html" title="class in collider">CircleCollider</a></code>, <code><a href="RectCollider.html" title="class in collider">RectCollider</a></code></dd></dl><hr><div class="type-signature"><span class="modifiers">public abstract class </span><span class="element-name type-name-label">Collider</span><span class="extends-implements">extends <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></span></div><div class="block">abstract base class for all Colliders to detect collisions between GameObjects</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="caption"><span>Fields</span></div><div class="summary-table three-column-summary"><div class="table-header col-first">Modifier and Type</div><div class="table-header col-second">Field</div><div class="table-header col-last">Description</div><div class="col-first even-row-color"><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 even-row-color"><code><a href="#id" class="member-name-link">id</a></code></div><div class="col-last even-row-color"><div class="block">unique internal name for Collider</div></div></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,gameobjects.GameObject)" class="member-name-link">Collider</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="../gameobjects/GameObject.html" title="class in gameobjects">GameObject</a> o)</code></div><div class="col-last even-row-color"> </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-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract 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-tab3"><code>abstract boolean</code></div><div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#collidesWith(collider.Collider)" class="member-name-link">collidesWith</a><wbr>(<a href="Collider.html" title="class in collider">Collider</a> other)</code></div><div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><div class="block">checks the collission with another collider instance.</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="#getId()" class="member-name-link">getId</a>()</code></div><div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><div class="block">returns the internal unique name</div></div><div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div><div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getX()" class="member-name-link">getX</a>()</code></div><div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><div class="block">returns the corresponding game objects X coordinate (center) plus this colliders offset in X (probably zero).</div></div><div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>double</code></div><div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getY()" class="member-name-link">getY</a>()</code></div><div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><div class="block">returns the corresponding game objects Y coordinate (center) plus this colliders offset in Y (probably zero).</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="#setController(controller.ObjectController)" class="member-name-link">setController</a><wbr>(<a href="../controller/ObjectController.html" title="class in controller">ObjectController</a> controller)</code></div><div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><div class="block">setter for GameController</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="#setObject(gameobjects.GameObject)" class="member-name-link">setObject</a><wbr>(<a href="../gameobjects/GameObject.html" title="class in gameobjects">GameObject</a> gameObject)</code></div><div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><div class="block">setter for corresponding GameObject</div></div><div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="Collider.html" title="class in collider">Collider</a></code></div><div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#setOffsets(double,double)" class="member-name-link">setOffsets</a><wbr>(double dx, double dy)</code></div><div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><div class="block">setter for offset values to be used relative to GameObject center. default is zero.</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="#setPlayground(playground.Playground)" class="member-name-link">setPlayground</a><wbr>(<a href="../playground/Playground.html" title="class in playground">Playground</a> playground)</code></div><div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><div class="block">setter for Playground instance this collider belongs to</div></div><div class="col-first even-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 even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toString()" class="member-name-link">toString</a>()</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-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#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"><!-- ============ FIELD DETAIL =========== --><li><section class="field-details" id="field-detail"><h2>Field Details</h2><ul class="member-list"><li><section class="detail" id="id"><h3>id</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">id</span></div><div class="block">unique internal name for Collider</div></section></li></ul></section></li><!-- ========= 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,gameobjects.GameObject)"><h3>Collider</h3><div class="member-signature"><span class="modifiers">public</span> <span class="element-name">Collider</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="../gameobjects/GameObject.html" title="class in gameobjects">GameObject</a> o)</span></div><dl class="notes"><dt>Parameters:</dt><dd><code>id</code> - unique name for Collider (internally)</dd><dd><code>o</code> - GameObject instance it belongs to</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="setOffsets(double,double)"><h3>setOffsets</h3><div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="Collider.html" title="class in collider">Collider</a></span> <span class="element-name">setOffsets</span><wbr><span class="parameters">(double dx, double dy)</span></div><div class="block">setter for offset values to be used relative to GameObject center. default is zero.</div><dl class="notes"><dt>Parameters:</dt><dd><code>dx</code> - offset in X direction (default 0)</dd><dd><code>dy</code> - offset in Y direction (default 0)</dd><dt>Returns:</dt><dd>this instance of Collider</dd></dl></section></li><li><section class="detail" id="toString()"><h3>toString</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">toString</span>()</div><dl class="notes"><dt>Overrides:</dt><dd><code><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></code> in class <code><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></code></dd></dl></section></li><li><section class="detail" id="getX()"><h3>getX</h3><div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getX</span>()</div><div class="block">returns the corresponding game objects X coordinate (center) plus this colliders offset in X (probably zero).</div><dl class="notes"><dt>Returns:</dt><dd>X value</dd></dl></section></li><li><section class="detail" id="getY()"><h3>getY</h3><div class="member-signature"><span class="modifiers">public</span> <span class="return-type">double</span> <span class="element-name">getY</span>()</div><div class="block">returns the corresponding game objects Y coordinate (center) plus this colliders offset in Y (probably zero).</div><dl class="notes"><dt>Returns:</dt><dd>Y value</dd></dl></section></li><li><section class="detail" id="getId()"><h3>getId</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">getId</span>()</div><div class="block">returns the internal unique name</div><dl class="notes"><dt>Returns:</dt><dd>the String with the name</dd></dl></section></li><li><section class="detail" id="setObject(gameobjects.GameObject)"><h3>setObject</h3><div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setObject</span><wbr><span class="parameters">(<a href="../gameobjects/GameObject.html" title="class in gameobjects">GameObject</a> gameObject)</span></div><div class="block">setter for corresponding GameObject</div><dl class="notes"><dt>Parameters:</dt><dd><code>gameObject</code> - to be saved in attribute</dd></dl></section></li><li><section class="detail" id="setController(controller.ObjectController)"><h3>setController</h3><div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setController</span><wbr><span class="parameters">(<a href="../controller/ObjectController.html" title="class in controller">ObjectController</a> controller)</span></div><div class="block">setter for GameController</div><dl class="notes"><dt>Parameters:</dt><dd><code>controller</code> - to be saved in attribute</dd></dl></section></li><li><section class="detail" id="setPlayground(playground.Playground)"><h3>setPlayground</h3><div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name">setPlayground</span><wbr><span class="parameters">(<a href="../playground/Playground.html" title="class in playground">Playground</a> playground)</span></div><div class="block">setter for Playground instance this collider belongs to</div><dl class="notes"><dt>Parameters:</dt><dd><code>playground</code> - instance to be stored in attribute</dd></dl></section></li><li><section class="detail" id="collidesWith(collider.Collider)"><h3>collidesWith</h3><div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">boolean</span> <span class="element-name">collidesWith</span><wbr><span class="parameters">(<a href="Collider.html" title="class in collider">Collider</a> other)</span></div><div class="block">checks the collission with another collider instance.</div><dl class="notes"><dt>Parameters:</dt><dd><code>other</code> - the instance to compare to</dd><dt>Returns:</dt><dd>true if the colliders collide (touch or overlap)</dd></dl></section></li></ul></section></li></ul></section><!-- ========= END OF CLASS DATA ========= --></main></div></div></body></html>
|
