luminarycloud 0.13.1__py3-none-any.whl → 0.14.1__py3-none-any.whl

luminarycloud/vis/visualization.py

@@ -39,29 +39,27 @@ class DirectionalCamera:
 
     .. warning:: This feature is experimental and may change or be removed in the future.
 
-    Attributes:
-    -----------
-    name : str
-        A user defined name for the camera.
-    direction : CameraDirection
-        The orientation of the camera. Default: X_POSITIVE
-    projection : CameraProjection
-        The type of projection used for the camera. Default: ORTHOGRAPHIC
-    label: str
-        A user defined label to help distinguish between multiple images.
-        Default: ""
-    width: int
-        The width of the output image in pixels. Default: 1024
-    height: int
-        The height of the output image in pixels. Default: 1024
     """
 
     name: str = "default directional camera"
+    """ A user defined name for the camera. """
     direction: CameraDirection = CameraDirection.X_POSITIVE
+    """ The orientation of the camera. Default: X_POSITIVE """
     projection: CameraProjection = CameraProjection.ORTHOGRAPHIC
+    """ The type of projection used for the camera. Default: ORTHOGRAPHIC """
     label: str = ""
+    """A user defined label to help distinguish between multiple images."""
     width: int = 1024
+    """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
@@ -73,39 +71,39 @@ class LookAtCamera:
 
     .. warning:: This feature is experimental and may change or be removed in the future.
 
-    Attributes:
-    -----------
-    look_at: Vector3
-        The point the camera is looking at. Default (0,0,0)
-    position: Vector3
-        The position of the camera. Default (0,1,0)
-    up: Vector3
-        The up vector for the camera. Default (0,0,1)
-    projection : CameraProjection
-        The type of projection used for the camera. Default: ORTHOGRAPHIC
-    label: str
-        A user defined label to help distinguish between multiple images. Default: ""
-    width: int
-        The width of the output image in pixels. Default: 1024
-    height: int
-        The height of the output image in pixels. Default: 1024
     """
 
     look_at: Vector3Like = dc.field(default_factory=lambda: Vector3(x=0, y=0, z=0))
+    """ The point the camera is looking at. Default (0,0,0) """
     position: Vector3Like = dc.field(default_factory=lambda: Vector3(x=0, y=1, z=0))
+    """ The position of the camera. Default (0,1,0) """
     up: Vector3Like = dc.field(default_factory=lambda: Vector3(x=0, y=0, z=1))
+    """ The up vector for the camera. Default (0,0,1) """
     projection: CameraProjection = CameraProjection.ORTHOGRAPHIC
+    """ The type of projection used for the camera. Default: ORTHOGRAPHIC """
     label: str = ""
+    """ A user defined label to help distinguish between multiple images. Default: "" """
     width: int = 1024
+    """ The width of the output image in pixels. Default: 1024 """
     height: int = 1024
+    """ The height of the output image in pixels. Default: 1024 """
+
+
+class _InternalToken:
+    """Marker class to control instantiation access for RenderOutput."""
+
+    pass
 
 
 class RenderOutput:
     """
-    The render output represents the request to render images from a geometry, mesh or
-    solution. The operation exectutes asyncronously, so the caller must check
-    the status of the image extract. If the status is completed, then the
-    resuling image is available for download.
+    The render output represents the request to render images from a geometry,
+    mesh or solution, and is contructed by the Scene class. The operation
+    exectutes asyncronously, so the caller must check the status of the image
+    extract. If the status is completed, then the resuling image is available
+    for download.
+
+    .. warning:: This class should not be directly instantiated by users.
 
     .. warning:: This feature is experimental and may change or be removed in the future.
 
@@ -125,17 +123,27 @@ class RenderOutput:
         Internal flag to track if the extract has been deleted.
     """
 
-    def __init__(
-        self, extract_id: str, project_id: str, name: str, desciption: str, status: RenderStatusType
-    ):
+    def __init__(self, factory_token: _InternalToken):
+        if not isinstance(factory_token, _InternalToken):
+            raise ValueError("This class can only be constructed through the Scene class")
+
         # TODO(matt): We could make all of these read only.
-        self._extract_id: str = extract_id
-        self._project_id: str = project_id
-        self.status: RenderStatusType = status
-        self.name: str = name
-        self.description: str = desciption
+        self._extract_id: str = ""
+        self._project_id: str = ""
+        self.status: RenderStatusType = RenderStatusType.INVALID
+        self.name: str = ""
+        self.description: str = ""
         self._deleted = False
 
+    def _set_data(
+        self, extract_id: str, project_id: str, name: str, desciption: str, status: RenderStatusType
+    ) -> None:
+        self._extract_id = extract_id
+        self._project_id = project_id
+        self.status = status
+        self.name = name
+        self.description = desciption
+
     def __repr__(self) -> str:
         return f"RenderOutput(Id: {self._extract_id} status: {self.status})"
 
@@ -311,13 +319,18 @@ class Scene:
         annotations for all fields used in global and filter display attributes.
         When False, only color maps explicitly added by the user appear in the
         images. Default: True
+    supersampling: int
+        Supersampling controls anti-aliasing in output images. A value of 1 means no supersampling.
+        A value of 2 means we internally render at 2x the image resolution and downsample the image
+        to the requested resolution. Valid values are between 1 and 8. Default: 2
     """
 
     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
         # Global display attrs
         self.global_display_attrs = DisplayAttributes()
         self._filters: List[Filter] = []
