docs/index.html

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>AngelCAD: AngelCAD - script based 3D solid modeller</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.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 style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="angel_48x48.bmp"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">AngelCAD
   &#160;<span id="projectnumber">1.5-00</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">AngelCAD - script based 3D solid modeller </div>  </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>AngelCAD is an open source 3D solid modeller based on the <a href="https://en.wikipedia.org/wiki/Constructive_solid_geometry">Constructive Solid Geometry (CSG)</a> modelling technique, expressed in the <a href="http://www.angelcode.com/angelscript/sdk/docs/manual/doc_script.html">AngelScript language</a>. The software is used for creating 3D models in STL or other file formats.</p>
<div class="image">
<img src="angelcad_ide.png" alt="angelcad_ide.png"/>
</div>
<h1><a class="anchor" id="language_sec"></a>
AngelCAD language extension to AngelScript</h1>
<p>AngelCAD uses the <a href="http://www.angelcode.com/angelscript/sdk/docs/manual/doc_script.html">AngelScript</a> language to express 3D model designs. It is a powerful language based on the well known syntax of languages such as C++ or Java. It is a strongly typed language allowing the user to declare variables for parametric modelling or to hold parts of the design. Standard constructs such as for-loops and if-statements are available, plus much more. See the <a href="http://www.angelcode.com/angelscript/sdk/docs/manual/doc_script.html">AngelScript language description</a> for details.</p>
<p>The AngelCAD language extension adds 3D solid modelling features to the general purpose AngelScript language. This includes modelling primitives such as 'cube', 'sphere', 'polyhedron' and more, plus operators such as '<a class="el" href="classunion3d.html" title="3d union boolean operation ">union3d</a>' and '<a class="el" href="classhull3d.html" title="3d hull operation, enclosing the input solids ">hull3d</a>'. For a full overview of the features, see the 'Classes' page of this manual. See also the AngelCAD sample scripts available from the <a href="https://github.com/arnholm/angelcad-samples/">angelcad-samples</a> repository.</p>
<h1><a class="anchor" id="License"></a>
License</h1>
<p>AngelCAD is Copyright (c) 2015 - 2020 Carsten Arnholm. The software is distributed under the <a href="https://www.gnu.org/licenses/gpl.html">GNU General Public License version 3.</a></p>
<h1><a class="anchor" id="gettingstarted_sec"></a>
Getting Started</h1>
<p>To install the software, download the pre-built binaries from the Github releases section. Extract the downloaded ZIP-file and run the setup.exe (Windows) or setup.sh shell script (Linux). Then try some of the sample scripts from the <a href="https://github.com/arnholm/angelcad-samples">angelcad-samples</a> GitHub repository. One of the examples is "csg_wikipadia.as",shown below and in the image at the top of the page. </p><div class="fragment"><div class="line"><a class="code" href="classshape.html">shape</a>@ main_shape()</div><div class="line">{</div><div class="line">   <span class="comment">// intersection of cube and sphere</span></div><div class="line">   <a class="code" href="classcube.html">cube</a>@     cu = <a class="code" href="classcube.html">cube</a>(size:45,center:<span class="keyword">true</span>);</div><div class="line">   <a class="code" href="classsphere.html">sphere</a>@   sp = <a class="code" href="classsphere.html">sphere</a>(r:30);</div><div class="line">   <a class="code" href="classsolid.html">solid</a>@  cusp = cu &amp; sp;                   <span class="comment">// &#39;&amp;&#39; : intersection</span></div><div class="line"></div><div class="line">   <span class="comment">// union of 3 cylinders</span></div><div class="line">   <a class="code" href="classcylinder.html">cylinder</a>@ cy = <a class="code" href="classcylinder.html">cylinder</a>(r:17,h:50,center:<span class="keyword">true</span>);</div><div class="line">   <a class="code" href="classsolid.html">solid</a>@   cy2 = cy  + <a class="code" href="classrotate__x.html">rotate_x</a>(deg:90)*cy;</div><div class="line">   <a class="code" href="classsolid.html">solid</a>@   cy3 = cy2 + <a class="code" href="classrotate__y.html">rotate_y</a>(deg:90)*cy; <span class="comment">// &#39;+&#39; : union</span></div><div class="line"></div><div class="line">   <span class="comment">// difference of the 2 above</span></div><div class="line">   <span class="keywordflow">return</span> cusp - cy3;                        <span class="comment">// &#39;-&#39; : difference</span></div><div class="line">}</div><div class="line"></div><div class="line"><span class="keywordtype">void</span> main()</div><div class="line">{</div><div class="line">    <a class="code" href="classshape.html">shape</a>@ obj = main_shape();</div><div class="line">    obj.<a class="code" href="classshape.html#a360c3c312d757f8385fc36cb7ec940e0">write_xcsg</a>(GetInputFullPath(),secant_tolerance:0.01);</div><div class="line">}</div></div><!-- fragment --><p>Some rules</p><ul>
<li>You <em>must</em> have a "void main()" function.</li>
<li>It is recommended to use a "shape@ main_shape()" function that returns the final object created.</li>
<li>The secant tolerance controls the density of the generated mesh</li>
<li>You can use as many additional functions as you need.</li>
<li>Note the use of handles such as shape@, cylinder@ etc. The use of the "@" character with most AngelCAD objects signifies a reference variable, you can think of it as a kind of smart pointer to an object as it manages itself automatically and does not require explicit deletion.</li>
</ul>
<h1><a class="anchor" id="technology_sec"></a>
Technology</h1>
<p>AngelCAD uses <a href="https://github.com/arnholm/xcsg">xcsg</a> for 3d computations. xcsg is based on the <a href="https://github.com/arnholm/carve">carve library</a> by Tobias Sargeant. xcsg also uses <a href="http://angusj.com/delphi/clipper.php">Clipper</a> by Angus Johnson, qhull by C.B. Barber and libtess2 by Mikko Mononen. The AngelCAD language interpreter - as_csg - is based on the AngelScript language by Andreas Jönsson, as_csg extends the language with 3d modelling types and operations for constructive solid geometry. The AngelCAD IDE and Viewer applications use the <a href="https://wxwidgets.org/">wxWidgets</a> cross-platform GUI library to create native GUI for Windows and Linux. </p>
</div></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Nov 15 2020 14:41:21 for AngelCAD by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>