216 lines
13 KiB
HTML
216 lines
13 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
|
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
|
|
<meta name="generator" content="Doxygen 1.9.8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
|
<title>Nano Brain for Unity: ClusterPrefab Class Reference</title>
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="jquery.js"></script>
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/searchdata.js"></script>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
|
<link href="custom_doxygen.css" rel="stylesheet" type="text/css"/>
|
|
</head>
|
|
<body>
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
|
<div id="titlearea">
|
|
<table cellspacing="0" cellpadding="0">
|
|
<tbody>
|
|
<tr id="projectrow">
|
|
<td id="projectlogo"><img alt="Logo" src="PasserLifeLogoRight1_300.png"/></td>
|
|
<td id="projectalign">
|
|
<div id="projectname">Nano Brain for Unity<span id="projectnumber"> v0.1</span>
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.9.8 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
var searchBox = new SearchBox("searchBox", "search/",'.html');
|
|
/* @license-end */
|
|
</script>
|
|
<script type="text/javascript" src="menudata.js"></script>
|
|
<script type="text/javascript" src="menu.js"></script>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
</div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<div id="MSearchResults">
|
|
<div class="SRPage">
|
|
<div id="SRIndex">
|
|
<div id="SRResults"></div>
|
|
<div class="SRStatus" id="Loading">Loading...</div>
|
|
<div class="SRStatus" id="Searching">Searching...</div>
|
|
<div class="SRStatus" id="NoMatches">No Matches</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="summary">
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
|
<a href="#properties">Properties</a> |
|
|
<a href="class_cluster_prefab-members.html">List of all members</a> </div>
|
|
<div class="headertitle"><div class="title">ClusterPrefab Class Reference</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
|
|
<div class="textblock"><p>The Unity ScriptableObject to implement re-usable Cluster Prefabs. </p>
|
|
</div>
|
|
<p>Inherits ScriptableObject.</p>
|
|
<table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
|
|
Public Member Functions</h2></td></tr>
|
|
<tr class="memitem:a1a2d6d6afe059d333c32f01e54fdfbd9" id="r_a1a2d6d6afe059d333c32f01e54fdfbd9"><td class="memItemLeft" align="right" valign="top"><a id="a1a2d6d6afe059d333c32f01e54fdfbd9" name="a1a2d6d6afe059d333c32f01e54fdfbd9"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>RefreshOutputs</b> ()</td></tr>
|
|
<tr class="memdesc:a1a2d6d6afe059d333c32f01e54fdfbd9"><td class="mdescLeft"> </td><td class="mdescRight">Redetermine the outpus in the cluster. <br /></td></tr>
|
|
<tr class="separator:a1a2d6d6afe059d333c32f01e54fdfbd9"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:afea0b6fbf8c88fa1818bcaafbe6e28ae" id="r_afea0b6fbf8c88fa1818bcaafbe6e28ae"><td class="memItemLeft" align="right" valign="top">Nucleus </td><td class="memItemRight" valign="bottom"><a class="el" href="class_cluster_prefab.html#afea0b6fbf8c88fa1818bcaafbe6e28ae">GetNucleus</a> (string nucleusName)</td></tr>
|
|
<tr class="memdesc:afea0b6fbf8c88fa1818bcaafbe6e28ae"><td class="mdescLeft"> </td><td class="mdescRight">Retrieve a nucleus in this cluster. <br /></td></tr>
|
|
<tr class="separator:afea0b6fbf8c88fa1818bcaafbe6e28ae"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab1d682c6f7d4feb12361fc427fe754b8" id="r_ab1d682c6f7d4feb12361fc427fe754b8"><td class="memItemLeft" align="right" valign="top"><a id="ab1d682c6f7d4feb12361fc427fe754b8" name="ab1d682c6f7d4feb12361fc427fe754b8"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>EnsureInitialization</b> ()</td></tr>
|
|
<tr class="separator:ab1d682c6f7d4feb12361fc427fe754b8"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a3060fbfe1e6bc1ac11ccb8398d40d930" id="r_a3060fbfe1e6bc1ac11ccb8398d40d930"><td class="memItemLeft" align="right" valign="top"><a id="a3060fbfe1e6bc1ac11ccb8398d40d930" name="a3060fbfe1e6bc1ac11ccb8398d40d930"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>GarbageCollection</b> ()</td></tr>
|
|
<tr class="separator:a3060fbfe1e6bc1ac11ccb8398d40d930"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a5f8ade90547d1117d4e2889e4f6a86b3" id="r_a5f8ade90547d1117d4e2889e4f6a86b3"><td class="memItemLeft" align="right" valign="top"><a id="a5f8ade90547d1117d4e2889e4f6a86b3" name="a5f8ade90547d1117d4e2889e4f6a86b3"></a>
|
|
void </td><td class="memItemRight" valign="bottom"><b>MarkNuclei</b> (HashSet< Nucleus > visitedNuclei, Nucleus nucleus)</td></tr>
|
|
<tr class="separator:a5f8ade90547d1117d4e2889e4f6a86b3"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ac1ca7d3519511ab015f32cdddc4a74d2" id="r_ac1ca7d3519511ab015f32cdddc4a74d2"><td class="memItemLeft" align="right" valign="top"><a id="ac1ca7d3519511ab015f32cdddc4a74d2" name="ac1ca7d3519511ab015f32cdddc4a74d2"></a>
|
|
virtual void </td><td class="memItemRight" valign="bottom"><b>UpdateNuclei</b> ()</td></tr>
|
|
<tr class="separator:ac1ca7d3519511ab015f32cdddc4a74d2"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a6b6beeaed81cd7a7dd47f5697b55f22a" id="r_a6b6beeaed81cd7a7dd47f5697b55f22a"><td class="memItemLeft" align="right" valign="top"><a id="a6b6beeaed81cd7a7dd47f5697b55f22a" name="a6b6beeaed81cd7a7dd47f5697b55f22a"></a>
|
|
int </td><td class="memItemRight" valign="bottom"><b>GetNucleusIndex</b> (Nucleus receiver)</td></tr>
|
|
<tr class="separator:a6b6beeaed81cd7a7dd47f5697b55f22a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-attribs" name="pub-attribs"></a>
|
|
Public Attributes</h2></td></tr>
|
|
<tr class="memitem:af91b34c42671a2fcf8ada53092f6d049" id="r_af91b34c42671a2fcf8ada53092f6d049"><td class="memItemLeft" align="right" valign="top"><a id="af91b34c42671a2fcf8ada53092f6d049" name="af91b34c42671a2fcf8ada53092f6d049"></a>
|
|
List< Nucleus > </td><td class="memItemRight" valign="bottom"><b>nuclei</b> = new()</td></tr>
|
|
<tr class="memdesc:af91b34c42671a2fcf8ada53092f6d049"><td class="mdescLeft"> </td><td class="mdescRight">The nuclei in this cluster. <br /></td></tr>
|
|
<tr class="separator:af91b34c42671a2fcf8ada53092f6d049"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:ab4ab1fc84b7fd66697648d4ea716eab5" id="r_ab4ab1fc84b7fd66697648d4ea716eab5"><td class="memItemLeft" align="right" valign="top">List< Nucleus > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_cluster_prefab.html#ab4ab1fc84b7fd66697648d4ea716eab5">_inputs</a> = null</td></tr>
|
|
<tr class="memdesc:ab4ab1fc84b7fd66697648d4ea716eab5"><td class="mdescLeft"> </td><td class="mdescRight">The nuclei in this cluster which are meant for receiving signals from outside the cluster. <br /></td></tr>
|
|
<tr class="separator:ab4ab1fc84b7fd66697648d4ea716eab5"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table><table class="memberdecls">
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="properties" name="properties"></a>
|
|
Properties</h2></td></tr>
|
|
<tr class="memitem:aca02fa55908743f977d72aea0a0a7045" id="r_aca02fa55908743f977d72aea0a0a7045"><td class="memItemLeft" align="right" valign="top">virtual Nucleus </td><td class="memItemRight" valign="bottom"><a class="el" href="class_cluster_prefab.html#aca02fa55908743f977d72aea0a0a7045">output</a><code> [get]</code></td></tr>
|
|
<tr class="memdesc:aca02fa55908743f977d72aea0a0a7045"><td class="mdescLeft"> </td><td class="mdescRight">The output of this cluster. <br /></td></tr>
|
|
<tr class="separator:aca02fa55908743f977d72aea0a0a7045"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a23c87e1fa8cf969055a50053a00b2a15" id="r_a23c87e1fa8cf969055a50053a00b2a15"><td class="memItemLeft" align="right" valign="top"><a id="a23c87e1fa8cf969055a50053a00b2a15" name="a23c87e1fa8cf969055a50053a00b2a15"></a>
|
|
virtual List< Nucleus > </td><td class="memItemRight" valign="bottom"><b>inputs</b><code> [get]</code></td></tr>
|
|
<tr class="separator:a23c87e1fa8cf969055a50053a00b2a15"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a4881c711dae95b5afd6daf408244fa1d" id="r_a4881c711dae95b5afd6daf408244fa1d"><td class="memItemLeft" align="right" valign="top"><a id="a4881c711dae95b5afd6daf408244fa1d" name="a4881c711dae95b5afd6daf408244fa1d"></a>
|
|
List< Nucleus > </td><td class="memItemRight" valign="bottom"><b>outputs</b><code> [get]</code></td></tr>
|
|
<tr class="separator:a4881c711dae95b5afd6daf408244fa1d"><td class="memSeparator" colspan="2"> </td></tr>
|
|
</table>
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
|
<a id="afea0b6fbf8c88fa1818bcaafbe6e28ae" name="afea0b6fbf8c88fa1818bcaafbe6e28ae"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#afea0b6fbf8c88fa1818bcaafbe6e28ae">◆ </a></span>GetNucleus()</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">Nucleus ClusterPrefab.GetNucleus </td>
|
|
<td>(</td>
|
|
<td class="paramtype">string </td>
|
|
<td class="paramname"><em>nucleusName</em></td><td>)</td>
|
|
<td></td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Retrieve a nucleus in this cluster. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">nucleusName</td><td>The name of the nucleus</td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<dl class="section return"><dt>Returns</dt><dd>The Nucleus with the given name or null if no such Nucleus could be found</dd></dl>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
|
<a id="ab4ab1fc84b7fd66697648d4ea716eab5" name="ab4ab1fc84b7fd66697648d4ea716eab5"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ab4ab1fc84b7fd66697648d4ea716eab5">◆ </a></span>_inputs</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">List<Nucleus> ClusterPrefab._inputs = null</td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The nuclei in this cluster which are meant for receiving signals from outside the cluster. </p>
|
|
<p><remark>This is currently the nuclei which do not have any incoming synapse</remark> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<h2 class="groupheader">Property Documentation</h2>
|
|
<a id="aca02fa55908743f977d72aea0a0a7045" name="aca02fa55908743f977d72aea0a0a7045"></a>
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aca02fa55908743f977d72aea0a0a7045">◆ </a></span>output</h2>
|
|
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname">virtual Nucleus ClusterPrefab.output</td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
<td class="mlabels-right">
|
|
<span class="mlabels"><span class="mlabel">get</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>The output of this cluster. </p>
|
|
<p><deprecated>This only returens the first(default) nucleus. Use outputs[0] instead</deprecated> </p>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>/home/pascal/Development/Projects/Passer/NanoBrain/NanoBrain/Assets/NanoBrain-unitypackage/Runtime/Scripts/<b>ClusterPrefab.cs</b></li>
|
|
</ul>
|
|
</div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8
|
|
</small></address>
|
|
</body>
|
|
</html>
|