@@ -366,7 +379,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:
@@ -374,7 +387,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
 
@@ -536,6 +549,9 @@ class Scene:
                 out_camera.look_at.look_at.CopyFrom(_to_vector3(lookat.look_at)._to_proto())
             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__}")
 
@@ -621,8 +637,9 @@ class Scene:
                 # These are all default contructed, so they all have the same dimentions.
                 # All the coordinates are in normalized device space.
                 assert auto_cmaps[0].appearance != None
-                width = auto_cmaps[0].appearance.width
-                height = auto_cmaps[0].appearance.height
+                appearance = cast(ColorMapAppearance, auto_cmaps[0].appearance)
+                width = appearance.width
+                height = appearance.height
                 x_padding = 0.05
                 y_padding = 0.05
                 # Placing them on the right side.
@@ -630,8 +647,9 @@ class Scene:
                 lower_left_y = 1.0 - height - y_padding
                 for cmap in auto_cmaps:
                     assert cmap.appearance != None
-                    cmap.appearance.lower_left_x = lower_left_x
-                    cmap.appearance.lower_left_y = lower_left_y
+                    cmap_appearance = cast(ColorMapAppearance, cmap.appearance)
+                    cmap_appearance.lower_left_x = lower_left_x
+                    cmap_appearance.lower_left_y = lower_left_y
                     lower_left_y = lower_left_y - height - y_padding
                     if lower_left_y < 0:
                         lower_left_y = 0
@@ -654,6 +672,12 @@ class Scene:
         req.spec.background_properties.color.b = bg_color.z
         req.spec.background_properties.color.a = 1
 
+        if not isinstance(self.supersampling, int):
+            raise TypeError(f"Expected 'int', got {type(self.supersampling).__name__}")
+        if self.supersampling < 1 or self.supersampling > 8:
+            raise ValueError(f"Supersampling value is not in the range [1,8]: {self.supersampling}")
+        req.spec.supersampling_ratio = self.supersampling
+
         req.project_id = self._project_id
         if self._entity_type == EntityType.SIMULATION:
             req.spec.entity_type.simulation.id = self._solution.simulation_id
@@ -682,22 +706,24 @@ class Scene:
         req: vis_pb2.CreateExtractRequest = self._create_request(name=name, description=description)
         res: vis_pb2.CreateExtractResponse = get_default_client().CreateExtract(req)
         logger.info("Successfully submitted 'render_images' request")
-        return RenderOutput(
+        render_output = RenderOutput(_InternalToken())
+        render_output._set_data(
             extract_id=res.extract.extract_id,
             project_id=self._project_id,
             name=name,
             desciption=description,
             status=RenderStatusType(res.extract.status),
         )
+        return render_output
 
-    def interact(self) -> InteractiveScene:
+    def interact(self, scene_mode: SceneMode = SceneMode.SIDE_PANEL) -> InteractiveScene:
         """
         Start an interactive display of the scene, when running inside LuminaryCloud's
         AI Notebook environment or Jupyter Lab. The returned object must be displayed
         in the notebook to display the interactive visualization. This requires that
         the luminarycloud package was installed with the optional jupyter feature.
         """
-        self._interactive_scene = InteractiveScene(self)
+        self._interactive_scene = InteractiveScene(self, mode=scene_mode)
         return self._interactive_scene
 
 
@@ -719,14 +745,15 @@ def get_render(project_id: str, extract_id: str) -> RenderOutput:
     req.extract_id = extract_id
     req.project_id = project_id
     res: vis_pb2.GetExtractResponse = get_default_client().GetExtract(req)
-    output = RenderOutput(
+    render_output = RenderOutput(_InternalToken())
+    render_output._set_data(
         extract_id=extract_id,
         project_id=project_id,
         name=res.extract.name,
         desciption=res.extract.description,
         status=RenderStatusType(res.extract.status),
     )
-    return output
+    return render_output
 
 
 def list_quantities(solution: Solution) -> List[VisQuantity]:
@@ -807,15 +834,14 @@ def list_renders(entity: Geometry | Mesh | Solution) -> List[RenderOutput]:
 
     results: List[RenderOutput] = []
     for extract in res.extracts:
-        result = RenderOutput(
+        result = RenderOutput(_InternalToken())
+        result._set_data(
             extract_id=extract.extract_id,
             project_id=extract.project_id,
             name=extract.name,
             desciption=extract.description,
             status=RenderStatusType(extract.status),
         )
-
-        # TODO(matt): the List extracts request is giving us nil for the status.
         # This need to be fixed on the backend, but manually refreshing works for now.
         result.refresh()
         results.append(result)

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,
@@ -456,6 +460,7 @@ class VolumeSelection:
         self,
         resolution_min: Optional[float] = None,
         resolution_max: Optional[float] = None,
+        tool: Optional[Iterator[VolumeSelection]] = 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.13.1.dist-info → luminarycloud-0.14.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: luminarycloud
-Version: 0.13.1
+Version: 0.14.1
 Summary: Luminary Cloud SDK
 Project-URL: Homepage, https://www.luminarycloud.com/
 Project-URL: Documentation, https://app.luminarycloud.com/docs/api/