Fixed indentation and case
[qbasicapps.git] / graphics / 3D / 3D Synthezier / doc / index.html
index 959d12f..9286272 100644 (file)
@@ -2,14 +2,14 @@
 <html lang="en">
 <head>
 <title>3D Synthezier</title>
-<!-- 2018-06-20 Wed 16:08 -->
+<!-- 2019-01-20 Sun 03:19 -->
 <meta charset="utf-8">
 <meta name="viewport" content="width=device-width, initial-scale=1">
 <meta name="generator" content="Org-mode">
 <meta name="author" content="Svjatoslav Agejenko">
-<link href="https://bootswatch.com/4/darkly/bootstrap.min.css" rel="stylesheet">
-<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
-<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.1/js/bootstrap.min.js"></script>"
+<link href="https://bootswatch.com/3/darkly/bootstrap.min.css" rel="stylesheet">
+<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
+<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/3.3.5/js/bootstrap.min.js"></script>
 <style type="text/css">
 footer {background-color: #111 !important;}
 pre {background-color: #111; color: #ccc;}
@@ -196,12 +196,60 @@ $(function() {
 <body>
 <div id="content" class="container">
 <div class="row"><div class="col-md-9"><h1 class="title">3D Synthezier</h1>
-<hr >
+
+<div id="outline-container-sec-1" class="outline-2">
+<h2 id="sec-1"><span class="section-number-2">1</span> General</h2>
+<div class="outline-text-2" id="text-1">
 <ul class="org-ul">
 <li>This software is part of <a href="../../../../index.html">QBasic apps package</a>.
 </li>
+
+<li>This program is free software: you can redistribute it and/or modify
+it under the terms of the <a href="https://www.gnu.org/licenses/lgpl.html">GNU Lesser General Public License</a> as
+published by the Free Software Foundation, either version 3 of the
+License, or (at your option) any later version.
+</li>
+
+<li>Program author:
+<ul class="org-ul">
+<li>Svjatoslav Agejenko
+</li>
+<li>Homepage: <a href="http://svjatoslav.eu">http://svjatoslav.eu</a>
+</li>
+<li>Email: <a href="mailto://svjatoslav@svjatoslav.eu">mailto://svjatoslav@svjatoslav.eu</a>
+</li>
+</ul>
+</li>
+
+<li><a href="https://www.svjatoslav.eu/projects/">Other software projects hosted at svjatoslav.eu</a>
+</li>
 </ul>
+</div>
 
+<div id="outline-container-sec-1-1" class="outline-3">
+<h3 id="sec-1-1"><span class="section-number-3">1.1</span> Source code</h3>
+<div class="outline-text-3" id="text-1-1">
+<ul class="org-ul">
+<li><a href="https://www2.svjatoslav.eu/gitweb/?p=qbasicapps.git;a=snapshot;h=HEAD;sf=tgz">Download latest snapshot in TAR GZ format</a>
+</li>
+
+<li><a href="https://www2.svjatoslav.eu/gitweb/?p=qbasicapps.git;a=summary">Browse Git repository online</a>
+</li>
+
+<li>Clone Git repository using command:
+<pre class="example">
+git clone https://www2.svjatoslav.eu/git/qbasicapps.git
+
+</pre>
+</li>
+</ul>
+</div>
+</div>
+</div>
+
+<div id="outline-container-sec-2" class="outline-2">
+<h2 id="sec-2"><span class="section-number-2">2</span> Operating principle</h2>
+<div class="outline-text-2" id="text-2">
 <p>
 Parses scene definition language and creates 3D world based on
 it. Result will be in a <a href="https://en.wikipedia.org/wiki/Wavefront_.obj_file">wavefront obj file</a>, witch can be then
@@ -224,10 +272,12 @@ Objects with all its subobjects can be rotated, mirrored or resized
 omong any axis. Generator has built in cache for data input and output
 to minimize file access.
 </p>
+</div>
+</div>
 
-<div id="outline-container-sec-1" class="outline-2">
-<h2 id="sec-1"><span class="section-number-2">1</span> System requirements</h2>
-<div class="outline-text-2" id="text-1">
+<div id="outline-container-sec-3" class="outline-2">
+<h2 id="sec-3"><span class="section-number-2">3</span> System requirements</h2>
+<div class="outline-text-2" id="text-3">
 <table class="table table-striped table-bordered table-hover table-condensed">
 
 
@@ -239,7 +289,7 @@ to minimize file access.
 <thead>
 <tr>
 <th scope="col" class="text-left">software</th>
-<th scope="col" class="text-right">preferred version</th>
+<th scope="col" class="text-right">tested version</th>
 </tr>
 </thead>
 <tbody>
@@ -256,9 +306,9 @@ to minimize file access.
 </table>
 </div>
 </div>
-<div id="outline-container-sec-2" class="outline-2">
-<h2 id="sec-2"><span class="section-number-2">2</span> Installation</h2>
-<div class="outline-text-2" id="text-2">
+<div id="outline-container-sec-4" class="outline-2">
+<h2 id="sec-4"><span class="section-number-2">4</span> Installation</h2>
+<div class="outline-text-2" id="text-4">
 <ul class="org-ul">
 <li>Unpack ZIP file in any folder.
 </li>
@@ -266,9 +316,9 @@ to minimize file access.
 </li>
 </ul>
 </div>
-<div id="outline-container-sec-2-0-1" class="outline-4">
-<h4 id="sec-2-0-1"><span class="section-number-4">2.0.1</span> Directory layout</h4>
-<div class="outline-text-4" id="text-2-0-1">
+<div id="outline-container-sec-4-0-1" class="outline-4">
+<h4 id="sec-4-0-1"><span class="section-number-4">4.0.1</span> Directory layout</h4>
+<div class="outline-text-4" id="text-4-0-1">
 <ul class="org-ul">
 <li>bin
 <ul class="org-ul">
@@ -291,66 +341,103 @@ to minimize file access.
 </div>
 </div>
 </div>
-<div id="outline-container-sec-3" class="outline-2">
-<h2 id="sec-3"><span class="section-number-2">3</span> Scene description language</h2>
-<div class="outline-text-2" id="text-3">
+<div id="outline-container-sec-5" class="outline-2">
+<h2 id="sec-5"><span class="section-number-2">5</span> Scene description language</h2>
+<div class="outline-text-2" id="text-5">
 <p>
 (read examples&#x2026;)
 </p>
-
-
+</div>
+<div id="outline-container-sec-5-1" class="outline-3">
+<h3 id="sec-5-1"><span class="section-number-3">5.1</span> here</h3>
+<div class="outline-text-3" id="text-5-1">
 <pre class="example">
 here
+
 </pre>
 <p>
 defines new segment
 </p>
-
+</div>
+</div>
+<div id="outline-container-sec-5-2" class="outline-3">
+<h3 id="sec-5-2"><span class="section-number-3">5.2</span> p</h3>
+<div class="outline-text-3" id="text-5-2">
 <pre class="example">
 p  x y z
+
 </pre>
 <p>
 defines new point
 </p>
-
+</div>
+</div>
+<div id="outline-container-sec-5-3" class="outline-3">
+<h3 id="sec-5-3"><span class="section-number-3">5.3</span> f</h3>
+<div class="outline-text-3" id="text-5-3">
 <pre class="example">
 f  p1 p2 p3 p4
+
 </pre>
 <p>
 defines new polygon,  p4  may be unused
 </p>
-
-
+</div>
+</div>
+<div id="outline-container-sec-5-4" class="outline-3">
+<h3 id="sec-5-4"><span class="section-number-3">5.4</span> warn</h3>
+<div class="outline-text-3" id="text-5-4">
 <pre class="example">
 warn  &lt;message&gt;
+
 </pre>
 <p>
 displays warning message, and wait for key
 </p>
-
+</div>
+</div>
+<div id="outline-container-sec-5-5" class="outline-3">
+<h3 id="sec-5-5"><span class="section-number-3">5.5</span> end</h3>
+<div class="outline-text-3" id="text-5-5">
 <pre class="example">
 end
+
 </pre>
 <p>
 terminates parser
 </p>
-
+</div>
+</div>
+<div id="outline-container-sec-5-6" class="outline-3">
+<h3 id="sec-5-6"><span class="section-number-3">5.6</span> mtl</h3>
+<div class="outline-text-3" id="text-5-6">
 <pre class="example">
 mtl  material
+
 </pre>
 <p>
 selects material
 </p>
-
+</div>
+</div>
+<div id="outline-container-sec-5-7" class="outline-3">
+<h3 id="sec-5-7"><span class="section-number-3">5.7</span> mtlrnd</h3>
+<div class="outline-text-3" id="text-5-7">
 <pre class="example">
 mtlrnd  material ...
+
 </pre>
 <p>
 selects random material from list
 </p>
-
+</div>
+</div>
+<div id="outline-container-sec-5-8" class="outline-3">
+<h3 id="sec-5-8"><span class="section-number-3">5.8</span> obj</h3>
+<div class="outline-text-3" id="text-5-8">
 <pre class="example">
 obj  object xz45 xy20 x+3 y*2
+
 </pre>
 <p>
 includes sub object, can be rotated moved or resized, across X Y Z. If
@@ -365,53 +452,87 @@ directly from file, and not chached, to allow loading of greater than
 <p><img src="rotation.png" class="img-responsive" alt="rotation.png">
 </p>
 </figure>
-
-
+</div>
+</div>
+<div id="outline-container-sec-5-9" class="outline-3">
+<h3 id="sec-5-9"><span class="section-number-3">5.9</span> rnd</h3>
+<div class="outline-text-3" id="text-5-9">
 <pre class="example">
 rnd  p^1^2^3 p^7^2^1
+
 </pre>
 <p>
 select random command to execute, ^ will be converted to spaces.
 </p>
-
+</div>
+</div>
+<div id="outline-container-sec-5-10" class="outline-3">
+<h3 id="sec-5-10"><span class="section-number-3">5.10</span> #</h3>
+<div class="outline-text-3" id="text-5-10">
 <pre class="example">
 # whatever text
+
 </pre>
 <p>
 comment
 </p>
-
+</div>
+</div>
+<div id="outline-container-sec-5-11" class="outline-3">
+<h3 id="sec-5-11"><span class="section-number-3">5.11</span> out</h3>
+<div class="outline-text-3" id="text-5-11">
 <pre class="example">
 out  file
+
 </pre>
 <p>
 specify output file name, must be first command
 </p>
-
+</div>
+</div>
+<div id="outline-container-sec-5-12" class="outline-3">
+<h3 id="sec-5-12"><span class="section-number-3">5.12</span> set</h3>
+<div class="outline-text-3" id="text-5-12">
 <pre class="example">
 set  variable  contents
+
 </pre>
 <p>
 set variable contents, variable must be number, contents can be
 string. max variables is 100. first is 0.
 </p>
-
+</div>
+</div>
+<div id="outline-container-sec-5-13" class="outline-3">
+<h3 id="sec-5-13"><span class="section-number-3">5.13</span> variables usage</h3>
+<div class="outline-text-3" id="text-5-13">
 <pre class="example">
 anycommand %1 anything
+
 </pre>
 <p>
 inserts variable 1 contents info line
 </p>
-
+</div>
+</div>
+<div id="outline-container-sec-5-14" class="outline-3">
+<h3 id="sec-5-14"><span class="section-number-3">5.14</span> cmp</h3>
+<div class="outline-text-3" id="text-5-14">
 <pre class="example">
 cmp  flag string1 string2
+
 </pre>
 <p>
 compares strings, and inserts TRUE to flag, if they are equal, else inserts FALSE. max 9 falgs, 0 first. Each subobject has its own flags.
 </p>
-
+</div>
+</div>
+<div id="outline-container-sec-5-15" class="outline-3">
+<h3 id="sec-5-15"><span class="section-number-3">5.15</span> ?</h3>
+<div class="outline-text-3" id="text-5-15">
 <pre class="example">
 ?flag anycommand
+
 </pre>
 <p>
 executes command if flag is true.
@@ -420,30 +541,38 @@ executes command if flag is true.
 <p>
 exapmle: ?3 obj car z*2 xy45
 </p>
-
+</div>
+</div>
+<div id="outline-container-sec-5-16" class="outline-3">
+<h3 id="sec-5-16"><span class="section-number-3">5.16</span> dum</h3>
+<div class="outline-text-3" id="text-5-16">
 <pre class="example">
 dum
+
 </pre>
 <p>
 dummy function, does notheing
 </p>
 </div>
 </div>
+</div>
 
-<div id="outline-container-sec-4" class="outline-2">
-<h2 id="sec-4"><span class="section-number-2">4</span> Usage</h2>
-<div class="outline-text-2" id="text-4">
+<div id="outline-container-sec-6" class="outline-2">
+<h2 id="sec-6"><span class="section-number-2">6</span> Usage</h2>
+<div class="outline-text-2" id="text-6">
 <p>
 Make sure you have QB binaries in your PATH.  Execute
 </p>
 <pre class="example">
 bin/city1.bat
+
 </pre>
 <p>
 or
 </p>
 <pre class="example">
 bin/city2.bat
+
 </pre>
 <p>
 to generate example cities. After parsing is finished, appropriate
@@ -452,9 +581,9 @@ Visualize scene with your favourite renderer.
 </p>
 </div>
 </div>
-<div id="outline-container-sec-5" class="outline-2">
-<h2 id="sec-5"><span class="section-number-2">5</span> Examples</h2>
-<div class="outline-text-2" id="text-5">
+<div id="outline-container-sec-7" class="outline-2">
+<h2 id="sec-7"><span class="section-number-2">7</span> Examples</h2>
+<div class="outline-text-2" id="text-7">
 <p>
 Download Blender files:
 </p>
@@ -491,9 +620,9 @@ They were produced by importing generated <a href="https://en.wikipedia.org/wiki
 </p>
 </div>
 
-<div id="outline-container-sec-5-1" class="outline-3">
-<h3 id="sec-5-1"><span class="section-number-3">5.1</span> Rectangular city</h3>
-<div class="outline-text-3" id="text-5-1">
+<div id="outline-container-sec-7-1" class="outline-3">
+<h3 id="sec-7-1"><span class="section-number-3">7.1</span> Rectangular city</h3>
+<div class="outline-text-3" id="text-7-1">
 
 <figure>
 <p><img src="rectangular city, 1.jpeg" class="img-responsive" alt="rectangular city, 1.jpeg">
@@ -513,9 +642,9 @@ They were produced by importing generated <a href="https://en.wikipedia.org/wiki
 </figure>
 </div>
 </div>
-<div id="outline-container-sec-5-2" class="outline-3">
-<h3 id="sec-5-2"><span class="section-number-3">5.2</span> Hexagonal city</h3>
-<div class="outline-text-3" id="text-5-2">
+<div id="outline-container-sec-7-2" class="outline-3">
+<h3 id="sec-7-2"><span class="section-number-3">7.2</span> Hexagonal city</h3>
+<div class="outline-text-3" id="text-7-2">
 
 <figure>
 <p><img src="hexagonal city, 1.jpeg" class="img-responsive" alt="hexagonal city, 1.jpeg">
@@ -539,14 +668,39 @@ They were produced by importing generated <a href="https://en.wikipedia.org/wiki
 </div><div class="col-md-3"><nav id="table-of-contents">
 <div id="text-table-of-contents" class="bs-docs-sidebar">
 <ul class="nav">
-<li><a href="#sec-1">1. System requirements</a></li>
-<li><a href="#sec-2">2. Installation</a></li>
-<li><a href="#sec-3">3. Scene description language</a></li>
-<li><a href="#sec-4">4. Usage</a></li>
-<li><a href="#sec-5">5. Examples</a>
+<li><a href="#sec-1">1. General</a>
+<ul class="nav">
+<li><a href="#sec-1-1">1.1. Source code</a></li>
+</ul>
+</li>
+<li><a href="#sec-2">2. Operating principle</a></li>
+<li><a href="#sec-3">3. System requirements</a></li>
+<li><a href="#sec-4">4. Installation</a></li>
+<li><a href="#sec-5">5. Scene description language</a>
+<ul class="nav">
+<li><a href="#sec-5-1">5.1. here</a></li>
+<li><a href="#sec-5-2">5.2. p</a></li>
+<li><a href="#sec-5-3">5.3. f</a></li>
+<li><a href="#sec-5-4">5.4. warn</a></li>
+<li><a href="#sec-5-5">5.5. end</a></li>
+<li><a href="#sec-5-6">5.6. mtl</a></li>
+<li><a href="#sec-5-7">5.7. mtlrnd</a></li>
+<li><a href="#sec-5-8">5.8. obj</a></li>
+<li><a href="#sec-5-9">5.9. rnd</a></li>
+<li><a href="#sec-5-10">5.10. #</a></li>
+<li><a href="#sec-5-11">5.11. out</a></li>
+<li><a href="#sec-5-12">5.12. set</a></li>
+<li><a href="#sec-5-13">5.13. variables usage</a></li>
+<li><a href="#sec-5-14">5.14. cmp</a></li>
+<li><a href="#sec-5-15">5.15. ?</a></li>
+<li><a href="#sec-5-16">5.16. dum</a></li>
+</ul>
+</li>
+<li><a href="#sec-6">6. Usage</a></li>
+<li><a href="#sec-7">7. Examples</a>
 <ul class="nav">
-<li><a href="#sec-5-1">5.1. Rectangular city</a></li>
-<li><a href="#sec-5-2">5.2. Hexagonal city</a></li>
+<li><a href="#sec-7-1">7.1. Rectangular city</a></li>
+<li><a href="#sec-7-2">7.2. Hexagonal city</a></li>
 </ul>
 </li>
 </ul>
@@ -555,8 +709,8 @@ They were produced by importing generated <a href="https://en.wikipedia.org/wiki
 </div></div></div>
 <footer id="postamble" class="">
 <div><p class="author">Author: Svjatoslav Agejenko</p>
-<p class="date">Created: 2018-06-20 Wed 16:08</p>
-<p class="creator"><a href="http://www.gnu.org/software/emacs/">Emacs</a> 25.1.1 (<a href="http://orgmode.org">Org-mode</a> 8.2.10)</p>
+<p class="date">Created: 2019-01-20 Sun 03:19</p>
+<p class="creator"><a href="http://www.gnu.org/software/emacs/">Emacs</a> 26.1 (<a href="http://orgmode.org">Org-mode</a> 9.1.9)</p>
 </div>
 </footer>
 </body>