luminarycloud 0.14.0__py3-none-any.whl → 0.15.0__py3-none-any.whl

luminarycloud/vis/visualization.py

@@ -1,27 +1,28 @@
-from .._proto.api.v0.luminarycloud.vis import vis_pb2
+import dataclasses as dc
+import io
+import json
+import logging
+from time import sleep, time
+from typing import Dict, List, Tuple, cast
+
 import luminarycloud._proto.api.v0.luminarycloud.common.common_pb2 as common_pb2
+import requests
+from luminarycloud.params.simulation.physics.fluid.boundary_conditions import Farfield
+from luminarycloud.types import Vector3, Vector3Like
+
 from .._client import get_default_client
-from ..solution import Solution
-from ..mesh import get_mesh_metadata, Mesh, get_mesh
-from ..geometry import Geometry, get_geometry, Tag
+from .._helpers._get_project_id import _get_project_id
+from .._proto.api.v0.luminarycloud.vis import vis_pb2
 from ..enum.vis_enums import *
-from ..enum.quantity_type import QuantityType
+from ..exceptions import NotFoundError
+from ..geometry import Geometry, get_geometry
+from ..mesh import Mesh, get_mesh, get_mesh_metadata
 from ..simulation import get_simulation
-from .display import DisplayAttributes, ColorMap, Field, ColorMapAppearance
-from .filters import Filter, PlaneClip, Slice, BoxClip, SurfaceStreamlines
-from luminarycloud.types import Vector3, Vector3Like
+from ..solution import Solution
 from ..types.vector3 import _to_vector3
-from .._helpers._get_project_id import _get_project_id
-from ..exceptions import NotFoundError
+from .display import ColorMap, ColorMapAppearance, DisplayAttributes, Field
+from .filters import BoxClip, Filter, PlaneClip, Slice, SurfaceStreamlines, SurfaceLIC
 from .interactive_scene import InteractiveScene
-import io
-import json
-from luminarycloud._proto.client import simulation_pb2 as clientpb
-from typing import List, Tuple, cast, Union, Dict
-import requests
-from time import time, sleep
-import logging
-import dataclasses as dc
 
 logger = logging.getLogger(__name__)
 
@@ -53,6 +54,13 @@ class DirectionalCamera:
     """The width of the output image in pixels. Default: 1024"""
     height: int = 1024
     """The height of the output image in pixels. Default: 1024"""
+    zoom_in: float = 1.0
+    """
+    Zooms in from the default camera distance. Valid values are in the (0,1]
+    range. A value of 0.5 means move the camera halfway between the default
+    point and the object (i.e., a 2x zoom). A value of 1 means no zoom. Default:
+    1.0
+    """
 
 
 @dc.dataclass
@@ -80,6 +88,20 @@ class LookAtCamera:
     """ The width of the output image in pixels. Default: 1024 """
     height: int = 1024
     """ The height of the output image in pixels. Default: 1024 """
+    pan_x: float = 0
+    """
+    Pan the camera in the x direction (right). This is a world space value defined in
+    the camera coordinate system. Pan is not typically directly set by the user,
+    but pan is useful for reproducing camera parameters from an interactive
+    scene where pan is used (i.e., control + middle mouse).
+    """
+    pan_y: float = 0
+    """
+    Pan the camera in the y direction (up). This is a world space value defined in
+    the camera coordinate system. Pan is not typically directly set by the user,
+    but pan is useful for reproducing camera parameters from an interactive
+    scene where pan is used (i.e., control + middle mouse).
+    """
 
 
 class _InternalToken:
@@ -320,7 +342,7 @@ class Scene:
 
     def __init__(self, entity: Geometry | Mesh | Solution):
         self.triad_visible: bool = True
-        self.axes_grid_visible: bool = True
+        self.axes_grid_visible: bool = False
         self.background_color: Vector3 = Vector3(x=0, y=0, z=0)
         self.auto_color_map_annotations = True
         self.supersampling: int = 2
@@ -372,7 +394,7 @@ class Scene:
             except NotFoundError:
                 self._has_tags = False
             except Exception as e:
