From f017fcd5e10cd130c46d9b4ae58f6a3ecde1025c Mon Sep 17 00:00:00 2001 From: Michael Molinari Date: Sat, 28 Mar 2020 01:28:14 -0400 Subject: [PATCH] Documentation for basic operations/wizards --- README.md | 2 ++ web/docs/BOOLEAN_OPPERATIONS.md | 20 ++++++++++++++++++++ web/docs/BOX.md | 7 +++++++ web/docs/CONE.md | 1 + web/docs/CUT.md | 1 + web/docs/CYLINDER.md | 1 + web/docs/DATUM_CREATE.md | 13 +++++++++++++ web/docs/DATUM_MOVE.md | 9 +++++++++ web/docs/DATUM_ROTATE.md | 7 +++++++ web/docs/EditFace.md | 1 + web/docs/FILLET.md | 1 + web/docs/HistoryTimeline.md | 1 + web/docs/INTERSECTION.md | 1 + web/docs/PLANE.md | 1 + web/docs/REVOLVE.md | 1 + web/docs/ReassignSketch.md | 1 + web/docs/SPHERE.md | 1 + web/docs/SUBTRACT.md | 1 + web/docs/Save.md | 1 + web/docs/StlExport.md | 1 + web/docs/TORUS.md | 1 + web/docs/UNION.md | 1 + web/docs/index.md | 30 ++++++++++++++++++++++++++++++ 23 files changed, 104 insertions(+) create mode 100644 web/docs/BOOLEAN_OPPERATIONS.md create mode 100644 web/docs/BOX.md create mode 100644 web/docs/CONE.md create mode 100644 web/docs/CUT.md create mode 100644 web/docs/CYLINDER.md create mode 100644 web/docs/DATUM_CREATE.md create mode 100644 web/docs/DATUM_MOVE.md create mode 100644 web/docs/DATUM_ROTATE.md create mode 100644 web/docs/EditFace.md create mode 100644 web/docs/FILLET.md create mode 100644 web/docs/HistoryTimeline.md create mode 100644 web/docs/INTERSECTION.md create mode 100644 web/docs/PLANE.md create mode 100644 web/docs/REVOLVE.md create mode 100644 web/docs/ReassignSketch.md create mode 100644 web/docs/SPHERE.md create mode 100644 web/docs/SUBTRACT.md create mode 100644 web/docs/Save.md create mode 100644 web/docs/StlExport.md create mode 100644 web/docs/TORUS.md create mode 100644 web/docs/UNION.md create mode 100644 web/docs/index.md diff --git a/README.md b/README.md index 8f483f87..6556ab8d 100644 --- a/README.md +++ b/README.md @@ -13,6 +13,8 @@ JS.Sketcher is a **parametric** 2D and 3D CAD modeler written in pure javascript [2D Sketcher](http://web-cad.org/sketcher.html#__sample2D__) +[Help Docs](./web/docs/index.md) + [![paypal](https://www.paypalobjects.com/en_US/i/btn/btn_donate_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=WADW7V7CC32CY&lc=US&item_name=web%2dcad%2eorg¤cy_code=USD&bn=PP%2dDonationsBF%3abtn_donate_LG%2egif%3aNonHosted) Current Status diff --git a/web/docs/BOOLEAN_OPPERATIONS.md b/web/docs/BOOLEAN_OPPERATIONS.md new file mode 100644 index 00000000..397a581d --- /dev/null +++ b/web/docs/BOOLEAN_OPPERATIONS.md @@ -0,0 +1,20 @@ +# ![](../img/cad/union32.png)![](../img/cad/subtract32.png)![](../img/cad/intersection32.png)BOOLEAN OPPERATIONS + +Boolean operations allow for solids to be used as tools to shape and modify other solids. + + +# ![](../img/cad/union32.png)UNION +Union allows solids to be combined to create a new solid. + +![](img/bool-UNION.gif) + +# ![](../img/cad/subtract32.png)SUBTRACT +Subtract allows one solid to be used as a cuttong tool for another sold. Usefull for making hole features. +Selection A will have selection B removed from it. + +![](img/bool-SUBTRACT.gif) + +# ![](../img/cad/intersection32.png)INTERSECTION +Intersection allows for the creation of a new solid in the space where 2 exising solids overlap. + +![](img/bool-INTERSECTION.gif) diff --git a/web/docs/BOX.md b/web/docs/BOX.md new file mode 100644 index 00000000..b28af9e2 --- /dev/null +++ b/web/docs/BOX.md @@ -0,0 +1,7 @@ +# ![](../img/cad/cube32.png)BOX +![](img/box-dialog.gif) + +The BOX command can be accesed by hovering over the center point of an existing datum and clicking. This brings up a menue with the BOX command as an option. + +Size of the box can be specified with the width, height and depth fields. +The boolean drop down allows for boolean operations with existing 3d solids. See [BOOLEAN_OPPERATIONS.md](BOOLEAN_OPPERATIONS.md "BOOLEAN_OPPERATIONS.md"). diff --git a/web/docs/CONE.md b/web/docs/CONE.md new file mode 100644 index 00000000..55f985c9 --- /dev/null +++ b/web/docs/CONE.md @@ -0,0 +1 @@ +place holder diff --git a/web/docs/CUT.md b/web/docs/CUT.md new file mode 100644 index 00000000..55f985c9 --- /dev/null +++ b/web/docs/CUT.md @@ -0,0 +1 @@ +place holder diff --git a/web/docs/CYLINDER.md b/web/docs/CYLINDER.md new file mode 100644 index 00000000..55f985c9 --- /dev/null +++ b/web/docs/CYLINDER.md @@ -0,0 +1 @@ +place holder diff --git a/web/docs/DATUM_CREATE.md b/web/docs/DATUM_CREATE.md new file mode 100644 index 00000000..c8a4d79a --- /dev/null +++ b/web/docs/DATUM_CREATE.md @@ -0,0 +1,13 @@ +# ![](../img/cad/datum32.png)Datum Create +![](img/create-datum.gif) + +While the CREATE DATUM dialog is open the datum can be dragged using the vector arrows. Optionally the values can be enter in the fields of the dialog. + +Datiums consist of a point and 3 vectors defining a relative location and orientation. The location and orientation can be moved after initial creation. See ![](../img/cad/datum-move32.png)[DATUM_MOVE.md](DATUM_MOVE.md "DATUM_MOVE.md") +![](../img/cad/datum-rotate32.png)[DATUM_ROTATE.md](DATUM_ROTATE.md "DATUM_ROTATE.md") + +The datium feature provides a point that can be used as the baisus for plane features or the origin point of a 3d primitive. + +The datium feature also provides 3 vectors. These vectors can be used for defining a direction of an extride/cut or the acces of a revolve feature. + + diff --git a/web/docs/DATUM_MOVE.md b/web/docs/DATUM_MOVE.md new file mode 100644 index 00000000..ee30faab --- /dev/null +++ b/web/docs/DATUM_MOVE.md @@ -0,0 +1,9 @@ +# ![](../img/cad/datum-move32.png)Datum Move +![](img/move-datum.gif) + + +The MOVE DATUM dialog can be accesed by hovering over the center point of an existing datum and clicking. This brings up a menue with the MOVE DATUM command as an option. + +While the MOVE DATUM dialog is open the datum can be dragged using the vector arrows. Optionally the values can be enter in the fields of the dialog. + +Optionally a new copy of the exisintg datum can be created rather than the translation of the original. diff --git a/web/docs/DATUM_ROTATE.md b/web/docs/DATUM_ROTATE.md new file mode 100644 index 00000000..0c343fe1 --- /dev/null +++ b/web/docs/DATUM_ROTATE.md @@ -0,0 +1,7 @@ +# ![](../img/cad/datum-rotate32.png)Datum Rotate +![](img/rotate-datum.gif) + + +The ROTATE DATUM dialog can be accesed by hovering over the center point of an existing datum and clicking. This brings up a menue with the ROTATE DATUM command as an option. + +While the ROTATE DATUM dialog is open the rotational axis can be selected. An angle then can be entered to change the orientation of datum. diff --git a/web/docs/EditFace.md b/web/docs/EditFace.md new file mode 100644 index 00000000..55f985c9 --- /dev/null +++ b/web/docs/EditFace.md @@ -0,0 +1 @@ +place holder diff --git a/web/docs/FILLET.md b/web/docs/FILLET.md new file mode 100644 index 00000000..8b137891 --- /dev/null +++ b/web/docs/FILLET.md @@ -0,0 +1 @@ + diff --git a/web/docs/HistoryTimeline.md b/web/docs/HistoryTimeline.md new file mode 100644 index 00000000..5c38d4a5 --- /dev/null +++ b/web/docs/HistoryTimeline.md @@ -0,0 +1 @@ +Place holder diff --git a/web/docs/INTERSECTION.md b/web/docs/INTERSECTION.md new file mode 100644 index 00000000..9e5a513e --- /dev/null +++ b/web/docs/INTERSECTION.md @@ -0,0 +1 @@ +See [BOOLEAN_OPPERATIONS.md](BOOLEAN_OPPERATIONS.md "BOOLEAN_OPPERATIONS.md"). diff --git a/web/docs/PLANE.md b/web/docs/PLANE.md new file mode 100644 index 00000000..55f985c9 --- /dev/null +++ b/web/docs/PLANE.md @@ -0,0 +1 @@ +place holder diff --git a/web/docs/REVOLVE.md b/web/docs/REVOLVE.md new file mode 100644 index 00000000..55f985c9 --- /dev/null +++ b/web/docs/REVOLVE.md @@ -0,0 +1 @@ +place holder diff --git a/web/docs/ReassignSketch.md b/web/docs/ReassignSketch.md new file mode 100644 index 00000000..5c38d4a5 --- /dev/null +++ b/web/docs/ReassignSketch.md @@ -0,0 +1 @@ +Place holder diff --git a/web/docs/SPHERE.md b/web/docs/SPHERE.md new file mode 100644 index 00000000..55f985c9 --- /dev/null +++ b/web/docs/SPHERE.md @@ -0,0 +1 @@ +place holder diff --git a/web/docs/SUBTRACT.md b/web/docs/SUBTRACT.md new file mode 100644 index 00000000..9e5a513e --- /dev/null +++ b/web/docs/SUBTRACT.md @@ -0,0 +1 @@ +See [BOOLEAN_OPPERATIONS.md](BOOLEAN_OPPERATIONS.md "BOOLEAN_OPPERATIONS.md"). diff --git a/web/docs/Save.md b/web/docs/Save.md new file mode 100644 index 00000000..55f985c9 --- /dev/null +++ b/web/docs/Save.md @@ -0,0 +1 @@ +place holder diff --git a/web/docs/StlExport.md b/web/docs/StlExport.md new file mode 100644 index 00000000..55f985c9 --- /dev/null +++ b/web/docs/StlExport.md @@ -0,0 +1 @@ +place holder diff --git a/web/docs/TORUS.md b/web/docs/TORUS.md new file mode 100644 index 00000000..55f985c9 --- /dev/null +++ b/web/docs/TORUS.md @@ -0,0 +1 @@ +place holder diff --git a/web/docs/UNION.md b/web/docs/UNION.md new file mode 100644 index 00000000..9e5a513e --- /dev/null +++ b/web/docs/UNION.md @@ -0,0 +1 @@ +See [BOOLEAN_OPPERATIONS.md](BOOLEAN_OPPERATIONS.md "BOOLEAN_OPPERATIONS.md"). diff --git a/web/docs/index.md b/web/docs/index.md new file mode 100644 index 00000000..bba9d269 --- /dev/null +++ b/web/docs/index.md @@ -0,0 +1,30 @@ +- ![](../img/cad/datum32.png)[DATUM_CREATE.md](DATUM_CREATE.md "DATUM_CREATE.md") +- ![](../img/cad/datum-move32.png)[DATUM_MOVE.md](DATUM_MOVE.md "DATUM_MOVE.md") +- ![](../img/cad/datum-rotate32.png)[DATUM_ROTATE.md](DATUM_ROTATE.md "DATUM_ROTATE.md") +- ![](../img/cad/plane32.png)[PLANE.md](PLANE.md "PLANE.md") +- ![](../img/cad/face-edit96.png)[EditFace.md](EditFace.md "EditFace.md") +- ![](../img/cad/revolve32.png)[REVOLVE.md](REVOLVE.md "REVOLVE.md") +- ![](../img/cad/cut32.png)[CUT.md](CUT.md "CUT.md") +- ![](../img/cad/fillet32.png)[FILLET.md](FILLET.md "FILLET.md") + + +- ![](../img/cad/xxxxxxxx.png)[ReassignSketch.md](ReassignSketch.md "ReassignSketch.md") + + + +- ![](../img/cad/cylinder32.png)[CYLINDER.md](CYLINDER.md "CYLINDER.md") +- ![](../img/cad/cone32.png)[CONE.md](CONE.md "CONE.md") +- ![](../img/cad/sphere32.png)[SPHERE.md](SPHERE.md "SPHERE.md") +- ![](../img/cad/torus32.png)[TORUS.md](TORUS.md "TORUS.md") + + + +- ![](../img/cad/union32.png)[UNION.md](UNION.md "UNION.md") +- ![](../img/cad/subtract32.png)[SUBTRACT.md](SUBTRACT.md "SUBTRACT.md") +- ![](../img/cad/intersection32.png)[INTERSECTION.md](INTERSECTION.md "INTERSECTION.md") + + +- ![](../img/cad/stl32.png)[StlExport.md](StlExport.md "StlExport.md") +- ![](../img/cad/cone32.png)[Save.md](Save.md "Save.md") + +- [index.md](index.md "index.md")