|
|
<!DOCTYPE HTML><html lang="de"><head><!-- Generated by javadoc (17) on Fri Jun 03 11:30:18 CEST 2022 --><title>CircleCollider</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: CircleCollider"><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/CircleCollider.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">collider</a></div><h1 title="Class CircleCollider" class="title">Class CircleCollider</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="Collider.html" title="class in collider">collider.Collider</a><div class="inheritance">collider.CircleCollider</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">CircleCollider</span><span class="extends-implements">extends <a href="Collider.html" title="class in collider">Collider</a></span></div><div class="block">Collider for round objects</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-collider.Collider">Fields inherited from class collider.<a href="Collider.html" title="class in collider">Collider</a></h3><code><a href="Collider.html#id">id</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,gameobjects.GameObject,double)" class="member-name-link">CircleCollider</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, double radius)</code></div><div class="col-last even-row-color"><div class="block">Constructor which sets the radius to be respected for collisions.</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>boolean</code></div><div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#checkCollisionCircCirc(collider.Collider)" class="member-name-link">checkCollisionCircCirc</a><wbr>(<a href="Collider.html" title="class in collider">Collider</a> _c2)</code></div><div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><div class="block">calculates the collission of this with other collider</div></div><div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>boolean</code></div><div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><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 odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><div class="block">checks the collission with another collider instance.</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 class="block">simple concatenation of all attributes (x,y,r)</div></div></div></div></div><div class="inherited-list"><h3 id="methods-inherited-from-class-collider.Collider">Methods inherited from class collider.<a href="Collider.html" title="class in collider">Collider</a></h3><code><a href="Collider.html#getId()">getId</a>, <a href="Collider.html#getX()">getX</a>, <a href="Collider.html#getY()">getY</a>, <a href="Collider.html#setController(controller.ObjectController)">setController</a>, <a href="Collider.html#setObject(gameobjects.GameObject)">setObject</a>, <a href="Collider.html#setOffsets(double,double)">setOffsets</a>, <a href="Collider.html#setPlayground(playground.Playground)">setPlayground</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#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,gameobjects.GameObject,double)"><h3>CircleCollider</h3><div class="member-signature"><span class="modifiers">public</span> <span class="element-name">CircleCollider</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, double radius)</span></div><div class="block">Constructor which sets the radius to be respected for collisions.</div><dl class="notes"><dt>Parameters:</dt><dd><code>id</code> - String unique name for the collider instance</dd><dd><code>o</code> - GameObject it belongs to</dd><dd><code>radius</code> - radius in pixels to use as a size</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="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><div class="block">simple concatenation of all attributes (x,y,r)</div><dl class="notes"><dt>Overrides:</dt><dd><code><a href="Collider.html#toString()">toString</a></code> in class <code><a href="Collider.html" title="class in collider">Collider</a></code></dd></dl></section></li><li><section class="detail" id="checkCollisionCircCirc(collider.Collider)"><h3>checkCollisionCircCirc</h3><div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name">checkCollisionCircCirc</span><wbr><span class="parameters">(<a href="Collider.html" title="class in collider">Collider</a> _c2)</span> throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></span></div><div class="block">calculates the collission of this with other collider</div><dl class="notes"><dt>Parameters:</dt><dd><code>_c2</code> - the other collider</dd><dt>Returns:</dt><dd>true if a collision was detected</dd><dt>Throws:</dt><dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html" title="class or interface in java.lang" class="external-link">Exception</a></code> - in case the math operations are invalid (due to illegal values of x y or radius)</dd></dl></section></li><li><section class="detail" id="collidesWith(collider.Collider)"><h3>collidesWith</h3><div class="member-signature"><span class="modifiers">public</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"><span class="descfrm-type-label">Description copied from class: <code><a href="Collider.html#collidesWith(collider.Collider)">Collider</a></code></span></div><div class="block">checks the collission with another collider instance.</div><dl class="notes"><dt>Specified by:</dt><dd><code><a href="Collider.html#collidesWith(collider.Collider)">collidesWith</a></code> in class <code><a href="Collider.html" title="class in collider">Collider</a></code></dd><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>
|
