Scissors-Website/public/javadoc/1.17.1/org/bukkit/util/noise/SimplexOctaveGenerator.html
2022-07-05 18:33:56 -05:00

340 lines
22 KiB
HTML

<!DOCTYPE HTML>
<html lang="en">
<head>
<!-- Generated by javadoc (17) -->
<title>SimplexOctaveGenerator (Scissors-API 1.17.1-R0.1-SNAPSHOT API)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta name="description" content="declaration: package: org.bukkit.util.noise, class: SimplexOctaveGenerator">
<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="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.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:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li><a href="#field-summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor-summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method-summary">Method</a></li>
</ul>
<ul class="sub-nav-list">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor-detail">Constr</a>&nbsp;|&nbsp;</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>&nbsp;<a href="package-summary.html">org.bukkit.util.noise</a></div>
<h1 title="Class SimplexOctaveGenerator" class="title">Class SimplexOctaveGenerator</h1>
</div>
<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">java.lang.Object</a>
<div class="inheritance"><a href="OctaveGenerator.html" title="class in org.bukkit.util.noise">org.bukkit.util.noise.OctaveGenerator</a>
<div class="inheritance">org.bukkit.util.noise.SimplexOctaveGenerator</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">SimplexOctaveGenerator</span>
<span class="extends-implements">extends <a href="OctaveGenerator.html" title="class in org.bukkit.util.noise">OctaveGenerator</a></span></div>
<div class="block">Creates simplex noise through unbiased octaves</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-org.bukkit.util.noise.OctaveGenerator">Fields inherited from class&nbsp;org.bukkit.util.noise.<a href="OctaveGenerator.html" title="class in org.bukkit.util.noise">OctaveGenerator</a></h3>
<code><a href="OctaveGenerator.html#octaves">octaves</a>, <a href="OctaveGenerator.html#xScale">xScale</a>, <a href="OctaveGenerator.html#yScale">yScale</a>, <a href="OctaveGenerator.html#zScale">zScale</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(long,int)" class="member-name-link">SimplexOctaveGenerator</a><wbr>(long&nbsp;seed,
int&nbsp;octaves)</code></div>
<div class="col-last even-row-color">
<div class="block">Creates a simplex octave generator for the given world</div>
</div>
<div class="col-constructor-name odd-row-color"><code><a href="#%3Cinit%3E(java.util.Random,int)" class="member-name-link">SimplexOctaveGenerator</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Random.html" title="class or interface in java.util" class="external-link">Random</a>&nbsp;rand,
int&nbsp;octaves)</code></div>
<div class="col-last odd-row-color">
<div class="block">Creates a simplex octave generator for the given <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Random.html" title="class or interface in java.util" class="external-link"><code>Random</code></a></div>
</div>
<div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E(org.bukkit.World,int)" class="member-name-link">SimplexOctaveGenerator</a><wbr>(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../../World.html" title="interface in org.bukkit">World</a>&nbsp;world,
int&nbsp;octaves)</code></div>
<div class="col-last even-row-color">
<div class="block">Creates a simplex octave generator for the given world</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>double</code></div>
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#getWScale()" class="member-name-link">getWScale</a>()</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Gets the scale used for each W-coordinates passed</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="#noise(double,double,double,double,double,double)" class="member-name-link">noise</a><wbr>(double&nbsp;x,
double&nbsp;y,
double&nbsp;z,
double&nbsp;w,
double&nbsp;frequency,
double&nbsp;amplitude)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Generates noise for the 3D coordinates using the specified number of
octaves and parameters</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="#noise(double,double,double,double,double,double,boolean)" class="member-name-link">noise</a><wbr>(double&nbsp;x,
double&nbsp;y,
double&nbsp;z,
double&nbsp;w,
double&nbsp;frequency,
double&nbsp;amplitude,
boolean&nbsp;normalized)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Generates noise for the 3D coordinates using the specified number of
octaves and parameters</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="#setScale(double)" class="member-name-link">setScale</a><wbr>(double&nbsp;scale)</code></div>
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the scale used for all coordinates passed to this generator.</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="#setWScale(double)" class="member-name-link">setWScale</a><wbr>(double&nbsp;scale)</code></div>
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4">
<div class="block">Sets the scale used for each W-coordinates passed</div>
</div>
</div>
</div>
</div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-org.bukkit.util.noise.OctaveGenerator">Methods inherited from class&nbsp;org.bukkit.util.noise.<a href="OctaveGenerator.html" title="class in org.bukkit.util.noise">OctaveGenerator</a></h3>
<code><a href="OctaveGenerator.html#getOctaves()">getOctaves</a>, <a href="OctaveGenerator.html#getXScale()">getXScale</a>, <a href="OctaveGenerator.html#getYScale()">getYScale</a>, <a href="OctaveGenerator.html#getZScale()">getZScale</a>, <a href="OctaveGenerator.html#noise(double,double,double)">noise</a>, <a href="OctaveGenerator.html#noise(double,double,double,boolean)">noise</a>, <a href="OctaveGenerator.html#noise(double,double,double,double)">noise</a>, <a href="OctaveGenerator.html#noise(double,double,double,double,boolean)">noise</a>, <a href="OctaveGenerator.html#noise(double,double,double,double,double)">noise</a>, <a href="OctaveGenerator.html#noise(double,double,double,double,double,boolean)">noise</a>, <a href="OctaveGenerator.html#setXScale(double)">setXScale</a>, <a href="OctaveGenerator.html#setYScale(double)">setYScale</a>, <a href="OctaveGenerator.html#setZScale(double)">setZScale</a></code></div>
<div class="inherited-list">
<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class&nbsp;java.lang.<a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html" title="class or interface in java.lang" class="external-link">Object</a></h3>
<code><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/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/en/java/javase/17/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/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="&lt;init&gt;(org.bukkit.World,int)">
<h3>SimplexOctaveGenerator</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">SimplexOctaveGenerator</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="../../World.html" title="interface in org.bukkit">World</a>&nbsp;world,
int&nbsp;octaves)</span></div>
<div class="block">Creates a simplex octave generator for the given world</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>world</code> - World to construct this generator for</dd>
<dd><code>octaves</code> - Amount of octaves to create</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(long,int)">
<h3>SimplexOctaveGenerator</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">SimplexOctaveGenerator</span><wbr><span class="parameters">(long&nbsp;seed,
int&nbsp;octaves)</span></div>
<div class="block">Creates a simplex octave generator for the given world</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>seed</code> - Seed to construct this generator for</dd>
<dd><code>octaves</code> - Amount of octaves to create</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="&lt;init&gt;(java.util.Random,int)">
<h3>SimplexOctaveGenerator</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="element-name">SimplexOctaveGenerator</span><wbr><span class="parameters">(<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a>
<a href="https://javadoc.io/doc/org.jetbrains/annotations/21.0.1/org/jetbrains/annotations/NotNull.html" title="class or interface in org.jetbrains.annotations" class="external-link">@NotNull</a> <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Random.html" title="class or interface in java.util" class="external-link">Random</a>&nbsp;rand,
int&nbsp;octaves)</span></div>
<div class="block">Creates a simplex octave generator for the given <a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Random.html" title="class or interface in java.util" class="external-link"><code>Random</code></a></div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>rand</code> - Random object to construct this generator for</dd>
<dd><code>octaves</code> - Amount of octaves to create</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="setScale(double)">
<h3>setScale</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setScale</span><wbr><span class="parameters">(double&nbsp;scale)</span></div>
<div class="block"><span class="descfrm-type-label">Description copied from class:&nbsp;<code><a href="OctaveGenerator.html#setScale(double)">OctaveGenerator</a></code></span></div>
<div class="block">Sets the scale used for all coordinates passed to this generator.
<p>
This is the equivalent to setting each coordinate to the specified
value.</div>
<dl class="notes">
<dt>Overrides:</dt>
<dd><code><a href="OctaveGenerator.html#setScale(double)">setScale</a></code>&nbsp;in class&nbsp;<code><a href="OctaveGenerator.html" title="class in org.bukkit.util.noise">OctaveGenerator</a></code></dd>
<dt>Parameters:</dt>
<dd><code>scale</code> - New value to scale each coordinate by</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="getWScale()">
<h3>getWScale</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">getWScale</span>()</div>
<div class="block">Gets the scale used for each W-coordinates passed</div>
<dl class="notes">
<dt>Returns:</dt>
<dd>W scale</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="setWScale(double)">
<h3>setWScale</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">void</span>&nbsp;<span class="element-name">setWScale</span><wbr><span class="parameters">(double&nbsp;scale)</span></div>
<div class="block">Sets the scale used for each W-coordinates passed</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>scale</code> - New W scale</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="noise(double,double,double,double,double,double)">
<h3>noise</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">noise</span><wbr><span class="parameters">(double&nbsp;x,
double&nbsp;y,
double&nbsp;z,
double&nbsp;w,
double&nbsp;frequency,
double&nbsp;amplitude)</span></div>
<div class="block">Generates noise for the 3D coordinates using the specified number of
octaves and parameters</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>x</code> - X-coordinate</dd>
<dd><code>y</code> - Y-coordinate</dd>
<dd><code>z</code> - Z-coordinate</dd>
<dd><code>w</code> - W-coordinate</dd>
<dd><code>frequency</code> - How much to alter the frequency by each octave</dd>
<dd><code>amplitude</code> - How much to alter the amplitude by each octave</dd>
<dt>Returns:</dt>
<dd>Resulting noise</dd>
</dl>
</section>
</li>
<li>
<section class="detail" id="noise(double,double,double,double,double,double,boolean)">
<h3>noise</h3>
<div class="member-signature"><span class="modifiers">public</span>&nbsp;<span class="return-type">double</span>&nbsp;<span class="element-name">noise</span><wbr><span class="parameters">(double&nbsp;x,
double&nbsp;y,
double&nbsp;z,
double&nbsp;w,
double&nbsp;frequency,
double&nbsp;amplitude,
boolean&nbsp;normalized)</span></div>
<div class="block">Generates noise for the 3D coordinates using the specified number of
octaves and parameters</div>
<dl class="notes">
<dt>Parameters:</dt>
<dd><code>x</code> - X-coordinate</dd>
<dd><code>y</code> - Y-coordinate</dd>
<dd><code>z</code> - Z-coordinate</dd>
<dd><code>w</code> - W-coordinate</dd>
<dd><code>frequency</code> - How much to alter the frequency by each octave</dd>
<dd><code>amplitude</code> - How much to alter the amplitude by each octave</dd>
<dd><code>normalized</code> - If true, normalize the value to [-1, 1]</dd>
<dt>Returns:</dt>
<dd>Resulting noise</dd>
</dl>
</section>
</li>
</ul>
</section>
</li>
</ul>
</section>
<!-- ========= END OF CLASS DATA ========= -->
</main>
</div>
</div>
</body>
</html>