TorqueEngine
/
Torque2D
зеркало из https://github.com/TorqueGameEngines/Torque2D.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181
							<!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>TorqueScript Reference: NoiseGenerator 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="doxygen.css" rel="stylesheet" type="text/css" />
<link href="t2d-stylesheet-extra.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="projectalign">
   <div id="projectname">TorqueScript Reference
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<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&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',false,false,'search.php','Search');
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classNoiseGenerator-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">NoiseGenerator Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;NoiseGenerator_ScriptBinding.h&gt;</code></p>

<p>Inherits <a class="el" href="classScriptObject.html">ScriptObject</a>.</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:ab1ab5ba52a06ccee5e66a621115dfc91" id="r_ab1ab5ba52a06ccee5e66a621115dfc91"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNoiseGenerator.html#ab1ab5ba52a06ccee5e66a621115dfc91">getComplexNoise</a> (float x, float y, int octaves, float persistence)</td></tr>
<tr class="separator:ab1ab5ba52a06ccee5e66a621115dfc91"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a959eab316ec70798ac68a172c7d9c6ca" id="r_a959eab316ec70798ac68a172c7d9c6ca"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNoiseGenerator.html#a959eab316ec70798ac68a172c7d9c6ca">getNoise</a> (float x, float y)</td></tr>
<tr class="separator:a959eab316ec70798ac68a172c7d9c6ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b3d15f764006fc7a0e914945e9ac5e5" id="r_a0b3d15f764006fc7a0e914945e9ac5e5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classNoiseGenerator.html#a0b3d15f764006fc7a0e914945e9ac5e5">setSeed</a> (int seed)</td></tr>
<tr class="separator:a0b3d15f764006fc7a0e914945e9ac5e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ab1ab5ba52a06ccee5e66a621115dfc91" name="ab1ab5ba52a06ccee5e66a621115dfc91"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab1ab5ba52a06ccee5e66a621115dfc91">&#9670;&#160;</a></span>getComplexNoise()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> getComplexNoise </td>
          <td>(</td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>y</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>octaves</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>persistence</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Returns the noise for a given x and y value with multiple octaves applied. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">x</td><td>A floating point value. </td></tr>
    <tr><td class="paramname">y</td><td>A floating point value. </td></tr>
    <tr><td class="paramname">octaves</td><td>An integer value between 1 and 8. Each octave is a layer of progressively smaller noise that is applied to the final result. </td></tr>
    <tr><td class="paramname">persistence</td><td>A decimal value between 0.05 and 0.95. Larger values will cause each octave to have a larger impact on the final result. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A decimal value between 0 and 1. </dd></dl>

</div>
</div>
<a id="a959eab316ec70798ac68a172c7d9c6ca" name="a959eab316ec70798ac68a172c7d9c6ca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a959eab316ec70798ac68a172c7d9c6ca">&#9670;&#160;</a></span>getNoise()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__TorqueScriptTypes.html#ga3eec930799ce76daa315153278a4cdb2">Float</a> getNoise </td>
          <td>(</td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>x</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">float&#160;</td>
          <td class="paramname"><em>y</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Returns the noise for a given x and y value. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">x</td><td>A floating point value. </td></tr>
    <tr><td class="paramname">y</td><td>A floating point value. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A decimal value between 0 and 1. </dd></dl>

</div>
</div>
<a id="a0b3d15f764006fc7a0e914945e9ac5e5" name="a0b3d15f764006fc7a0e914945e9ac5e5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b3d15f764006fc7a0e914945e9ac5e5">&#9670;&#160;</a></span>setSeed()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__MetaScriptingFunctions.html#ga3428b441d74b14a5aed2f08490b4b9f3">void</a> setSeed </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>seed</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Sets the seed for the noise generater. </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">seed</td><td>An integer seed value. </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>No return value. </dd></dl>

</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by&#160;<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>