osis-python 0.6.3__tar.gz → 0.6.4__tar.gz

{osis_python-0.6.3/src/osis_python.egg-info → osis_python-0.6.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: osis-python
-Version: 0.6.3
+Version: 0.6.4
 Summary: A Python client library for Osis APDL
 Author-email: "CCCC Highway Consultant Co. Ltd." <support@osisbim.com>
 License-Expression: MIT

{osis_python-0.6.3 → osis_python-0.6.4/src/osis_python.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: osis-python
-Version: 0.6.3
+Version: 0.6.4
 Summary: A Python client library for Osis APDL
 Author-email: "CCCC Highway Consultant Co. Ltd." <support@osisbim.com>
 License-Expression: MIT

{osis_python-0.6.3 → osis_python-0.6.4}/src/pyosis/__init__.py

@@ -7,7 +7,7 @@ A library for extending OSIS functionality.
 A library that allows users to use CAE with great flexibility.
 """
 
-__version__ = "0.6.3"
+__version__ = "0.6.4"
 __author__ = "CCCC Highway Consultant Co. Ltd." # 中交公路规划设计院 - 工程技术研究中心 - lzh - wjh - myf
 
 from .core.engine import OSISEngine

{osis_python-0.6.3 → osis_python-0.6.4}/src/pyosis/display/interface.py

@@ -60,6 +60,7 @@ def osis_disp_ctrl(
 def osis_control(
     eAction: str,
     eArg: str | None = None,
+    *dValues,
 ):
     """视图 / 界面控制命令。
 
@@ -70,7 +71,9 @@ def osis_control(
             * ``view`` = 切换视图方向（配合 eArg）
             * 其他如 ``quickCreateModel`` 等
         eArg (str | None): 子命令参数
-            * 当 eAction 为 ``view`` 时: ``standard`` / ``top`` / ``right`` / ``front``
+            * 当 eAction 为 ``view`` 时: ``standard`` / ``top`` / ``right`` /
+              ``front`` / ``zoom`` / ``move``
+        dValues: 附加参数
 
     Returns:
         tuple (bool, str): 是否成功，失败原因
@@ -80,6 +83,7 @@ def osis_control(
         >>> osis_control("view", "top")
         >>> osis_control("view", "right")
         >>> osis_control("view", "front")
+        >>> osis_control("view", "zoom", 0.8)
     """
     pass
 
@@ -101,3 +105,24 @@ def osis_plsm(bFlag: Literal[0, 1] = 1):
         >>> osis_plsm(0)
     """
     pass
+
+@REGISTRY.register("jpeg")
+def osis_jpeg(path: str = "image"):
+    """截图工具。
+
+    格式: ``jpeg,path``
+
+    Args:
+        path (str): 图片保存路径/文件名。文件扩展名固定为 ``.jpg``。
+            当仅传入文件名（不含目录分隔符）时，图片默认保存到
+            ``<project_dir>/image/{path}.jpg``；
+            传入完整路径（如 ``D:\\reports\\fig1``）则保存到对应位置。
+
+    Returns:
+        tuple (bool, str): 是否成功，失败原因
+
+    Examples:
+        >>> osis_jpeg("IMG_盖梁裂缝宽度计算结果图")
+        >>> osis_jpeg(r"D:\\reports\\fig1")
+    """
+    pass

{osis_python-0.6.3 → osis_python-0.6.4}/src/pyosis/display/manager.py

@@ -15,7 +15,7 @@ from __future__ import annotations
 
 from typing import Literal, Sequence, Union
 
-from .interface import osis_control, osis_disp_ctrl, osis_plsm
+from .interface import osis_control, osis_disp_ctrl, osis_plsm, osis_jpeg
 
 
 class DisplayManager:
@@ -55,28 +55,45 @@ class DisplayManager:
         if not ok:
             raise RuntimeError(f"显示控制失败: {err}")
 
-    def control(self, action: str, arg: str | None = None) -> None:
+    def control(self, action: str, arg: str | None = None, *values) -> None:
         """视图 / 界面控制（对应 ``/control,...``）。
 
         Args:
             action: 子命令，如 ``view``、``quickCreateModel``
-            arg: 子命令参数；``view`` 时为 ``standard`` / ``top`` / ``right`` / ``front``
+            arg: 子命令参数；``view`` 时为 ``standard`` / ``top`` / ``right`` /
+                ``front`` / ``zoom`` / ``move``
+            *values: 附加参数。``view`` 子命令下：
+                * ``zoom``: 缩放系数（值越小模型越小）
+                * ``move``: (x, y) 像素偏移
 
         Raises:
             RuntimeError: 操作失败时抛出异常
+
+        Examples:
+            >>> display_manager.control("view", "top")
+            >>> display_manager.control("view", "zoom", 0.8)
+            >>> display_manager.control("view", "move", 30, 10)
         """
-        ok, err = osis_control(action, arg)
+        ok, err = osis_control(action, arg, *values)
         if not ok:
             raise RuntimeError(f"界面控制失败: {err}")
 
     def set_view(
         self,
-        view: Literal["standard", "top", "right", "front"] = "standard",
+        view: Literal["standard", "top", "right", "front", "zoom", "move"] = "standard",
+        *values,
     ) -> None:
         """切换视图方向。
 
         Args:
-            view: ``standard`` / ``top`` / ``right`` / ``front``
+            view: 视图
+                * ``standard``: 标准视图
+                * ``top``: 俯视
+                * ``right``: 右视
+                * ``front``: 前视
+                * ``zoom``: 缩放（附加系数：值越小模型越小）
+                * ``move``: 平移（附加参数：x, y）
+            *values: ``zoom`` 时为缩放系数，``move`` 时为 x, y 像素偏移
 
         Raises:
             RuntimeError: 操作失败时抛出异常
@@ -84,8 +101,10 @@ class DisplayManager:
         Examples:
             >>> display_manager.set_view("top")
             >>> display_manager.set_view("front")
+            >>> display_manager.set_view("zoom", 0.8)
+            >>> display_manager.set_view("move", 30, 10)
         """
-        self.control("view", view)
+        self.control("view", view, *values)
 
     def set_plsm(self, enabled: Literal[0, 1] = 1) -> None:
         """显示开关（Plsm）。
@@ -104,6 +123,28 @@ class DisplayManager:
         if not ok:
             raise RuntimeError(f"设置 Plsm 失败: {err}")
 
+    def capture(self, path: str) -> None:
+        """截图工具（对应 ``jpeg,...``）。
+
+        把当前画面截图保存到 ``path``。文件扩展名固定为 ``.jpg``。
+        若仅传入文件名（不含目录分隔符），图片默认保存到
+        ``<project_dir>/image/{path}.jpg``；传入完整路径则保存到对应位置。
+
+        Args:
+            path: 图片保存路径或文件名
+
+        Raises:
+            RuntimeError: 截图失败时抛出异常
+
+        Examples:
+            >>> display_manager.capture("D:\\reports\\fig1.jpg")
+            >>> display_manager.capture("crack.jpg")    # 保存到 <project_dir>/image/crack.jpg
+            >>> display_manager.capture("crack")        # 保存到 <project_dir>/image/crack.jpg
+        """
+        ok, err = osis_jpeg(path)
+        if not ok:
+            raise RuntimeError(f"截图失败: {err}")
+
     def __repr__(self) -> str:
         return "DisplayManager()"
 

{osis_python-0.6.3 → osis_python-0.6.4}/src/pyosis/property/component_thickness.py

@@ -9,7 +9,10 @@ def osis_assign_component_thickness(dThickness: float, strOp: Literal['a', 's',
 
     Args:
         dThickness (float): 构件理论厚度
-        strOp (str): 操作；a = 添加，s = 替换，r = 移除；
+        strOp (str): 操作
+            * a = 添加，再次调用会覆盖旧参数
+            * s = 替换
+            * r = 移除
         *strElem (str): 待分配单元的编号。注：定义、修改、删除 elem支持的格式：*to*
 
     Returns:

{osis_python-0.6.3 → osis_python-0.6.4}/src/pyosis/property/manager.py

@@ -890,11 +890,14 @@ class PropertyManager:
         Args:
             thickness (float): 构件理论厚度
             op (str): 操作
-                * a = 添加
+                * a = 添加，再次调用会覆盖旧参数
                 * s = 替换
                 * r = 移除
             *elems (str|int): 待分配单元的编号。定义、修改、删除 elem 支持的格式：*to*
 
+        Examples:
+            >>> assign_component_thickness(0.2, s, 1, 2, 3)     # 将 1 2 3号单元的厚度修改为 0.2
+
         Raises:
             RuntimeError: 分配失败时抛出
         '''