feat: sending designRuleChecks to web-based UI

Author: Dhruv-0-Arora

exporter/SynthesisFusionAddin/src/DesignRuleChecks.py

@@ -0,0 +1,49 @@
+from typing import List, TypedDict, Callable
+
+import adsk.core
+import adsk.fusion
+
+from src import Logging, gm
+
+class DesignRule(TypedDict):
+    name: str
+    calculation: Callable[[], float]
+    max_value: float
+
+class DesignRuleChecks:
+    designRules: List[DesignRule]
+
+    @Logging.logFailure
+    def __init__(self) -> None:
+        self.designRules = [
+            {
+                "name": "Design Height",
+                "calculation": self.fusion_design_height,
+                "max_value": 106.0,  # cm
+            },
+            {
+                "name": "Design Perimeter",
+                "calculation": self.fusion_design_perimeter,
+                "max_value": 304.0,  # cm
+            },
+        ]
+
+
+    def getDesignRules(self) -> List[DesignRule]:
+        return self.designRules
+
+    @Logging.logFailure
+    def fusion_design_height(self) -> float:
+        design = adsk.fusion.Design.cast(gm.app.activeProduct)
+        if design:
+            overall_bounding_box = design.rootComponent.orientedMinimumBoundingBox
+            return float(overall_bounding_box.width)
+        return 0.0
+
+    @Logging.logFailure
+    def fusion_design_perimeter(self) -> float:
+        design = adsk.fusion.Design.cast(gm.app.activeProduct)
+        if design:
+            overall_bounding_box = design.rootComponent.orientedMinimumBoundingBox
+            return float(2 * (overall_bounding_box.height + overall_bounding_box.length))
+        return 0.0

exporter/SynthesisFusionAddin/src/UI/ConfigCommand.py

@@ -28,6 +28,7 @@
 from src.Types import SELECTABLE_JOINT_TYPES, ExportLocation, ExportMode
 from src.UI import FileDialogConfig
 from src.UI.Handlers import PersistentEventHandler
+from src.DesignRuleChecks import DesignRuleChecks
 from src.Util import convertMassUnitsTo, designMassCalculation
 
 generalConfigTab: GeneralConfigTab.GeneralConfigTab
@@ -299,6 +300,9 @@ def notify(self, html_args: adsk.core.HTMLEventArgs) -> None:
         elif html_args.action == "cancelSelection":
             gm.ui.terminateActiveCommand()
             html_args.returnData = "{}"
+
+        elif html_args.action == "designRules":
+            html_args.returnData = DesignRuleChecks().getDesignRules
         else:
             gm.ui.messageBox(f"Event {html_args.action} arrived<span>{json.dumps(data, indent=2)}</span>")
 

exporter/SynthesisFusionAddin/src/UI/DesignCheckTab.py

@@ -3,23 +3,17 @@
 import adsk.core
 import adsk.fusion
 
-from src import Logging, gm
+from src import Logging
 from src.UI import IconPaths
+from src.DesignRuleChecks import DesignRuleChecks
 
 logger = Logging.getLogger()
 
 
-class DesignRule(TypedDict):
-    name: str
-    calculation: Callable[[], float]
-    max_value: float
-
-
 class DesignCheckTab:
     designCheckTab: adsk.core.TabCommandInput
     designCheckTable: adsk.core.TableCommandInput
-    designRules: Dict[str, Any] = {}
-    design_rules: List[DesignRule]
+    designRuleChecks: DesignRuleChecks
 
     @Logging.logFailure
     def __init__(self, args: adsk.core.CommandCreatedEventArgs) -> None:
@@ -34,21 +28,9 @@ def __init__(self, args: adsk.core.CommandCreatedEventArgs) -> None:
             adsk.core.TablePresentationStyles.itemBorderTablePresentationStyle
         )
 
-        # Define and add design rules to the table
-        self.design_rules = [
-            {
-                "name": "Design Height",
-                "calculation": self.fusion_design_height,
-                "max_value": 106.0,  # cm
-            },
-            {
-                "name": "Design Perimeter",
-                "calculation": self.fusion_design_perimeter,
-                "max_value": 304.0,  # cm
-            },
-        ]
+        self.designRuleChecks = DesignRuleChecks()
 
-        for i, rule in enumerate(self.design_rules):
+        for i, rule in enumerate(self.designRuleChecks.getDesignRules()):
             calculation = rule["calculation"]
             max_value: float = rule["max_value"]
             value: float = calculation()
@@ -81,19 +63,3 @@ def isVisible(self, value: bool) -> None:
     @property
     def isActive(self) -> bool:
         return self.designCheckTab.isActive or False
-
-    @Logging.logFailure
-    def fusion_design_height(self) -> float:
-        design = adsk.fusion.Design.cast(gm.app.activeProduct)
-        if design:
-            overall_bounding_box = design.rootComponent.orientedMinimumBoundingBox
-            return float(overall_bounding_box.width)
-        return 0.0
-
-    @Logging.logFailure
-    def fusion_design_perimeter(self) -> float:
-        design = adsk.fusion.Design.cast(gm.app.activeProduct)
-        if design:
-            overall_bounding_box = design.rootComponent.orientedMinimumBoundingBox
-            return float(2 * (overall_bounding_box.height + overall_bounding_box.length))
-        return 0.0

exporter/SynthesisFusionAddin/web/src/App.tsx

@@ -1,7 +1,7 @@
 import { useCallback, useEffect, useState } from "react"
 
 import "./App.css"
