gs-modelling
Version:
A set of 3D modelling functions for gs-JSON.
300 lines • 14.4 kB
HTML
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>gs-modelling</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="assets/js/search.js" data-base=".">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="index.html" class="title">gs-modelling</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="globals.html">Globals</a>
</li>
</ul>
<h1> gs-modelling</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<div class="tsd-panel tsd-typography">
<p>[<img src="https://travis-ci.org/phtj/gs-json.svg?branch=master" alt="Build Status">]</p>
<h1 id="gs-modelling">gs-modelling</h1>
<p>A TypeScript modelling library using the gs-JSON format</p>
<p>See the API docs: <a href="https://phtj.github.io/gs-modelling">https://phtj.github.io/gs-modelling</a></p>
<p>See the Github page: <a href="https://github.com/phtj/gs-modelling/">https://github.com/phtj/gs-modelling/</a></p>
<p>For more information about gs-json:
<a href="https://github.com/phtj/gs-json">https://github.com/phtj/gs-json</a></p>
<h2 id="ent">Ent</h2>
<p>Entities contain geometric information. Entities consist of <em>Point</em> and <em>Obj</em></p>
<h3 id="point">Point</h3>
<p>Points are a type of entity that represent 3D points in space.</p>
<h3 id="obj">Obj</h3>
<p>Objects are a type of entity. Objects consist of <em>Ray</em>, <em>Plane</em>, <em>Conic</em>, <em>Polyline</em> and <em>Polymesh</em></p>
<h4 id="ray">Ray</h4>
<p>Rays are imaginary infinite axis defined by a vector.</p>
<h4 id="plane">Plane</h4>
<p>Planes are imaginary infinite surfaces defined by 2 vectors.</p>
<h4 id="conic">Conic</h4>
<p>Conic curves are mathematical curves. They consist of circles, ellipses, hyperbolas, parabolas and arcs.</p>
<h4 id="polyline">Polyline</h4>
<p>Polylines are straight line segments joined to form a continuous line</p>
<h4 id="polymesh">Polymesh</h4>
<p>Polymeshes are flat polygons joined to form a continuous surface</p>
</div>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="globals.html"><em>Globals</em></a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_attrib_.html">"attrib"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_calc_.html">"calc"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_circle_.html">"circle"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_generate_gen_gs_test_models_.html">"generate/gen_<wbr>gs_<wbr>test_<wbr>models"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_generate_gen_three_test_models_.html">"generate/gen_<wbr>three_<wbr>test_<wbr>models"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_generate_models_circles_.html">"generate/models_<wbr>circles"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_generate_models_object_.html">"generate/models_<wbr>object"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_generate_models_plines_.html">"generate/models_<wbr>plines"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_generate_models_pmeshes_.html">"generate/models_<wbr>pmeshes"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_generate_models_points_.html">"generate/models_<wbr>points"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_generate_models_weeks_.html">"generate/models_<wbr>weeks"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_group_.html">"group"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_import_geojson_geojson_.html">"import/geojson/geojson"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_intersect_.html">"intersect"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_libs_arr_arr_.html">"libs/arr/arr"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_libs_conics_circle3points_.html">"libs/conics/circle3<wbr>Points"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_libs_conics_circlecircle2d_.html">"libs/conics/circle<wbr>Circle2<wbr>D"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_libs_conics_circleplane3d_.html">"libs/conics/circle<wbr>Plane3<wbr>D"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_libs_conics_circlepolyline2d_.html">"libs/conics/circle<wbr>Polyline2<wbr>D"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_libs_conics_circleutil_.html">"libs/conics/circle<wbr>Util"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_libs_conics_circles_.html">"libs/conics/circles"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_libs_conics_pointclusters_.html">"libs/conics/point<wbr>Clusters"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_libs_conics_trigo_.html">"libs/conics/trigo"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_libs_filesys_download_.html">"libs/filesys/download"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_libs_filesys_filesys_.html">"libs/filesys/filesys"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_libs_poly_poly_.html">"libs/poly/poly"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_libs_poly_polylinepipe_.html">"libs/poly/polyline<wbr>Pipe"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_libs_poly_polylineplane_.html">"libs/poly/polyline<wbr>Plane"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_libs_threex_threex_.html">"libs/threex/threex"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_libs_xform_xform_.html">"libs/xform/xform"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_list_.html">"list"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_math_.html">"math"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_model_.html">"model"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_object_.html">"object"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_plane_.html">"plane"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_pline_.html">"pline"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_pmesh_.html">"pmesh"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_point_.html">"point"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_query_.html">"query"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_ray_.html">"ray"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_split_.html">"split"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_string_.html">"string"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="modules/_topo_.html">"topo"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="assets/js/search.js"><' + '/script>');</script>
</body>
</html>