Skip to content

Commit 61b1289

Browse files
committed
edit overview
1 parent ea65672 commit 61b1289

File tree

3 files changed

+104
-4
lines changed

3 files changed

+104
-4
lines changed

doc/tutorial-overview.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ NOTE: This section and the rest of this page will largely discuss the 2.0.0-beta
2323
<a id=Contents></a>
2424
## Contents
2525

26-
[Public-Domain HTML 3D Library](#Public_Domain_HTML_3D_Library)<br>[Example](#Example)<br>[Contents](#Contents)<br>[How to Use](#How_to_Use)<br>&nbsp;&nbsp;[List of Classes](#List_of_Classes)<br>&nbsp;&nbsp;[`H3DU.Scene3D`](#H3DU_Scene3D)<br>&nbsp;&nbsp;[The "Camera"](#The_Camera)<br>&nbsp;&nbsp;[3D Models](#3D_Models)<br>&nbsp;&nbsp;[Shapes](#Shapes)<br>&nbsp;&nbsp;[The Render Loop](#The_Render_Loop)<br>[A Skeleton for 3D Apps](#A_Skeleton_for_3D_Apps)<br>[Demos](#Demos)<br>&nbsp;&nbsp;[Simple Demos](#Simple_Demos)<br>&nbsp;&nbsp;[Materials](#Materials)<br>&nbsp;&nbsp;[Shapes and meshes](#Shapes_and_meshes)<br>&nbsp;&nbsp;[Paths](#Paths)<br>&nbsp;&nbsp;[Curves and Surfaces](#Curves_and_Surfaces)<br>&nbsp;&nbsp;[Textures](#Textures)<br>&nbsp;&nbsp;[Shaders](#Shaders)<br>&nbsp;&nbsp;[Particle Systems](#Particle_Systems)<br>&nbsp;&nbsp;[Loading 3D Models](#Loading_3D_Models)<br>&nbsp;&nbsp;[Selecting Objects](#Selecting_Objects)<br>&nbsp;&nbsp;[Lights](#Lights)<br>&nbsp;&nbsp;[Text](#Text)<br>&nbsp;&nbsp;[Projections](#Projections)<br>&nbsp;&nbsp;[Miscellaneous](#Miscellaneous)<br>[Example](#Example)<br>[History](#History)<br>&nbsp;&nbsp;[Version 2.0.0-beta2](#Version_2_0_0_beta2)<br>&nbsp;&nbsp;[Version 2.0.0-beta1:](#Version_2_0_0_beta1)<br>
26+
[Public-Domain HTML 3D Library](#Public_Domain_HTML_3D_Library)<br>[Example](#Example)<br>[Contents](#Contents)<br>[How to Use](#How_to_Use)<br>&nbsp;&nbsp;[List of Classes](#List_of_Classes)<br>&nbsp;&nbsp;[`H3DU.Scene3D`](#H3DU_Scene3D)<br>&nbsp;&nbsp;[The "Camera"](#The_Camera)<br>&nbsp;&nbsp;[3D Models](#3D_Models)<br>&nbsp;&nbsp;[Shapes](#Shapes)<br>&nbsp;&nbsp;[The Render Loop](#The_Render_Loop)<br>[A Skeleton for 3D Apps](#A_Skeleton_for_3D_Apps)<br>[Demos](#Demos)<br>&nbsp;&nbsp;[Simple Demos](#Simple_Demos)<br>&nbsp;&nbsp;[Materials](#Materials)<br>&nbsp;&nbsp;[Shapes and meshes](#Shapes_and_meshes)<br>&nbsp;&nbsp;[Paths](#Paths)<br>&nbsp;&nbsp;[Curves and Surfaces](#Curves_and_Surfaces)<br>&nbsp;&nbsp;[Textures](#Textures)<br>&nbsp;&nbsp;[Shaders](#Shaders)<br>&nbsp;&nbsp;[Particle Systems](#Particle_Systems)<br>&nbsp;&nbsp;[Loading 3D Models](#Loading_3D_Models)<br>&nbsp;&nbsp;[Selecting Objects](#Selecting_Objects)<br>&nbsp;&nbsp;[Lights](#Lights)<br>&nbsp;&nbsp;[Text](#Text)<br>&nbsp;&nbsp;[Projections](#Projections)<br>&nbsp;&nbsp;[Miscellaneous](#Miscellaneous)<br>[Example](#Example)<br>[History](#History)<br>&nbsp;&nbsp;[Version 2.0.0-beta3](#Version_2_0_0_beta3)<br>&nbsp;&nbsp;[Version 2.0.0-beta2](#Version_2_0_0_beta2)<br>&nbsp;&nbsp;[Version 2.0.0-beta1:](#Version_2_0_0_beta1)<br>
2727

2828
## How to Use
2929

@@ -399,6 +399,40 @@ The following is a simple example of an HTML page that uses the HTML 3D library.
399399
<a id=History></a>
400400
## History
401401

402+
<a id=Version_2_0_0_beta3></a>
403+
### Version 2.0.0-beta3
404+
405+
The changes in beta 3 from beta 2 include:
406+
407+
- The main library files were converted to ECMAScript's import/export convention. The `rollup` tool
408+
is used to help generate the `h3du_min.js` file.
409+
- HTML documentation included in distribution.
410+
- "Norm" methods in H3DU.Math were renamed to use "Normalize" instead.
411+
- New `convex.js` in extras folder generates the convex hull of a set of points.
412+
- New `interp.js` in extras folder provides a cubic B&eacute;zier interpolation function.
413+
- New `spline.js` in extras folder generates piecewise interpolating curves.
414+
- New demos added, including demos showing how to generate procedural content using shaders.
415+
- Several methods in H3DU.GraphicsPath were reimplemented.
416+
- H3DU.BezierCurve and H3DU.BezierSpline are deprecated.
417+
- H3DU.CurveBuilder and H3DU.SurfaceBuilder classes were created; they replace now-deprecated
418+
H3DU.CurveEval and H3DU.SurfaceEval classes.
419+
- H3DU.MeshBuffer contains many new methods; in exchange, many of the H3DU.Mesh
420+
methods reimplemented in H3DU.MeshBuffer are deprecated.
421+
- H3DU.Mesh is considerably deemphasized in this version; that class should only be used
422+
for building meshes, not storing them.
423+
- H3DU.Curve and H3DU.Surface were created; these classes represent parametric curves
424+
and surfaces and offer methods for querying information at a given point on the curve or surface.
425+
Made several class derive from either class, including H3DU.BSplineCurve, H3DU.BSplineSurface,
426+
and new class H3DU.PiecewiseCurve.
427+
- H3DU.RenderPass3D renamed to H3DU.RenderPass.
428+
- Deleted fromBasic and fromBasicTexture methods from H3DU.PbrMaterial.
429+
- Added JOINTS and WEIGHTS constants to H3DU.Semantic.
430+
- Preliminary support for occlusion maps.
431+
- Default diffuse/albedo in Material and PbrMaterial is now (1,1,1,1).
432+
- New H3DU.BufferAccessor class represents a single vertex buffer.
433+
- Many methods outside H3DU.Mesh now return H3DU.MeshBuffer instead of H3DU.Mesh.
434+
- Bug fixes.
435+
402436
<a id=Version_2_0_0_beta2></a>
403437
### Version 2.0.0-beta2
404438

dochtml/tutorial-overview.html

Lines changed: 34 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ <h2>Public-Domain HTML 3D Library</h2><p>This page will introduce the <a href="h
77
<p><a id=Example></a></p>
88
<h2>Example</h2><p><img src="https://peteroupc.github.io/html3dutil/html3d.png" alt=""></p>
99
<p><a id=Contents></a></p>
10-
<h2>Contents</h2><p><a href="#Public_Domain_HTML_3D_Library">Public-Domain HTML 3D Library</a><br><a href="#Example">Example</a><br><a href="#Contents">Contents</a><br><a href="#How_to_Use">How to Use</a><br>&nbsp;&nbsp;<a href="#List_of_Classes">List of Classes</a><br>&nbsp;&nbsp;<a href="#H3DU_Scene3D"><code>H3DU.Scene3D</code></a><br>&nbsp;&nbsp;<a href="#The_Camera">The &quot;Camera&quot;</a><br>&nbsp;&nbsp;<a href="#3D_Models">3D Models</a><br>&nbsp;&nbsp;<a href="#Shapes">Shapes</a><br>&nbsp;&nbsp;<a href="#The_Render_Loop">The Render Loop</a><br><a href="#A_Skeleton_for_3D_Apps">A Skeleton for 3D Apps</a><br><a href="#Demos">Demos</a><br>&nbsp;&nbsp;<a href="#Simple_Demos">Simple Demos</a><br>&nbsp;&nbsp;<a href="#Materials">Materials</a><br>&nbsp;&nbsp;<a href="#Shapes_and_meshes">Shapes and meshes</a><br>&nbsp;&nbsp;<a href="#Paths">Paths</a><br>&nbsp;&nbsp;<a href="#Curves_and_Surfaces">Curves and Surfaces</a><br>&nbsp;&nbsp;<a href="#Textures">Textures</a><br>&nbsp;&nbsp;<a href="#Shaders">Shaders</a><br>&nbsp;&nbsp;<a href="#Particle_Systems">Particle Systems</a><br>&nbsp;&nbsp;<a href="#Loading_3D_Models">Loading 3D Models</a><br>&nbsp;&nbsp;<a href="#Selecting_Objects">Selecting Objects</a><br>&nbsp;&nbsp;<a href="#Lights">Lights</a><br>&nbsp;&nbsp;<a href="#Text">Text</a><br>&nbsp;&nbsp;<a href="#Projections">Projections</a><br>&nbsp;&nbsp;<a href="#Miscellaneous">Miscellaneous</a><br><a href="#Example">Example</a><br><a href="#History">History</a><br>&nbsp;&nbsp;<a href="#Version_2_0_0_beta2">Version 2.0.0-beta2</a><br>&nbsp;&nbsp;<a href="#Version_2_0_0_beta1">Version 2.0.0-beta1:</a><br></p>
10+
<h2>Contents</h2><p><a href="#Public_Domain_HTML_3D_Library">Public-Domain HTML 3D Library</a><br><a href="#Example">Example</a><br><a href="#Contents">Contents</a><br><a href="#How_to_Use">How to Use</a><br>&nbsp;&nbsp;<a href="#List_of_Classes">List of Classes</a><br>&nbsp;&nbsp;<a href="#H3DU_Scene3D"><code>H3DU.Scene3D</code></a><br>&nbsp;&nbsp;<a href="#The_Camera">The &quot;Camera&quot;</a><br>&nbsp;&nbsp;<a href="#3D_Models">3D Models</a><br>&nbsp;&nbsp;<a href="#Shapes">Shapes</a><br>&nbsp;&nbsp;<a href="#The_Render_Loop">The Render Loop</a><br><a href="#A_Skeleton_for_3D_Apps">A Skeleton for 3D Apps</a><br><a href="#Demos">Demos</a><br>&nbsp;&nbsp;<a href="#Simple_Demos">Simple Demos</a><br>&nbsp;&nbsp;<a href="#Materials">Materials</a><br>&nbsp;&nbsp;<a href="#Shapes_and_meshes">Shapes and meshes</a><br>&nbsp;&nbsp;<a href="#Paths">Paths</a><br>&nbsp;&nbsp;<a href="#Curves_and_Surfaces">Curves and Surfaces</a><br>&nbsp;&nbsp;<a href="#Textures">Textures</a><br>&nbsp;&nbsp;<a href="#Shaders">Shaders</a><br>&nbsp;&nbsp;<a href="#Particle_Systems">Particle Systems</a><br>&nbsp;&nbsp;<a href="#Loading_3D_Models">Loading 3D Models</a><br>&nbsp;&nbsp;<a href="#Selecting_Objects">Selecting Objects</a><br>&nbsp;&nbsp;<a href="#Lights">Lights</a><br>&nbsp;&nbsp;<a href="#Text">Text</a><br>&nbsp;&nbsp;<a href="#Projections">Projections</a><br>&nbsp;&nbsp;<a href="#Miscellaneous">Miscellaneous</a><br><a href="#Example">Example</a><br><a href="#History">History</a><br>&nbsp;&nbsp;<a href="#Version_2_0_0_beta3">Version 2.0.0-beta3</a><br>&nbsp;&nbsp;<a href="#Version_2_0_0_beta2">Version 2.0.0-beta2</a><br>&nbsp;&nbsp;<a href="#Version_2_0_0_beta1">Version 2.0.0-beta1:</a><br></p>
1111
<h2>How to Use</h2><ol>
1212
<li><a href="https://github.com/peteroupc/html3dutil/releases"><strong>Download the HTML 3D library</strong></a>.</li>
1313
<li><p>Extract the file <i>&quot;h3du_min.js&quot;</i>, and write the following code in every HTML page where you will use the library.</p>
@@ -318,7 +318,39 @@ <h2>Example</h2><p>The following is a simple example of an HTML page that uses t
318318
//-->
319319
&lt;/script>
320320
&lt;/body></code></pre><p><a id=History></a></p>
321-
<h2>History</h2><p><a id=Version_2_0_0_beta2></a></p>
321+
<h2>History</h2><p><a id=Version_2_0_0_beta3></a></p>
322+
<h3>Version 2.0.0-beta3</h3><p>The changes in beta 3 from beta 2 include:</p>
323+
<ul>
324+
<li>The main library files were converted to ECMAScript's import/export convention. The <code>rollup</code> tool
325+
is used to help generate the <code>h3du_min.js</code> file.</li>
326+
<li>HTML documentation included in distribution.</li>
327+
<li>&quot;Norm&quot; methods in H3DU.Math were renamed to use &quot;Normalize&quot; instead.</li>
328+
<li>New <code>convex.js</code> in extras folder generates the convex hull of a set of points.</li>
329+
<li>New <code>interp.js</code> in extras folder provides a cubic B&eacute;zier interpolation function.</li>
330+
<li>New <code>spline.js</code> in extras folder generates piecewise interpolating curves.</li>
331+
<li>New demos added, including demos showing how to generate procedural content using shaders.</li>
332+
<li>Several methods in H3DU.GraphicsPath were reimplemented.</li>
333+
<li>H3DU.BezierCurve and H3DU.BezierSpline are deprecated.</li>
334+
<li>H3DU.CurveBuilder and H3DU.SurfaceBuilder classes were created; they replace now-deprecated
335+
H3DU.CurveEval and H3DU.SurfaceEval classes.</li>
336+
<li>H3DU.MeshBuffer contains many new methods; in exchange, many of the H3DU.Mesh
337+
methods reimplemented in H3DU.MeshBuffer are deprecated.</li>
338+
<li>H3DU.Mesh is considerably deemphasized in this version; that class should only be used
339+
for building meshes, not storing them.</li>
340+
<li>H3DU.Curve and H3DU.Surface were created; these classes represent parametric curves
341+
and surfaces and offer methods for querying information at a given point on the curve or surface.
342+
Made several class derive from either class, including H3DU.BSplineCurve, H3DU.BSplineSurface,
343+
and new class H3DU.PiecewiseCurve.</li>
344+
<li>H3DU.RenderPass3D renamed to H3DU.RenderPass.</li>
345+
<li>Deleted fromBasic and fromBasicTexture methods from H3DU.PbrMaterial.</li>
346+
<li>Added JOINTS and WEIGHTS constants to H3DU.Semantic.</li>
347+
<li>Preliminary support for occlusion maps.</li>
348+
<li>Default diffuse/albedo in Material and PbrMaterial is now (1,1,1,1).</li>
349+
<li>New H3DU.BufferAccessor class represents a single vertex buffer.</li>
350+
<li>Many methods outside H3DU.Mesh now return H3DU.MeshBuffer instead of H3DU.Mesh.</li>
351+
<li>Bug fixes.</li>
352+
</ul>
353+
<p><a id=Version_2_0_0_beta2></a></p>
322354
<h3>Version 2.0.0-beta2</h3><p>The changes in beta 2 from beta 1 include:</p>
323355
<ul>
324356
<li>Added H3DU.PbrMaterial class and supported physically-based shading in the default shader.</li>

tutorials/overview.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ NOTE: This section and the rest of this page will largely discuss the 2.0.0-beta
1919
<a id=Contents></a>
2020
## Contents
2121

22-
[Public-Domain HTML 3D Library](#Public_Domain_HTML_3D_Library)<br>[Example](#Example)<br>[Contents](#Contents)<br>[How to Use](#How_to_Use)<br>&nbsp;&nbsp;[List of Classes](#List_of_Classes)<br>&nbsp;&nbsp;[`H3DU.Scene3D`](#H3DU_Scene3D)<br>&nbsp;&nbsp;[The "Camera"](#The_Camera)<br>&nbsp;&nbsp;[3D Models](#3D_Models)<br>&nbsp;&nbsp;[Shapes](#Shapes)<br>&nbsp;&nbsp;[The Render Loop](#The_Render_Loop)<br>[A Skeleton for 3D Apps](#A_Skeleton_for_3D_Apps)<br>[Demos](#Demos)<br>&nbsp;&nbsp;[Simple Demos](#Simple_Demos)<br>&nbsp;&nbsp;[Materials](#Materials)<br>&nbsp;&nbsp;[Shapes and meshes](#Shapes_and_meshes)<br>&nbsp;&nbsp;[Paths](#Paths)<br>&nbsp;&nbsp;[Curves and Surfaces](#Curves_and_Surfaces)<br>&nbsp;&nbsp;[Textures](#Textures)<br>&nbsp;&nbsp;[Shaders](#Shaders)<br>&nbsp;&nbsp;[Particle Systems](#Particle_Systems)<br>&nbsp;&nbsp;[Loading 3D Models](#Loading_3D_Models)<br>&nbsp;&nbsp;[Selecting Objects](#Selecting_Objects)<br>&nbsp;&nbsp;[Lights](#Lights)<br>&nbsp;&nbsp;[Text](#Text)<br>&nbsp;&nbsp;[Projections](#Projections)<br>&nbsp;&nbsp;[Miscellaneous](#Miscellaneous)<br>[Example](#Example)<br>[History](#History)<br>&nbsp;&nbsp;[Version 2.0.0-beta2](#Version_2_0_0_beta2)<br>&nbsp;&nbsp;[Version 2.0.0-beta1:](#Version_2_0_0_beta1)<br>
22+
[Public-Domain HTML 3D Library](#Public_Domain_HTML_3D_Library)<br>[Example](#Example)<br>[Contents](#Contents)<br>[How to Use](#How_to_Use)<br>&nbsp;&nbsp;[List of Classes](#List_of_Classes)<br>&nbsp;&nbsp;[`H3DU.Scene3D`](#H3DU_Scene3D)<br>&nbsp;&nbsp;[The "Camera"](#The_Camera)<br>&nbsp;&nbsp;[3D Models](#3D_Models)<br>&nbsp;&nbsp;[Shapes](#Shapes)<br>&nbsp;&nbsp;[The Render Loop](#The_Render_Loop)<br>[A Skeleton for 3D Apps](#A_Skeleton_for_3D_Apps)<br>[Demos](#Demos)<br>&nbsp;&nbsp;[Simple Demos](#Simple_Demos)<br>&nbsp;&nbsp;[Materials](#Materials)<br>&nbsp;&nbsp;[Shapes and meshes](#Shapes_and_meshes)<br>&nbsp;&nbsp;[Paths](#Paths)<br>&nbsp;&nbsp;[Curves and Surfaces](#Curves_and_Surfaces)<br>&nbsp;&nbsp;[Textures](#Textures)<br>&nbsp;&nbsp;[Shaders](#Shaders)<br>&nbsp;&nbsp;[Particle Systems](#Particle_Systems)<br>&nbsp;&nbsp;[Loading 3D Models](#Loading_3D_Models)<br>&nbsp;&nbsp;[Selecting Objects](#Selecting_Objects)<br>&nbsp;&nbsp;[Lights](#Lights)<br>&nbsp;&nbsp;[Text](#Text)<br>&nbsp;&nbsp;[Projections](#Projections)<br>&nbsp;&nbsp;[Miscellaneous](#Miscellaneous)<br>[Example](#Example)<br>[History](#History)<br>&nbsp;&nbsp;[Version 2.0.0-beta3](#Version_2_0_0_beta3)<br>&nbsp;&nbsp;[Version 2.0.0-beta2](#Version_2_0_0_beta2)<br>&nbsp;&nbsp;[Version 2.0.0-beta1:](#Version_2_0_0_beta1)<br>
2323

2424
## How to Use
2525

@@ -395,6 +395,40 @@ The following is a simple example of an HTML page that uses the HTML 3D library.
395395
<a id=History></a>
396396
## History
397397

398+
<a id=Version_2_0_0_beta3></a>
399+
### Version 2.0.0-beta3
400+
401+
The changes in beta 3 from beta 2 include:
402+
403+
- The main library files were converted to ECMAScript's import/export convention. The `rollup` tool
404+
is used to help generate the `h3du_min.js` file.
405+
- HTML documentation included in distribution.
406+
- "Norm" methods in H3DU.Math were renamed to use "Normalize" instead.
407+
- New `convex.js` in extras folder generates the convex hull of a set of points.
408+
- New `interp.js` in extras folder provides a cubic B&eacute;zier interpolation function.
409+
- New `spline.js` in extras folder generates piecewise interpolating curves.
410+
- New demos added, including demos showing how to generate procedural content using shaders.
411+
- Several methods in H3DU.GraphicsPath were reimplemented.
412+
- H3DU.BezierCurve and H3DU.BezierSpline are deprecated.
413+
- H3DU.CurveBuilder and H3DU.SurfaceBuilder classes were created; they replace now-deprecated
414+
H3DU.CurveEval and H3DU.SurfaceEval classes.
415+
- H3DU.MeshBuffer contains many new methods; in exchange, many of the H3DU.Mesh
416+
methods reimplemented in H3DU.MeshBuffer are deprecated.
417+
- H3DU.Mesh is considerably deemphasized in this version; that class should only be used
418+
for building meshes, not storing them.
419+
- H3DU.Curve and H3DU.Surface were created; these classes represent parametric curves
420+
and surfaces and offer methods for querying information at a given point on the curve or surface.
421+
Made several class derive from either class, including H3DU.BSplineCurve, H3DU.BSplineSurface,
422+
and new class H3DU.PiecewiseCurve.
423+
- H3DU.RenderPass3D renamed to H3DU.RenderPass.
424+
- Deleted fromBasic and fromBasicTexture methods from H3DU.PbrMaterial.
425+
- Added JOINTS and WEIGHTS constants to H3DU.Semantic.
426+
- Preliminary support for occlusion maps.
427+
- Default diffuse/albedo in Material and PbrMaterial is now (1,1,1,1).
428+
- New H3DU.BufferAccessor class represents a single vertex buffer.
429+
- Many methods outside H3DU.Mesh now return H3DU.MeshBuffer instead of H3DU.Mesh.
430+
- Bug fixes.
431+
398432
<a id=Version_2_0_0_beta2></a>
399433
### Version 2.0.0-beta2
400434

0 commit comments

Comments
 (0)