-import { RestartAlt, Settings, SportsFootball, Texture } from "@mui/icons-material"
+import { RestartAlt, Settings, SportsFootball, Texture, CheckBox } from "@mui/icons-material"
 import DownloadIcon from "@mui/icons-material/Download"
 import PrecisionManufacturingIcon from "@mui/icons-material/PrecisionManufacturing"
 import SaveIcon from "@mui/icons-material/Save"
@@ -37,6 +37,7 @@ import GeneralConfigTab from "./ui/GeneralConfigTab.tsx"
 import GlobalAlert from "./ui/GlobalAlert.tsx"
 import JointsConfigTab from "./ui/JointsConfigTab.tsx"
 import MaterialTaggingTab, { type TaggedBody } from "./ui/MaterialTaggingTab.tsx"
+import DesignCheckTab from "./ui/DesignCheckTab.tsx"
 
 function TabPanel(props: { children?: React.ReactNode; value: number; index: number }) {
     const { children, value, index, ...other } = props
@@ -228,6 +229,7 @@ function App() {
                         />
 
                         <Tab icon={<Texture />} iconPosition={"start"} label="Materials" />
+                        <Tab icon={<CheckBox />} iconPosition={"start"} label="Design Check" />
 
                         {/*<Tab label="APS" />*/}
                     </Tabs>
@@ -259,6 +261,9 @@ function App() {
                     selection={{ isSelecting, setIsSelecting }}
                 />
             </TabPanel>
+            <TabPanel value={activeTab} index={2}>
+                <DesignCheckTab />
+            </TabPanel>
             <Container
                 sx={{
                     position: "sticky",

exporter/SynthesisFusionAddin/web/src/lib/index.ts

@@ -28,6 +28,7 @@ interface Messages {
     selectJoint: [Empty, FusionJoint]
     selectGamepiece: [Empty, FusionGamepiece[]]
     selectBody: [Empty, FusionBody]
+    designRules: [Empty, DesignRule[]]
     export: [ExporterConfig, Empty]
     save: [ExporterConfig, Empty]
     init: [Empty, InitResponse]
@@ -146,3 +147,28 @@ window.fusionJavaScriptHandler = {
         return "OK"
     },
 }
+
+export interface DesignRule {
+    name: string,
+    calculation: number,
+    max_value: number
+}
+export async function getDesignRules(): Promise<DesignRule[] | undefined> {
+    if (import.meta.env.DEV && typeof window.adsk === "undefined") {
+        return new Promise<DesignRule[]>(resolve => {
+            setTimeout(() => {
+                const token = Math.random().toString(36).substring(2, 15)
+                resolve([
+                    {
+                        name: token,
+                        calculation: parseFloat(token),
+                        max_value: parseFloat(token)
+                    }
+                ])
+            }, 2000)
+        })
+    }
+
+    return await sendData("designRules", {})
+}
+

exporter/SynthesisFusionAddin/web/src/ui/DesignCheckTab.tsx

@@ -7,32 +7,55 @@ import {
     TableHead,
     TableRow,
 } from "@mui/material"
+import { useEffect, useState } from "react"
+import { type DesignRule, getDesignRules } from "../lib"
 
-interface DesignCheckTabProps { }
+interface DesignCheckTabProps {}
 
 function DesignCheckTab({}: DesignCheckTabProps) {
-    return (
-        <TableContainer component={Paper} elevation={6}>
-            <Table sx={{ minWidth: 650 }} aria-label="simple table" size={"small"}>
-                <TableHead>
-                    <TableRow>
-                        <TableCell sx={{ width: "28%" }} align="center">
-                            Component
-                        </TableCell>
-                        <TableCell sx={{ width: "28%" }} align="center">
-                            Calculation
-                        </TableCell>
-                        <TableCell sx={{ width: "40%" }} align="center">
-                            Is Valid
-                        </TableCell>
-                        <TableCell sx={{ width: "4%" }}></TableCell>
-                    </TableRow>
-                </TableHead>
-                <TableBody>
+    const [rules, setRules] = useState<DesignRule[]>([])
+
+    useEffect(() => {
+        getDesignRules().then(data => {
+            if (data) {
+                setRules(data)
+            }
+        })
+    }, [])
 
-                </TableBody>
-            </Table>
-        </TableContainer>
+    return (
+        <>
+            <TableContainer component={Paper} elevation={6}>
+                <Table sx={{ minWidth: 650 }} aria-label="simple table" size={"small"}>
+                    <TableHead>
+                        <TableRow>
+                            <TableCell sx={{ width: "28%" }} align="center">
+                                Component
+                            </TableCell>
+                            <TableCell sx={{ width: "28%" }} align="center">
+                                Calculation
+                            </TableCell>
+                            <TableCell sx={{ width: "40%" }} align="center">
+                                Is Valid
+                            </TableCell>
+                            <TableCell sx={{ width: "4%" }}></TableCell>
+                        </TableRow>
+                    </TableHead>
+                    <TableBody>
+                        {rules.map(rule => (
+                            <TableRow key={rule.name} sx={{ "&:last-child td, &:last-child th": { border: 0 } }}>
+                                <TableCell align="center">{rule.name}</TableCell>
+                                <TableCell align="center">{rule.calculation}</TableCell>
+                                <TableCell align="center">
+                                    {rule.calculation <= rule.max_value ? "Valid" : "Invalid"}
+                                </TableCell>
+                                <TableCell />
+                            </TableRow>
+                        ))}
+                    </TableBody>
+                </Table>
+            </TableContainer>
+        </>
     )
 }