dimine-python-sdk 0.1.8__py3-none-any.whl

dimine_python_sdk/docs/guides/data_edit.md

@@ -0,0 +1,306 @@
+# 数据修改
+主要用于修改数采软件场景内的模型对象、属性、图层、文件等数据，
+支持修改范围包括：创建、更新、删除模型对象、属性、图层、文件等
+
+
+## 1. 数采文件关闭
+将数采软件场景下的某个打开的文件关闭
+
+```python
+import asyncio
+from dimine_python_sdk.conn import open_client
+async def main():
+    async with open_client() as client:
+        # 获取文件列表
+        files = await client.get_files()
+        # 关闭文件
+        await files[0].close()
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+## 2. 数采文件打开
+将控制数采软件打开某个文件到当前场景下
+
+```python
+import asyncio
+from dimine_python_sdk.conn import open_client
+async def main():
+    async with open_client() as client:
+        file_path = "D:/test.dmf"   # 支持打开多种类型文件：dmf、dmm、cad、dmb、dmd、dmo
+        file = await client.open_file(file_path)
+        print(file.name)
+        print(file.id)
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+## 3. 创建或更新模型
+通过`update_or_create_geometry`方法批量创建或更新模型，如果模型已存在则更新，不存在则创建。
+
+```python
+import asyncio
+import numpy as np
+from dimine_python_sdk.conn import open_client
+from dimine_python_sdk.models.types import Point, Line, Shell, TINGeometry
+
+async def main():
+    async with open_client() as client:
+        # 获取当前文件的图层和要素
+        files = await client.get_files()
+        layers = await client.get_layers(file_id=files[len(files)-1].id)
+        features = await client.get_features(files[len(files)-1].id)
+
+        # 准备模型数据 - 包含点、线、实体
+        geometries = [
+            # 创建点
+            Point(
+                file=files[0].id,
+                layer=layers[0].id,
+                feature=features[0].name,
+                geometry=np.array([11, 32, 44]),
+                color=[255, 0, 0]  # 红色
+            ),
+            # 创建线（多段线）
+            Line(
+                file=files[0].id,
+                layer=layers[0].id,
+                feature=features[0].name,
+                geometry=np.array([[11, 12, 13], [14, 25, 26]]),
+                color=[0, 255, 0]  # 绿色
+            ),
+            # 创建实体（三角网）
+            Shell(
+                file=files[0].id,
+                layer=layers[0].id,
+                feature=features[0].name,
+                geometry=TINGeometry(
+                    points=np.array([[11, 12, 13], [14, 25, 26], [27, 28, 29]]),
+                    faces=np.array([[0, 1, 2]])  # 三个点构成一个三角形面
+                ),
+                color=[0, 0, 255]  # 蓝色
+            )
+        ]
+
+        # 批量创建或更新模型
+        await client.update_or_create_geometry(geometries)
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+## 4. 创建模型（单独）
+如果只需要创建新模型，使用`create_geometry`方法：
+
+```python
+import asyncio
+import numpy as np
+from dimine_python_sdk.conn import open_client
+from dimine_python_sdk.models.types import Point, Line, Shell, TINGeometry
+
+async def main():
+    async with open_client() as client:
+        # 获取当前文件、图层、要素信息
+        files = await client.get_files()
+        layers = await client.get_layers(file_id=files[0].id)
+        features = await client.get_features(files[0].id)
+
+        # 创建点模型
+        point = Point(
+            file=files[0].id,
+            layer=layers[0].id,
+            feature=features[0].name,
+            geometry=np.array([0, 0, 0])
+        )
+
+        await client.create_geometry([point])
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+## 5. 更新模型（单独）
+如果只需要更新已存在的模型，使用`update_geometry`方法：
+
+```python
+import asyncio
+from dimine_python_sdk.conn import open_client
+from dimine_python_sdk.models.types import Point
+
+async def main():
+    async with open_client() as client:
+        # 首先获取模型列表找到要更新的模型
+        files = await client.get_files()
+        layers = await client.get_layers(file_id=files[0].id)
+        geometries = await client.get_geometry(file_id=files[0].id, layer_id=layers[0].id)
+
+        # 找到第一个点模型
+        point_to_update = None
+        for geom in geometries:
+            if geom.type == "point":
+                point_to_update = geom
+                break
+
+        if point_to_update:
+            # 更新点坐标和颜色
+            point_to_update.geometry = np.array([100, 200, 300])
+            point_to_update.color = [255, 255, 0]  # 黄色
+
+            await client.update_geometry([point_to_update])
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+## 6. 创建图层
+
+创建新的图层：
+
+```python
+import asyncio
+from dimine_python_sdk.conn import open_client
+
+async def main():
+    async with open_client() as client:
+        files = await client.get_files()
+        # 创建新图层
+        layer = await client.create_layer(
+            file_id=files[len(files)-1].id,
+            name="test_layer"
+        )
+        print(f"创建图层: {layer.name}, ID: {layer.id}")
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+## 7. 删除图层
+
+删除指定图层：
+
+```python
+import asyncio
+from dimine_python_sdk.conn import open_client
+
+async def main():
+    async with open_client() as client:
+        files = await client.get_files()
+        # 创建测试图层
+        new_layer = await client.create_layer(
+            file_id=files[len(files)-1].id,
+            name="test_layer_to_delete"
+        )
+        # 删除图层
+        await client.delete_layer(
+            file_id=files[len(files)-1].id,
+            layer_name=new_layer.name
+        )
+        print("图层删除成功")
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+## 8. 更新模型
+
+更新已存在的模型属性、颜色或几何信息：
+
+```python
+import asyncio
+from dimine_python_sdk.conn import open_client
+
+async def main():
+    async with open_client() as client:
+        files = await client.get_files()
+        layers = await client.get_layers(file_id=files[len(files)-1].id)
+        features = await client.get_features(files[len(files)-1].id)
+        geometries = await client.get_geometry(
+            file_id=files[len(files)-1].id,
+            layer_id=layers[0].id
+        )
+
+        if len(geometries) > 0:
+            # 更新几何颜色
+            geometries[0].color = [255, 0, 0]  # 红色
+            # 更新几何坐标（如果需要）
+            # geometries[0].geometry = np.array([new_x, new_y, new_z])
+
+            await client.update_geometry([geometries[0]])
+            print(f"几何更新成功: {geometries[0].id}")
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+## 9. 删除模型
+
+删除指定的几何对象：
+
+```python
+import asyncio
+import numpy as np
+from dimine_python_sdk.conn import open_client
+from dimine_python_sdk.models.types import Point
+
+async def main():
+    async with open_client() as client:
+        files = await client.get_files()
+        layers = await client.get_layers(file_id=files[len(files)-1].id)
+        features = await client.get_features(files[len(files)-1].id)
+
+        # 先创建几何
+        new_point = Point(
+            file=files[0].id,
+            layer=layers[0].id,
+            feature=features[0].name,
+            geometry=np.array([100, 200, 300])
+        )
+        await client.create_geometry([new_point])
+        print(f"创建点几何: {new_point.id}")
+
+        # 删除几何
+        delete_items = [{"id": new_point.id, "file": files[0].id}]
+        await client.delete_geometry(delete_items)
+        print("几何删除成功")
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+## 10. 模型属性管理
+可以为模型添加自定义属性：
+
+```python
+import asyncio
+import numpy as np
+from dimine_python_sdk.conn import open_client
+from dimine_python_sdk.models.types import Point
+from dimine_python_sdk.models.types import PropertyValue
+
+async def main():
+    async with open_client() as client:
+        files = await client.get_files()
+        layers = await client.get_layers(file_id=files[0].id)
+        features = await client.get_features(files[0].id)
+
+        # 创建带属性的点
+        point = Point(
+            file=files[0].id,
+            layer=layers[0].id,
+            feature=features[0].name,
+            geometry=np.array([50, 50, 50]),
+            properties=[
+                PropertyValue(name="类型", value="勘探点", type="string"),
+                PropertyValue(name="高程", value="1250.5", type="float"),
+                PropertyValue(name="标识号", value="KP-001", type="string")
+            ]
+        )
+
+        await client.create_geometry([point])
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+

