Skip to content

Commit

Permalink
Correct docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@EliasHasle
EliasHasle committed Apr 12, 2023
1 parent a26d952 commit 184e987
Show file tree
Hide file tree
Showing 5 changed files with 126 additions and 92 deletions.
61 changes: 61 additions & 0 deletions docs/api/en/scenes/DensityFog.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<base href="../../../" />
<script src="page.js"></script>
<link type="text/css" rel="stylesheet" href="page.css" />
</head>
<body>
<h1>[name]</h1>

<p class="desc">This class contains the parameters that define exponential or exponential squared fog, which gives a clear view near the camera and an exponentially or faster than exponentially densening fog farther from the camera.</p>

<h2>Code Example</h2>

<code>const scene = new THREE.Scene();
scene.fog = new THREE.DensityFog( 0xcccccc, 0.002, true );
</code>

<h2>Constructor</h2>


<h3>[name]( [param:Integer color], [param:Float density], [param:bool squared] )</h3>

<p>The color parameter is passed to the [page:Color] constructor to set the color property. Color can be a hexadecimal integer or a CSS-style string.</p>
<h2>Properties</h2>

<h3>[property:Boolean isDensityFog]</h3>
<p>
Read-only flag to check if a given object is of type [name].
</p>

<h3>[property:String name]</h3>
<p>Optional name of the object (doesn't need to be unique). Default is an empty string.</p>

<h3>[property:Color color]</h3>
<p>Fog color. Example: If set to black, far away objects will be rendered black.</p>

<h3>[property:Float density]</h3>
<p>Defines how fast the fog will grow dense.</p>
<p>Default is 0.00025.</p>

<h3>[property:bool squared]</h3>
<p>Defines whether the product of density and distance is squared in the exponent.</p>
<p>Default is true.</p>

<h2>Methods</h2>

<h3>[method:DensityFog clone]()</h3>
<p>Returns a new DensityFog instance with the same parameters as this one.</p>

<h3>[method:Object toJSON]()</h3>
<p>Return DensityFog data in JSON format.</p>

<h2>Source</h2>

<p>
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
</p>
</body>
</html>
48 changes: 1 addition & 47 deletions docs/api/en/scenes/Fog.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,53 +9,7 @@
<body>
<h1>[name]</h1>

<p class="desc">This class contains the parameters that define linear fog, i.e., that grows linearly denser with the distance.</p>
<p class="desc">This class is deprecated. Use <a href="./RangeFog.html">RangeFog</a> instead.</p>

<h2>Code Example</h2>

<code>const scene = new THREE.Scene();
scene.fog = new THREE.Fog( 0xcccccc, 10, 15 );
</code>

<h2>Constructor</h2>


<h3>[name]( [param:Integer color], [param:Float near], [param:Float far] )</h3>
<p>The color parameter is passed to the [page:Color] constructor to set the color property. Color can be a hexadecimal integer or a CSS-style string.</p>

<h2>Properties</h2>

<h3>[property:Boolean isFog]</h3>
<p>
Read-only flag to check if a given object is of type [name].
</p>

<h3>[property:String name]</h3>
<p>Optional name of the object (doesn't need to be unique). Default is an empty string.</p>

<h3>[property:Color color]</h3>
<p>Fog color. Example: If set to black, far away objects will be rendered black.</p>

<h3>[property:Float near]</h3>
<p>The minimum distance to start applying fog. Objects that are less than 'near' units from the active camera won't be affected by fog.</p>
<p>Default is 1.</p>

<h3>[property:Float far]</h3>
<p>The maximum distance at which fog stops being calculated and applied. Objects that are more than 'far' units away from the active camera won't be affected by fog.</p>
<p>Default is 1000.</p>

<h2>Methods</h2>

<h3>[method:Fog clone]()</h3>
<p>Returns a new fog instance with the same parameters as this one.</p>

<h3>[method:Object toJSON]()</h3>
<p>Return fog data in JSON format.</p>

<h2>Source</h2>

<p>
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
</p>
</body>
</html>
44 changes: 1 addition & 43 deletions docs/api/en/scenes/FogExp2.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,49 +9,7 @@
<body>
<h1>[name]</h1>

<p class="desc">This class contains the parameters that define exponential squared fog, which gives a clear view near the camera and a faster than exponentially densening fog farther from the camera.</p>
<p class="desc">This class is deprecated. Use <a href="./DensityFog.html">DensityFog</a> instead.</p>

<h2>Code Example</h2>

<code>const scene = new THREE.Scene();
scene.fog = new THREE.FogExp2( 0xcccccc, 0.002 );
</code>

<h2>Constructor</h2>


<h3>[name]( [param:Integer color], [param:Float density] )</h3>

<p>The color parameter is passed to the [page:Color] constructor to set the color property. Color can be a hexadecimal integer or a CSS-style string.</p>
<h2>Properties</h2>

<h3>[property:Boolean isFogExp2]</h3>
<p>
Read-only flag to check if a given object is of type [name].
</p>

<h3>[property:String name]</h3>
<p>Optional name of the object (doesn't need to be unique). Default is an empty string.</p>

<h3>[property:Color color]</h3>
<p>Fog color. Example: If set to black, far away objects will be rendered black.</p>

<h3>[property:Float density]</h3>
<p>Defines how fast the fog will grow dense.</p>
<p>Default is 0.00025.</p>

<h2>Methods</h2>

<h3>[method:FogExp2 clone]()</h3>
<p>Returns a new FogExp2 instance with the same parameters as this one.</p>

<h3>[method:Object toJSON]()</h3>
<p>Return FogExp2 data in JSON format.</p>

<h2>Source</h2>

<p>
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
</p>
</body>
</html>
61 changes: 61 additions & 0 deletions docs/api/en/scenes/RangeFog.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<base href="../../../" />
<script src="page.js"></script>
<link type="text/css" rel="stylesheet" href="page.css" />
</head>
<body>
<h1>[name]</h1>

<p class="desc">This class contains the parameters that define smooth ranged fog, i.e., that grows smoothly denser from the near to the far distance. The dependence on distance is not linear, but follows a smoothstep curve.</p>

<h2>Code Example</h2>

<code>const scene = new THREE.Scene();
scene.fog = new THREE.RangeFog( 0xcccccc, 10, 15 );
</code>

<h2>Constructor</h2>


<h3>[name]( [param:Integer color], [param:Float near], [param:Float far] )</h3>
<p>The color parameter is passed to the [page:Color] constructor to set the color property. Color can be a hexadecimal integer or a CSS-style string.</p>

<h2>Properties</h2>

<h3>[property:Boolean isRangeFog]</h3>
<p>
Read-only flag to check if a given object is of type [name].
</p>

<h3>[property:String name]</h3>
<p>Optional name of the object (doesn't need to be unique). Default is an empty string.</p>

<h3>[property:Color color]</h3>
<p>Fog color. Example: If set to black, far away objects will be rendered black.</p>

<h3>[property:Float near]</h3>
<p>The minimum distance to start applying fog. Objects that are less than 'near' units from the active camera won't be affected by fog.</p>
<p>Default is 1.</p>

<h3>[property:Float far]</h3>
<p>The maximum distance at which fog stops being calculated and applied. Objects that are more than 'far' units away from the active camera won't be affected by fog.</p>
<p>Default is 1000.</p>

<h2>Methods</h2>

<h3>[method:RangeFog clone]()</h3>
<p>Returns a new RangeFog instance with the same parameters as this one.</p>

<h3>[method:Object toJSON]()</h3>
<p>Return RangeFog data in JSON format.</p>

<h2>Source</h2>

<p>
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
</p>
</body>
</html>
4 changes: 2 additions & 2 deletions docs/list.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -300,8 +300,8 @@
},

"Scenes": {
"Fog": "api/en/scenes/Fog",
"FogExp2": "api/en/scenes/FogExp2",
"RangeFog": "api/en/scenes/RangeFog",
"DensityFog": "api/en/scenes/DensityFog",
"Scene": "api/en/scenes/Scene"
},

Expand Down

0 comments on commit 184e987

Please sign in to comment.