-                raise ValueError("An unknow error occurred retrieving tags")
+                raise ValueError("An unknown error occurred retrieving tags")
         elif self._entity_type == EntityType.MESH:
             mesh_meta = get_mesh_metadata(self._mesh.id)
             try:
@@ -380,7 +402,7 @@ class Scene:
             except NotFoundError:
                 self._has_tags = False
             except Exception as e:
-                raise ValueError("An unknow error occurred retrieving tags")
+                raise ValueError("An unknown error occurred retrieving tags")
         else:
             geom = self._geometry
 
@@ -407,8 +429,8 @@ class Scene:
             params = simulation.get_parameters()
             for physics in params.physics:
                 if physics.fluid:
-                    for bc in physics.fluid.boundary_conditions_fluid:
-                        if bc.physical_boundary == clientpb.PhysicalBoundary.FARFIELD:
+                    for bc in physics.fluid.boundary_conditions:
+                        if isinstance(bc, Farfield):
                             for bc_surface in bc.surfaces:
                                 self._far_field_boundary_ids.append(bc_surface)
 
@@ -540,8 +562,13 @@ class Scene:
                 out_camera.look_at.position.CopyFrom(_to_vector3(lookat.position)._to_proto())
                 out_camera.look_at.up.CopyFrom(_to_vector3(lookat.up)._to_proto())
                 out_camera.look_at.look_at.CopyFrom(_to_vector3(lookat.look_at)._to_proto())
+                out_camera.look_at.pan.x = lookat.pan_x
+                out_camera.look_at.pan.y = lookat.pan_y
             elif isinstance(camera, DirectionalCamera):
                 out_camera.direction = camera.direction.value
+                if camera.zoom_in <= 0 or camera.zoom_in > 1:
+                    raise ValueError("Error: zoom_in must be in the range (0,1]")
+                out_camera.zoom = camera.zoom_in
             else:
                 raise TypeError(f"Internal error: expected 'camera', got {type(camera).__name__}")
 
@@ -579,6 +606,12 @@ class Scene:
                 bad_ids = self._validate_surfaces_and_tags(streamlines._surface_names)
                 if len(bad_ids) != 0:
                     raise ValueError(f"SurfaceStreamlines has invalid surfaces: {bad_ids}")
+            if isinstance(filter, SurfaceLIC):
+                # Validate surfaces names
+                lic = cast(SurfaceLIC, filter)
+                bad_ids = self._validate_surfaces_and_tags(lic._surface_names)
+                if len(bad_ids) != 0:
+                    raise ValueError(f"SurfaceLIC has invalid surfaces: {bad_ids}")
 
             if isinstance(filter, Filter):
                 vis_filter: vis_pb2.Filter = filter._to_proto()
@@ -623,6 +656,7 @@ class Scene:
                     # processing them above
                     cmap.appearance = ColorMapAppearance()
                     auto_cmaps.append(cmap)
+
             if len(auto_cmaps) != 0:
                 # These are all default contructed, so they all have the same dimentions.
                 # All the coordinates are in normalized device space.

luminarycloud/volume_selection.py

@@ -1,9 +1,9 @@
-# Copyright 2023-2024 Luminary Cloud, Inc. All Rights Reserved.
+# Copyright 2023-2025 Luminary Cloud, Inc. All Rights Reserved.
 from __future__ import annotations
 
 import logging
 from os import PathLike
-from typing import Iterable, Optional, TYPE_CHECKING
+from typing import Iterable, Iterator, Optional, TYPE_CHECKING
 from uuid import uuid4
 
 from luminarycloud._helpers import util
@@ -98,22 +98,26 @@ class VolumeSelection:
         """Clear the selection."""
         self.__volume_ids.clear()
 
-    def volumes(self) -> list[Volume]:
+    def __iter__(self) -> Iterator[Volume]:
         """
-        Get the volumes that are currently selected.
+        Return an iterator over the selected volumes.
         """
         res = self.__list_entities()