dimine_python_sdk/docs/guides/data_get.md

@@ -0,0 +1,266 @@
+# 数据获取
+
+主要用于从数采软件场景内获取模型对象、属性、图层、文件等信息
+
+## 1. 获取文件列表
+获取数采软件场景下的已经打开的文件列表，包含文件id、文件名
+
+```python
+import asyncio
+from dimine_python_sdk.conn import open_client
+async def main():
+    async with open_client() as client:
+        # 获取文件列表
+        files = await client.get_files()
+        for file in files:
+            print(file.name)
+            print(file.id)
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+## 2. 获取图层信息
+获取文件下的图层信息，包含图层id、图层名称、图层类型
+
+```python
+import asyncio
+from dimine_python_sdk.conn import open_client
+async def main():
+    async with open_client() as client:
+        # 获取文件列表
+        files = await client.get_files()
+        # 获取最后一个文件下的图层
+        layers = await client.get_layers(file_id=files[len(files)-1].id)
+        for layer in layers:
+            print(layer.id)
+            print(layer.name)
+            print(layer.layer_type)
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+## 3. 获取特定图层的模型
+
+通过指定图层ID来获取特定图层下的模型：
+
+```python
+import asyncio
+from dimine_python_sdk.conn import open_client
+async def main():
+    async with open_client() as client:
+        # 获取文件列表
+        files = await client.get_files()
+        # 获取文件的所有图层
+        layers = await client.get_layers(file_id=files[0].id)
+
+        # 获取第一个图层的所有模型
+        if len(layers) > 0:
+            geometries = await client.get_geometry(
+                file_id=files[0].id,
+                layer_id=layers[0].id,
+                entity_types=["point", "line", "shell"]
+            )
+
+            print(f"图层 '{layers[0].name}' 包含 {len(geometries)} 个模型")
+            for geometry in geometries:
+                print(f"  - {geometry.type}: {geometry.geometry}")
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+
+
+## 3. 获取模型对象
+
+获取模型对象，包含模型对象id、模型对象类型、模型对象颜色、所属要素、所属图层、属性数组、模型对象几何信息
+
+```python
+import asyncio
+from dimine_python_sdk.conn import open_client
+async def main():
+    async with open_client() as client:
+        # 获取文件列表
+        files = await client.get_files()
+        # 获取最后一个文件下的图层
+        layers = await client.get_layers(file_id=files[len(files)-1].id)
+        # 获取最后图层下的模型对象数组
+        geometries = await client.get_geometry(file_id=files[len(files)-1].id, layer_id=layers[0].id, ["point"])
+        for geometry in geometries:
+            print(geometry.id)          # 模型对象id
+            print(geometry.type)        # 模型对象类型
+            print(geometry.color)       # 展示颜色
+            print(geometry.feature)     # 所属要素
+            print(geometry.layer)       # 所属图层
+            print(geometry.properties)  # 属性数组
+            print(geometry.geometry)    # 模型对象几何信息：点: np.ndarray(3,), 线: np.ndarray(N,3), 实体: TINGeometry
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+## 4. 获取特定类型的模型
+
+可以通过`entity_types`参数过滤获取特定类型的模型：
+
+```python
+import asyncio
+from dimine_python_sdk.conn import open_client
+async def main():
+    async with open_client() as client:
+        # 获取文件列表
+        files = await client.get_files()
+        layers = await client.get_layers(file_id=files[0].id)
+
+        # 获取文件下所有图层中的所有类型的模型
+        geometries = await client.get_geometry(file_id=files[0].id, layer_id=layers[0].id, entity_types=["point", "line"])
+
+        for geometry in geometries:
+            print(f"类型: {geometry.type}, 坐标: {geometry.geometry}")
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+## 5. 获取特定要素的模型
+
+可以通过`features`参数过滤获取特定要素关联的模型：
+
+```python
+import asyncio
+from dimine_python_sdk.conn import open_client
+async def main():
+    async with open_client() as client:
+        # 获取文件列表
+        files = await client.get_files()
+        layers = await client.get_layers(file_id=files[0].id)
+        features = await client.get_features(files[0].id)
+
+        # 获取特定要素的模型
+        geometries = await client.get_geometry(
+            file_id=files[0].id,
+            layer_id=layers[0].id,
+            entity_types=["point", "line", "shell"],
+            features=[features[0].name]  # 只获取第一个要素的模型
+        )
+
+        for geometry in geometries:
+            print(f"要素: {geometry.feature}, 类型: {geometry.type}")
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+## 5. 获取要素信息
+
+获取文件中的要素定义，包括要素名称和属性定义：
+
+```python
+import asyncio
+from dimine_python_sdk.conn import open_client
+from dimine_python_sdk.models.types import FeatureInfo, PropertyInfo
+
+async def main():
+    async with open_client() as client:
+        # 获取文件列表
+        files = await client.get_files()
+        features = await client.get_features(files[0].id)
+
+        for feature in features:
+            print(f"要素名称: {feature.name}")
+            print("属性定义:")
+            for prop in feature.properties:
+                print(f"  - {prop.name}: {prop.type}")
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+## 6. 获取特定类型的模型
+
+可以通过`entity_types`参数过滤获取特定类型的模型：
+
+```python
+import asyncio
+from dimine_python_sdk.conn import open_client
+async def main():
+    async with open_client() as client:
+        # 获取文件列表
+        files = await client.get_files()
+        layers = await client.get_layers(file_id=files[0].id)
+
+        # 获取文件下所有图层中的所有类型的模型
+        geometries = await client.get_geometry(file_id=files[0].id, layer_id=layers[0].id, entity_types=["point", "line"])
+
+        for geometry in geometries:
+            print(f"类型: {geometry.type}, 坐标: {geometry.geometry}")
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+## 7. 获取特定要素的模型
+
+可以通过`features`参数过滤获取特定要素关联的模型：
+
+```python
+import asyncio
+from dimine_python_sdk.conn import open_client
+async def main():
+    async with open_client() as client:
+        # 获取文件列表
+        files = await client.get_files()
+        layers = await client.get_layers(file_id=files[0].id)
+        features = await client.get_features(files[0].id)
+
+        # 获取特定要素的模型
+        geometries = await client.get_geometry(
+            file_id=files[0].id,
+            layer_id=layers[0].id,
+            entity_types=["point", "line", "shell"],
+            features=[features[0].name]  # 只获取第一个要素的模型
+        )
+
+        for geometry in geometries:
+            print(f"要素: {geometry.feature}, 类型: {geometry.type}")
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```
+
+## 8. 获取实体（Shell）模型信息
+
+实体模型使用三角网（TIN）表示，包含顶点和面片信息：
+
+```python
+import asyncio
+from dimine_python_sdk.conn import open_client
+from dimine_python_sdk.models.types import Shell
+
+async def main():
+    async with open_client() as client:
+        # 获取文件列表
+        files = await client.get_files()
+        layers = await client.get_layers(file_id=files[0].id)
+
+        # 获取所有实体模型
+        geometries = await client.get_geometry(
+            file_id=files[0].id,
+            layer_id=layers[0].id,
+            entity_types=["shell"]
+        )
+
+        for geometry in geometries:
+            if isinstance(geometry, Shell):
+                print(f"实体ID: {geometry.id}")
+                print(f"顶点数: {geometry.geometry.points.shape[0]}")
+                print(f"面片数: {geometry.geometry.faces.shape[0]}")
+                print(f"顶点坐标: {geometry.geometry.points}")
+                print(f"面片索引: {geometry.geometry.faces}")
+                print(f"颜色: {geometry.color}")
+
+if __name__ == '__main__':
+    asyncio.run(main())
+```