examples/assemblies/5-door.ipynb

{
 "cells": [
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "import cadquery as cq\n",
    "from jupyter_cadquery import (\n",
    "    open_viewer, show, web_color, show_object,\n",
    "    set_defaults, get_defaults, \n",
    "    PartGroup, Part, Faces, Edges\n",
    ")\n",
    "from cadquery_massembly import Mate, MAssembly, relocate\n",
    "\n",
    "cv = open_viewer(\"Door\")\n"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "set_defaults(axes=False, axes0=True, mate_scale=10)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "**Note:** Download https://www.matronics.dk/data/longship/files/products/vslot-2020_1.dxf first if you don't have it at hand"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# Parameters\n",
    "H = 400\n",
    "W = 200\n",
    "D = 350\n",
    "\n",
    "PROFILE = cq.importers.importDXF(\"vslot-2020_1.dxf\").wires()\n",
    "\n",
    "SLOT_D = 6\n",
    "PANEL_T = 3\n",
    "\n",
    "HANDLE_D = 20\n",
    "HANDLE_L = 50\n",
    "HANDLE_W = 4"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "def make_vslot(l):\n",
    "\n",
    "    return PROFILE.toPending().extrude(l)\n",
    "\n",
    "\n",
    "def make_connector():\n",
    "\n",
    "    rv = (\n",
    "        cq.Workplane()\n",
    "        .box(20, 20, 20)\n",
    "        .faces(\"<X\")\n",
    "        .workplane()\n",
    "        .cboreHole(6, 15, 18)\n",
    "        .faces(\"<Z\")\n",
    "        .workplane(centerOption=\"CenterOfMass\")\n",
    "        .cboreHole(6, 15, 18)\n",
    "    )\n",
    "\n",
    "    # tag mating faces\n",
    "    rv.faces(\">X\").tag(\"X\").end()\n",
    "    rv.faces(\">Z\").tag(\"Z\").end()\n",
    "\n",
    "    return rv\n",
    "\n",
    "\n",
    "def make_panel(w, h, t, cutout):\n",
    "\n",
    "    rv = (\n",
    "        cq.Workplane(\"XZ\")\n",
    "        .rect(w, h)\n",
    "        .extrude(t)\n",
    "        .faces(\">Y\")\n",
    "        .vertices()\n",
    "        .rect(2*cutout,2*cutout)\n",
    "        .cutThruAll()\n",
    "        .faces(\"<Y\")\n",
    "        .workplane()\n",
    "        .pushPoints([(-w / 3, HANDLE_L / 2), (-w / 3, -HANDLE_L / 2)])\n",
    "        .hole(3)\n",
    "    )\n",
    "\n",
    "    # tag mating edges\n",
    "    rv.faces(\"<Y\").edges(\"%CIRCLE\").edges(\">Z\").tag(\"hole1\")\n",
    "    rv.faces(\"<Y\").edges(\"%CIRCLE\").edges(\"<Z\").tag(\"hole2\")\n",
    "\n",
    "    return rv\n",
    "\n",
    "\n",
    "def make_handle(w, h, r):\n",
    "\n",
    "    pts = ((0, 0), (w, 0), (w, h), (0, h))\n",
    "\n",
    "    path = cq.Workplane().polyline(pts)\n",
    "\n",
    "    rv = (\n",
    "        cq.Workplane(\"YZ\")\n",
    "        .rect(r, r)\n",
    "        .sweep(path, transition=\"round\")\n",
    "        .tag(\"solid\")\n",
    "        .faces(\"<X\")\n",
    "        .workplane()\n",
    "        .faces(\"<X\", tag=\"solid\")\n",
    "        .hole(r / 1.5)\n",
    "    )\n",
    "\n",
    "    # tag mating faces\n",
    "    rv.faces(\"<X\").faces(\">Y\").tag(\"mate1\")\n",
    "    rv.faces(\"<X\").faces(\"<Y\").tag(\"mate2\")\n",
    "\n",
    "    return rv"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Manual Assembly"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# Some shortcuts\n",
    "L = lambda *args: cq.Location(cq.Vector(*args))\n",
    "C = lambda *args: cq.Color(*args)\n",
    "\n",
    "h_slot = make_vslot(H)\n",
    "w_slot = make_vslot(W)\n",
    "conn = make_connector()\n",
    "\n",
    "# For visualisation of mate, spread elements by adding locs\n",
    "def make_door():\n",
    "    door = (\n",
    "        MAssembly(name=\"door\")              # add a name for hierarchical addressing \n",
    "        .add(w_slot, name=\"bottom\", color=web_color(\"silver\"))\n",
    "        .add(h_slot, name=\"left\", color=web_color(\"silver\"), loc=L(0, 40, 0))\n",
    "        .add(h_slot, name=\"right\", color=web_color(\"silver\"), loc=L(0, 80, 0))\n",
    "        .add(w_slot, name=\"top\", color=web_color(\"silver\"), loc=L(0, 120, 0))\n",
    "        .add(conn,   name=\"con_tl\", color=web_color(\"black\"), loc=L(0, 0, -40))\n",
    "        .add(conn,   name=\"con_tr\", color=web_color(\"black\"), loc=L(0, 40, -40))\n",
    "        .add(conn,   name=\"con_bl\", color=web_color(\"black\"), loc=L(0, 80, -40))\n",
    "        .add(conn,   name=\"con_br\", color=web_color(\"black\"), loc=L(0, 120, -40))\n",
    "        .add(\n",
    "            make_panel(W + 2*SLOT_D, H + 2*SLOT_D, PANEL_T, SLOT_D),\n",
    "            name=\"panel\",\n",
    "            color=cq.Color(0, 0, 1, 0.2),\n",
    "            loc=L(0, -40, H/2)\n",
    "        )\n",
    "        .add(\n",
    "            make_handle(HANDLE_D, HANDLE_L, HANDLE_W),\n",
    "            name=\"handle\",\n",
    "            color=cq.Color(\"yellow\"),\n",
    "            loc=L(0, -150, 0)\n",
    "        )\n",
    "    )\n",
    "    return door"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "from collections import OrderedDict as odict\n",
    "\n",
    "door = make_door()\n",
    "show(door, render_mates=False)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# add mates to the ends of the vslots\n",
    "for v in [\"bottom\", \"left\", \"top\", \"right\"]:\n",
    "    door.mate(f\"{v}@faces@>Z\", name=f\"{v}_0\", transforms=odict(rx=0))\n",
    "    door.mate(f\"{v}@faces@<Z\", name=f\"{v}_1\")\n",
    "\n",
    "# add mates to the connectors\n",
    "for c in [\"con_tl\", \"con_tr\", \"con_br\", \"con_bl\"]:\n",
    "    door.mate(f\"{c}?X\", name=f\"{c}_0\", transforms=odict(rx=180))\n",
    "    door.mate(f\"{c}?Z\", name=f\"{c}_1\", transforms=odict(rx=180)) \n",
    "\n",
    "# add mates to bottom vslot and panel\n",
    "door.mate(\"panel@faces@<Z\", name=\"panel_0\", transforms=odict(rx=180, rz=90))\n",
    "door.mate(\"bottom@faces@>X[-4]\", name=\"panel_1\")\n",
    "\n",
    "# add mates to handle and one hole\n",
    "door.mate(\"handle?mate1\", name=\"handle_0\", transforms=odict(rx=180))\n",
    "door.mate(\"panel?hole2\", name=\"handle_1\", transforms=odict(rx=180))\n",
    "\n",
    "show(door, render_mates=True)"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# manually assemble as you would in reality\n",
    "\n",
    "door.assemble(\"bottom_0\", \"con_bl_0\")    # add bottom vslot to bottom-left connector\n",
    "door.assemble(\"con_br_1\", \"bottom_1\")    # add bottom-right connector to bottom vslot\n",
    "door.assemble(\"left_1\",   \"con_bl_1\")    # add left vslot to bottom-left connector\n",
    "door.assemble(\"right_0\",  \"con_br_0\")    # add right vslot to bottom-right connector\n",
    "door.assemble(\"panel_0\",  \"panel_1\")     # add panel\n",
    "door.assemble(\"con_tl_0\", \"left_0\")      # add top-left connector to left vslot\n",
    "door.assemble(\"con_tr_1\", \"right_1\")     # add top-right connector to right vslot\n",
    "door.assemble(\"top_1\",    \"con_tl_1\")    # add top vslot to top-left connector\n",
    "door.assemble(\"handle_0\", \"handle_1\")    # add handle\n",
    "\n",
    "show(door, render_mates=False)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# The Solver based tutorial"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "cv2 = open_viewer(\"Door2\")"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "import cadquery as cq\n",
    "\n",
    "# Parameters\n",
    "H = 400\n",
    "W = 200\n",
    "D = 350\n",
    "\n",
    "PROFILE = cq.importers.importDXF(\"./vslot-2020_1.dxf\").wires()\n",
    "\n",
    "SLOT_D = 6\n",
    "PANEL_T = 3\n",
    "\n",
    "HANDLE_D = 20\n",
    "HANDLE_L = 50\n",
    "HANDLE_W = 4\n",
    "\n",
    "\n",
    "def make_vslot(l):\n",
    "\n",
    "    return PROFILE.toPending().extrude(l)\n",
    "\n",
    "\n",
    "def make_connector():\n",
    "\n",
    "    rv = (\n",
    "        cq.Workplane()\n",
    "        .box(20, 20, 20)\n",
    "        .faces(\"<X\")\n",
    "        .workplane()\n",
    "        .cboreHole(6, 15, 18)\n",
    "        .faces(\"<Z\")\n",
    "        .workplane(centerOption=\"CenterOfMass\")\n",
    "        .cboreHole(6, 15, 18)\n",
    "    )\n",
    "\n",
    "    # tag mating faces\n",
    "    rv.faces(\">X\").tag(\"X\").end()\n",
    "    rv.faces(\">Z\").tag(\"Z\").end()\n",
    "\n",
    "    return rv\n",
    "\n",
    "\n",
    "def make_panel(w, h, t, cutout):\n",
    "\n",
    "    rv = (\n",
    "        cq.Workplane(\"XZ\")\n",
    "        .rect(w, h)\n",
    "        .extrude(t)\n",
    "        .faces(\">Y\")\n",
    "        .vertices()\n",
    "        .rect(2*cutout,2*cutout)\n",
    "        .cutThruAll()\n",
    "        .faces(\"<Y\")\n",
    "        .workplane()\n",
    "        .pushPoints([(-w / 3, HANDLE_L / 2), (-w / 3, -HANDLE_L / 2)])\n",
    "        .hole(3)\n",
    "    )\n",
    "\n",
    "    # tag mating edges\n",
    "    rv.faces(\">Y\").edges(\"%CIRCLE\").edges(\">Z\").tag(\"hole1\")\n",
    "    rv.faces(\">Y\").edges(\"%CIRCLE\").edges(\"<Z\").tag(\"hole2\")\n",
    "\n",
    "    return rv\n",
    "\n",
    "\n",
    "def make_handle(w, h, r):\n",
    "\n",
    "    pts = ((0, 0), (w, 0), (w, h), (0, h))\n",
    "\n",
    "    path = cq.Workplane().polyline(pts)\n",
    "\n",
    "    rv = (\n",
    "        cq.Workplane(\"YZ\")\n",
    "        .rect(r, r)\n",
    "        .sweep(path, transition=\"round\")\n",
    "        .tag(\"solid\")\n",
    "        .faces(\"<X\")\n",
    "        .workplane()\n",
    "        .faces(\"<X\", tag=\"solid\")\n",
    "        .hole(r / 1.5)\n",
    "    )\n",
    "\n",
    "    # tag mating faces\n",
    "    rv.faces(\"<X\").faces(\">Y\").tag(\"mate1\")\n",
    "    rv.faces(\"<X\").faces(\"<Y\").tag(\"mate2\")\n",
    "\n",
    "    return rv\n",
    "\n",
    "\n",
    "# define the elements\n",
    "door = (\n",
    "    cq.Assembly()\n",
    "    .add(make_vslot(H), name=\"left\")\n",
    "    .add(make_vslot(H), name=\"right\")\n",
    "    .add(make_vslot(W), name=\"top\")\n",
    "    .add(make_vslot(W), name=\"bottom\")\n",
    "    .add(make_connector(), name=\"con_tl\", color=cq.Color(\"black\"))\n",
    "    .add(make_connector(), name=\"con_tr\", color=cq.Color(\"black\"))\n",
    "    .add(make_connector(), name=\"con_bl\", color=cq.Color(\"black\"))\n",
    "    .add(make_connector(), name=\"con_br\", color=cq.Color(\"black\"))\n",
    "    .add(\n",
    "        make_panel(W + 2*SLOT_D, H + 2*SLOT_D, PANEL_T, SLOT_D),\n",
    "        name=\"panel\",\n",
    "        color=cq.Color(0, 0, 1, 0.2),\n",
    "    )\n",
    "    .add(\n",
    "        make_handle(HANDLE_D, HANDLE_L, HANDLE_W),\n",
    "        name=\"handle\",\n",
    "        color=cq.Color(\"yellow\"),\n",
    "    )\n",
    ")\n",
    "\n",
    "# define the constraints\n",
    "(\n",
    "    door\n",
    "    # left profile\n",
    "    .constrain(\"left@faces@<Z\", \"con_bl?Z\", \"Plane\")\n",
    "    .constrain(\"left@faces@<X\", \"con_bl?X\", \"Axis\")\n",
    "    .constrain(\"left@faces@>Z\", \"con_tl?Z\", \"Plane\")\n",
    "    .constrain(\"left@faces@<X\", \"con_tl?X\", \"Axis\")\n",
    "    # top\n",
    "    .constrain(\"top@faces@<Z\", \"con_tl?X\", \"Plane\")\n",
    "    .constrain(\"top@faces@<Y\", \"con_tl@faces@>Y\", \"Axis\")\n",
    "    # bottom\n",
    "    .constrain(\"bottom@faces@<Y\", \"con_bl@faces@>Y\", \"Axis\")\n",
    "    .constrain(\"bottom@faces@>Z\", \"con_bl?X\", \"Plane\")\n",
    "    # right connectors\n",
    "    .constrain(\"top@faces@>Z\", \"con_tr@faces@>X\", \"Plane\")\n",
    "    .constrain(\"bottom@faces@<Z\", \"con_br@faces@>X\", \"Plane\")\n",
    "    .constrain(\"left@faces@>Z\", \"con_tr?Z\", \"Axis\")\n",
    "    .constrain(\"left@faces@<Z\", \"con_br?Z\", \"Axis\")\n",
    "    # right profile\n",
    "    .constrain(\"right@faces@>Z\", \"con_tr@faces@>Z\", \"Plane\")\n",
    "    .constrain(\"right@faces@<X\", \"left@faces@<X\", \"Axis\")\n",
    "    # panel\n",
    "    .constrain(\"left@faces@>X[-4]\", \"panel@faces@<X\", \"Plane\")\n",
    "    .constrain(\"left@faces@>Z\", \"panel@faces@>Z\", \"Axis\")\n",
    "    # handle\n",
    "    .constrain(\"panel?hole1\", \"handle?mate1\", \"Plane\")\n",
    "    .constrain(\"panel?hole2\", \"handle?mate2\", \"Point\")\n",
    ")\n",
    "\n",
    "# solve\n",
    "door.solve()\n",
    "\n",
    "show_object(door,name='door')"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": []
  }
 ],
 "metadata": {
  "language_info": {
   "name": "python",
   "pygments_lexer": "ipython3"
  },
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 4
}