-        return [
-            Volume(
-                geometry_id=self.__geometry.id,
-                id=str(b.id),
-                _lcn_id=str(b.lcn_id),
-                bbox_min=Vector3(b.bbox_min.x, b.bbox_min.y, b.bbox_min.z),
-                bbox_max=Vector3(b.bbox_max.x, b.bbox_max.y, b.bbox_max.z),
-            )
-            for b in res.bodies
-            if b.id in self.__volume_ids
-        ]
+        for b in res.bodies:
+            if b.id in self.__volume_ids:
+                yield Volume(
+                    geometry_id=self.__geometry.id,
+                    id=str(b.id),
+                    _lcn_id=str(b.lcn_id),
+                    bbox_min=Vector3(b.bbox_min.x, b.bbox_min.y, b.bbox_min.z),
+                    bbox_max=Vector3(b.bbox_max.x, b.bbox_max.y, b.bbox_max.z),
+                )
+
+    def volumes(self) -> list[Volume]:
+        """
+        Return a list of the selected volumes.
+        """
+        return list(self)
 
     def import_cad(
         self,
@@ -205,7 +209,7 @@ class VolumeSelection:
 
     def subtract(
         self,
-        tool_volumes: list[Volume],
+        tool_volumes: Iterable[Volume],
         *,
         propagate_tags: bool = False,
         feature_name: str = "Subtract",
@@ -217,7 +221,7 @@ class VolumeSelection:
 
         Parameters
         ----------
-        tool_volumes : list[Volume]
+        tool_volumes : Iterable[Volume]
             The volumes to subtract from the selected volumes.
         propagate_tags : bool
             Whether to propagate the tool volume tags to the surfaces created by the subtraction.
@@ -261,7 +265,7 @@ class VolumeSelection:
 
     def chop(
         self,
-        tool_volumes: list[Volume],
+        tool_volumes: Iterable[Volume],
         *,
         propagate_tags: bool = False,
         feature_name: str = "Chop",
@@ -274,7 +278,7 @@ class VolumeSelection:
 
         Parameters
         ----------
-        tool_volumes : list[Volume]
+        tool_volumes : Iterable[Volume]
             The volumes to chop the selected volumes with.
         propagate_tags : bool
             Whether to propagate the tool volume tags to the surfaces created by the chop.
@@ -456,6 +460,7 @@ class VolumeSelection:
         self,
         resolution_min: Optional[float] = None,
         resolution_max: Optional[float] = None,
+        tool: Optional[Iterable[Volume]] = None,
         *,
         feature_name: str = "Shrinkwrap",
     ) -> None:
@@ -468,6 +473,8 @@ class VolumeSelection:
             The minimum resolution to shrinkwrap the selected volumes to.
         resolution_max : float, optional
             The maximum resolution to shrinkwrap the selected volumes to.
+        tool : VolumeSelection, optional
+            The tool volume selection to subtract from self in the shrinkwrap operation.
         feature_name : str
             The name of the feature.
         """
@@ -485,6 +492,10 @@ class VolumeSelection:
         else:
             mode = gpb.ShrinkwrapMode.AUTOMATIC
 
+        tool_ids = []
+        if tool is not None:
+            tool_ids = [int(v.id) for v in tool]
+
         self.__create_feature(
             gpb.Feature(
                 feature_name=feature_name,
@@ -493,6 +504,7 @@ class VolumeSelection:
                     resolution_min=(resolution_min or 0.0),
                     resolution_max=(resolution_max or 0.0),
                     resolution_uniform=(resolution_min or 0.0),
+                    tool=tool_ids,
                     mode=mode,
                 ),
             )

{luminarycloud-0.14.0.dist-info → luminarycloud-0.15.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: luminarycloud
-Version: 0.14.0
+Version: 0.15.0
 Summary: Luminary Cloud SDK
 Project-URL: Homepage, https://www.luminarycloud.com/
 Project-URL: Documentation, https://app.luminarycloud.com/docs/api/
@@ -45,6 +45,6 @@ and functionality may change significantly).
 import luminarycloud as lc
 project = lc.create_project("NACA 0012", "My first SDK project.")
 mesh = project.upload_mesh("./airfoil.lcmesh")
-sim_template = project.create_simulation_template("test template", "./simulation_template.json")
+sim_template = project.create_simulation_template("test template", params_json_path="./simulation_template.json")
 sim = project.create_simulation(mesh.id, "My simulation", sim_template.id)
 ```