awv3

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <base data-ice="baseUrl"> <title data-ice="title">API Document</title> <link type="text/css" rel="stylesheet" href="css/style.css"> <link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css"> <script src="script/prettify/prettify.js"></script> <script src="script/manual.js"></script> </head> <body class="layout-container" data-ice="rootContainer"> <header> <a href="./">Home</a> <a href="identifiers.html">Reference</a> <a href="source.html">Source</a> <a data-ice="repoURL" href="https://github.com/awv-informatik/awv3-next" class="repo-url-github">Repository</a> <div class="search-box"> <img src="./image/search.png"> <input class="search-input"> <ul class="search-result"></ul> </div> </header> <nav class="navigation" data-ice="nav"><div> <ul> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">animation</div>F<a href="function/index.html#static-function-linear">linear</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-back">back</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-bounce">bounce</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-circular">circular</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-cubic">cubic</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-elastic">elastic</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-exponential">exponential</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-quadratic">quadratic</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-quartic">quartic</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-quintic">quintic</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-sinusoidal">sinusoidal</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">communication</div>C<a href="class/src/communication/analyzer.js~analyzer.html">analyzer</a></li> <li data-ice="doc">C<a href="class/src/communication/base.js~base.html">base</a></li> <li data-ice="doc">C<a href="class/src/communication/rest.js~Rest.html">Rest</a></li> <li data-ice="doc">C<a href="class/src/communication/signalr.js~SignalR.html">SignalR</a></li> <li data-ice="doc">C<a href="class/src/communication/socketio.js~SocketIO.html">SocketIO</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-signalrhub">signalrhub</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">controls</div>C<a href="class/src/controls/orbit.js~Orbit.html">Orbit</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">core</div>C<a href="class/src/core/canvas.js~Canvas.html">Canvas</a></li> <li data-ice="doc">C<a href="class/src/core/defaults.js~Defaults.html">Defaults</a></li> <li data-ice="doc">C<a href="class/src/core/events.js~Events.html">Events</a></li> <li data-ice="doc">C<a href="class/src/core/helpers.js~Performance.html">Performance</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-halt">halt</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-log">log</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-queryDom">queryDom</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-setPrefixedValue">setPrefixedValue</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-url">url</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-lastCreated">lastCreated</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-version">version</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-instance">instance</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-Timestamp">Timestamp</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">misc</div>C<a href="class/src/misc/materialstore.js~MaterialStore.html">MaterialStore</a></li> <li data-ice="doc">C<a href="class/src/misc/stats.js~Stats.html">Stats</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">plugins/dimension/graphics</div>C<a href="class/src/plugins/dimension/graphics/angular.js~Angular.html">Angular</a></li> <li data-ice="doc">C<a href="class/src/plugins/dimension/graphics/base.js~BaseGraphics.html">BaseGraphics</a></li> <li data-ice="doc">C<a href="class/src/plugins/dimension/graphics/linear.js~Linear.html">Linear</a></li> <li data-ice="doc">C<a href="class/src/plugins/dimension/graphics/radial.js~Radial.html">Radial</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-Graphics">Graphics</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">plugins/properties</div>C<a href="class/src/plugins/properties/index.js~Properties.html">Properties</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">plugins/sketcher</div>C<a href="class/src/plugins/sketcher/ccfuturef.js~Ccfuturef.html">Ccfuturef</a></li> <li data-ice="doc">C<a href="class/src/plugins/sketcher/controls.js~filletHandler.html">filletHandler</a></li> <li data-ice="doc">C<a href="class/src/plugins/sketcher/snapper.js~Snapper.html">Snapper</a></li> <li data-ice="doc">C<a href="class/src/plugins/sketcher/unittests.js~SketchMatcher.html">SketchMatcher</a></li> <li data-ice="doc">C<a href="class/src/plugins/sketcher/unittests.js~SketcherAutomation.html">SketcherAutomation</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-drawArcBy_Angle_M">drawArcBy_Angle_M</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-drawArcBy_S_E_CPh">drawArcBy_S_E_CPh</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-drawArcBy_S_E_Ch">drawArcBy_S_E_Ch</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-drawArcBy_S_E_M">drawArcBy_S_E_M</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-drawArcBy_S_T_E">drawArcBy_S_T_E</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-drawLineBy_Angle_M">drawLineBy_Angle_M</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getArcAngles">getArcAngles</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getTangent">getTangent</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-intersectLines">intersectLines</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-move">move</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getSnappedPointWrap">getSnappedPointWrap</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-runAllTests">runAllTests</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-runPerfoTest">runPerfoTest</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-calcSketchPos">calcSketchPos</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-calcWorldToPixelScale">calcWorldToPixelScale</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">plugins/sketcher/command</div>C<a href="class/src/plugins/sketcher/command/multirunner.js~MultiRunner.html">MultiRunner</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-commandRunner">commandRunner</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-Assign">Assign</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-Member">Member</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-Return">Return</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-Sequence">Sequence</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-Variable">Variable</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-AddPoint">AddPoint</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">plugins/sketcher/command/ast</div>C<a href="class/src/plugins/sketcher/command/ast/ast.js~Ast.html">Ast</a></li> <li data-ice="doc">C<a href="class/src/plugins/sketcher/command/ast/expr.js~Expr.html">Expr</a></li> <li data-ice="doc">C<a href="class/src/plugins/sketcher/command/ast/stmt.js~Stmt.html">Stmt</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">plugins/sketcher/constraint</div>C<a href="class/src/plugins/sketcher/constraint/adder.js~ConstraintAdder.html">ConstraintAdder</a></li> <li data-ice="doc">C<a href="class/src/plugins/sketcher/constraint/adder.js~DSU.html">DSU</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-Constraint">Constraint</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-angle">angle</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-angleox">angleox</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-colinear">colinear</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-concentric">concentric</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-distance">distance</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-equalDistance">equalDistance</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-equalRadius">equalRadius</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-fixation">fixation</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-horizontalDistance">horizontalDistance</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-horizontality">horizontality</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-incidence">incidence</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-midpoint">midpoint</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-parallelity">parallelity</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-perpendicularity">perpendicularity</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-radius">radius</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-symmetric">symmetric</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-tangency">tangency</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-verticalDistance">verticalDistance</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-verticality">verticality</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">plugins/sketcher/graphics</div>C<a href="class/src/plugins/sketcher/graphics/arc.js~Arc.html">Arc</a></li> <li data-ice="doc">C<a href="class/src/plugins/sketcher/graphics/base.js~BaseGraphics.html">BaseGraphics</a></li> <li data-ice="doc">C<a href="class/src/plugins/sketcher/graphics/line.js~Line.html">Line</a></li> <li data-ice="doc">C<a href="class/src/plugins/sketcher/graphics/point.js~Point.html">Point</a></li> <li data-ice="doc">C<a href="class/src/plugins/sketcher/graphics/sketch.js~Sketch.html">Sketch</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-Graphics">Graphics</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">plugins/sketcher/handlers</div>C<a href="class/src/plugins/sketcher/handlers/base.js~BaseHandler.html">BaseHandler</a></li> <li data-ice="doc">C<a href="class/src/plugins/sketcher/handlers/drag.js~DragHandler.html">DragHandler</a></li> <li data-ice="doc">C<a href="class/src/plugins/sketcher/handlers/hover.js~HoverHandler.html">HoverHandler</a></li> <li data-ice="doc">C<a href="class/src/plugins/sketcher/handlers/polyline.js~PolylineHandler.html">PolylineHandler</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-Handler">Handler</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">session/selection</div>C<a href="class/src/session/selection/objectselector.js~ObjectSelector.html">ObjectSelector</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">session/store</div>V<a href="variable/index.html#static-variable-reducer">reducer</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">three</div>C<a href="class/src/three/infiniteplane.js~InfinitePlane.html">InfinitePlane</a></li> <li data-ice="doc">C<a href="class/src/three/raycaster.js~Raycaster.html">Raycaster</a></li> <li data-ice="doc">C<a href="class/src/three/region.js~Region.html">Region</a></li> </ul> </div> </nav> <div class="content" data-ice="content"><div data-ice="index" class="github-markdown"><h1 id="pre-requisites">Pre-requisites</h1> <pre><code><code class="source-code prettyprint">node >= 6.0 (https://nodejs.org/en/download/current/) npm >= 3.0 (comes pre-installed by node) yarn (npm install yarn -g)</code> </code></pre><h1 id="install-start-default-test">Install & start default test</h1> <pre><code><code class="source-code prettyprint">npm install npm start</code> </code></pre><h1 id="commands">Commands</h1> <pre><code><code class="source-code prettyprint">npm start: "npm run redux-classcad", npm run doc: "node_modules/.bin/esdoc -c esdoc.json", npm run babel: "babel src -d build --no-babelrc --presets=es2015,stage-0 --plugins=transform-runtime", npm run browser: "webpack --progress --colors", npm run build: "npm run babel && npm run browser && npm run doc", npm run classcad: "node classcad", npm run redux: "webpack-dev-server --env.dev --progress --colors --config ./tests/redux/webpack.config.babel.js", npm run redux-prod: "webpack-dev-server --env.prod --progress --colors --config ./tests/redux/webpack.config.babel.js", npm run redux-classcad: "node_modules/.bin/npm-run-all --parallel classcad redux", npm run redux-prod-classcad: "node_modules/.bin/npm-run-all --parallel classcad redux-prod", npm run build-redux: "webpack --env.prod --progress --colors --config ./tests/redux/webpack.config.babel.js"</code> </code></pre><h1 id="macos-linux-support-experimental-">MacOS/Linux support (experimental)</h1> ClassCAD depends on Windows and cannot run natively on Linux based systems. Though Wine can be used to emulate a Windows environment. This is highly experimental and certain ClassCAD or SMLIB related features may not run correctly or run at all. At the moment only x86 ClassCAD builds are supported. Install <code>wine</code> and <code>winetricks</code> <pre><code><code class="source-code prettyprint">brew install wine winetricks // MacOS apt-get install wine winetricks // Linux</code> </code></pre>Now install the Visual Studio distributables for 2013 and 2015. <pre><code><code class="source-code prettyprint">winetricks vcrun2013 vcrun2015</code> </code></pre>All project-commands (<code>npm start</code>, etc.) should work now. </div> </div> <footer class="footer"> Generated by <a href="https://esdoc.org">ESDoc(0.5.2)<img src="./image/esdoc-logo-mini-black.png"></a> </footer> <script src="script/search_index.js"></script> <script src="script/search.js"></script> <script src="script/pretty-print.js"></script> <script src="script/inherited-summary.js"></script> <script src="script/test-summary.js"></script> <script src="script/inner-link.js"></script> <script src="script/patch-for-local.js"></script> </body> </html>