FreeCAD工作台中distToShape方法失效问题咨询

常见原因 #

• 形状对象引用无效：控制台运行时直接调用当前活跃文档的实时对象，而工作台命令中可能引用了旧的、已被修改/删除的对象，或是未切换到正确的文档上下文，导致传入distToShape的Shape对象无效。
• 事务上下文冲突：工作台命令通常在openTransaction()包裹的事务中执行操作，未提交事务时，形状的拓扑数据可能处于未更新状态，此时调用distToShape会因数据不稳定失败；而控制台无事务包裹，形状状态稳定。
• 形状未完成重计算：命令中创建或修改形状后未触发重计算，形状的拓扑几何数据尚未生成，导致测量无法进行；控制台中可能自动或手动执行过recompute()，所以能正常运行。

解决方法 #

• 确保使用当前文档的有效形状
  先获取当前活跃文档，再从中获取对象，避免使用缓存的旧引用：

  doc = FreeCAD.ActiveDocument
  sphere_obj = doc.getObject("Sphere")
  cube_obj = doc.getObject("Cube")
  

  同时检查对象及Shape属性的有效性：

  if not sphere_obj or not hasattr(sphere_obj, "Shape") or not sphere_obj.Shape.isValid():
      FreeCAD.Console.PrintError("Sphere shape is invalid!\n")
      return
  

• 调整事务执行时机
  如果命令中使用了事务，将测量代码放在事务提交后执行，或者在测量前手动提交事务：

  doc.openTransaction("Measure Distance")
  # 其他操作...
  doc.commitTransaction()
  # 执行测量
  dist = sphere_obj.Shape.distToShape(cube_obj.Shape)
  

  若必须在事务内测量，先触发重计算确保形状数据更新：

  doc.recompute()
  

• 强制触发重计算
  在调用distToShape前，对涉及的对象或整个文档执行重计算：

  sphere_obj.recompute()
  cube_obj.recompute()
  # 或 doc.recompute()
  dist_info = sphere_obj.Shape.distToShape(cube_obj.Shape)
  

• 检查几何参数合法性
  确认测量对象的几何参数有效（如球体半径、立方体边长不为0），避免因参数错误导致形状本身无效。

示例代码 #

class MeasureDistanceCommand:
    def Activated(self):
        doc = FreeCAD.ActiveDocument
        if not doc:
            FreeCAD.Console.PrintError("No active document!\n")
            return
        
        sphere_obj = doc.getObject("Sphere")
        cube_obj = doc.getObject("Cube")
        
        if not sphere_obj or not cube_obj:
            FreeCAD.Console.PrintError("Missing Sphere or Cube object!\n")
            return
        
        # 确保形状有效并重计算
        if not sphere_obj.Shape.isValid():
            sphere_obj.recompute()
        if not cube_obj.Shape.isValid():
            cube_obj.recompute()
        
        try:
            dist, pts1, pts2 = sphere_obj.Shape.distToShape(cube_obj.Shape)
            FreeCAD.Console.PrintMessage(f"Distance between shapes: {dist}\n")
            FreeCAD.Console.PrintMessage(f"Closest points: {pts1[0]} | {pts2[0]}\n")
        except Exception as e:
            FreeCAD.Console.PrintError(f"Measurement failed: {str(e)}\n")
    
    def GetResources(self):
        return {
            "MenuText": "Measure Shape Distance",
            "ToolTip": "Calculate distance between two selected shapes",
            "Pixmap": ""  # 可添加自定义图标路径
        }

FreeCADGui.addCommand("MeasureShapeDistance", MeasureDistanceCommand())

内容的提问来源于stack exchange，提问作者Boris Beliyavtsev