Merge branch 'main' into doc/examples

Author: jorgepiloto

pyproject.toml

@@ -47,7 +47,7 @@ doc = [
     "sphinx-design==0.5.0",
     "sphinx-jinja==2.0.2",
     "sphinx-copybutton==0.5.2",
-    "jupyterlab==4.1.0",
+    "jupyterlab==4.1.1",
 ]
 visualization = [
     "numpy==1.26.2",
@@ -87,7 +87,6 @@ ignore = [
     "D210", # No whitespaces allowed surrounding docstring text
     "D212", # Multi-line docstring summary should start at the first line
     "D300", # Use triple double quotes `"""`
-    "D401", # First line of docstring should be in imperative mood
     "D403", # First word of the first line should be properly capitalized
     "D404", # First word of the docstring should not be "This"
     "D417", # Missing argument description in the docstring

src/ansys/stk/core/graphics.py

@@ -1993,7 +1993,7 @@ def count(self) -> int:
             "arg_types" : (agcom.LONG, POINTER(agcom.Variant),),
             "marshallers" : (agmarshall.LongArg, agmarshall.VariantArg,) }
     def item(self, index:int) -> typing.Any:
-        """An item in the collection at the specified index."""
+        """Return an item in the collection at the specified index."""
         return self._intf.invoke(IObjectCollection._metadata, IObjectCollection._item_metadata, index, OutArg())
 
     _get__NewEnum_metadata = { "name" : "_NewEnum",
@@ -2058,7 +2058,7 @@ def count(self) -> int:
             "arg_types" : (agcom.LONG, POINTER(agcom.PVOID),),
             "marshallers" : (agmarshall.LongArg, agmarshall.InterfaceOutArg,) }
     def item(self, index:int) -> "Scene":
-        """A scene in the collection at a specified index."""
+        """Return a scene in the collection at a specified index."""
         return self._intf.invoke(ISceneCollection._metadata, ISceneCollection._item_metadata, index, OutArg())
 
     _get__NewEnum_metadata = { "name" : "_NewEnum",
@@ -3884,7 +3884,7 @@ def is_recording(self) -> bool:
             "arg_types" : (agcom.BSTR, agcom.INT, agcom.INT,),
             "marshallers" : (agmarshall.BStrArg, agmarshall.IntArg, agmarshall.IntArg,) }
     def start_recording(self, wmvFilename:str, videoBitRate:int, videoFrameRate:int) -> None:
-        """This method is deprecated. Use StartRecordingVideo instead. Starts recording a file in the WMV format at the specified bit and frame rate."""
+        """Do not use this method, as it is deprecated. Use StartRecordingVideo instead. Starts recording a file in the WMV format at the specified bit and frame rate."""
         return self._intf.invoke(ICameraVideoRecording._metadata, ICameraVideoRecording._start_recording_metadata, wmvFilename, videoBitRate, videoFrameRate)
 
     _start_recording_frame_stack_metadata = { "name" : "start_recording_frame_stack",
@@ -4040,14 +4040,14 @@ def projection(self) -> "MAP_PROJECTION":
             "arg_types" : (agcom.PVOID,),
             "marshallers" : (agmarshall.InterfaceInArg("IScene"),) }
     def start_up(self, scene:"IScene") -> None:
-        """Called automatically when imagery is being added to the globe."""
+        """Initiate start-up when imagery is being added to the globe."""
         return self._intf.invoke(ICustomImageGlobeOverlay._metadata, ICustomImageGlobeOverlay._start_up_metadata, scene)
 
     _shut_down_metadata = { "name" : "shut_down",
             "arg_types" : (agcom.PVOID,),
             "marshallers" : (agmarshall.InterfaceInArg("IScene"),) }
     def shut_down(self, scene:"IScene") -> None:
-        """Called automatically when imagery is being removed from the globe."""
+        """Initiate shutdown when imagery is being removed from the globe."""
         return self._intf.invoke(ICustomImageGlobeOverlay._metadata, ICustomImageGlobeOverlay._shut_down_metadata, scene)
 
     _clear_cache_metadata = { "name" : "clear_cache",
@@ -7247,7 +7247,7 @@ def maximum_number_of_frames(self, maximumNumberOfFrames:int) -> None:
             "arg_types" : (),
             "marshallers" : () }
     def reset(self) -> None:
-        """This resets the frame rate counter back to zero. The frame rate computation begins anew."""
+        """Reset the frame rate counter back to zero. The frame rate computation begins anew."""
         return self._intf.invoke(IFrameRate._metadata, IFrameRate._reset_metadata, )
 
 
@@ -9840,7 +9840,7 @@ def refresh(self) -> None:
 agcls.AgTypeNameMap["IKmlNetworkLink"] = IKmlNetworkLink
 
 class IMarkerBatchPrimitive(object):
-    """ Renders one or more markers in the 3D scene. Markers are 2D images that always face the viewer which can be sized in pixels or meters. Markers are also referred to as sprites or billboards..."""
+    """Render one or more markers in the 3D scene. Markers are 2D images that always face the viewer which can be sized in pixels or meters. Markers are also referred to as sprites or billboards..."""
 
     _num_methods = 54
     _vtable_offset = IUnknown._vtable_offset + IUnknown._num_methods
@@ -11967,7 +11967,7 @@ def maximum_pixel_size(self, maximumPixelSize:int) -> None:
 agcls.AgTypeNameMap["IPixelSizeDisplayCondition"] = IPixelSizeDisplayCondition
 
 class IPointBatchPrimitive(object):
-    """ Renders one or more points in the 3D scene. Each point in the batch has a unique position and an optional color. All points in the batch share the same pixel size. For best performance, avoid creating lots of batches with only a few points each..."""
+    """Render one or more points in the 3D scene. Each point in the batch has a unique position and an optional color. All points in the batch share the same pixel size. For best performance, avoid creating lots of batches with only a few points each..."""
 
     _num_methods = 34
     _vtable_offset = IUnknown._vtable_offset + IUnknown._num_methods
@@ -12972,7 +12972,7 @@ def count(self) -> int:
             "marshallers" : (agmarshall.IntArg,) }
     @property
     def precision_exponent(self) -> int:
-        """This property is deprecated. This property is no longer in use Gets or sets the exponent used to compute the maximum precision for primitive rendering. For example, a value of -3 indicates the maximum precision of 2^-3, 0.125 m along the x, y, or z axis..."""
+        """Do not use this property, as it is deprecated. This property is no longer in use Gets or sets the exponent used to compute the maximum precision for primitive rendering. For example, a value of -3 indicates the maximum precision of 2^-3, 0.125 m along the x, y, or z axis..."""
         return self._intf.get_property(IPrimitiveManager._metadata, IPrimitiveManager._get_precision_exponent_metadata)
 
     _set_precision_exponent_metadata = { "name" : "precision_exponent",
@@ -14600,7 +14600,7 @@ def supported(self) -> bool:
 agcls.AgTypeNameMap["ITerrainOverlay"] = ITerrainOverlay
 
 class ITextBatchPrimitive(object):
-    """ Renders one or more strings in the 3D scene.  For best performance, avoid creating lots of batches with only a few strings each. See the Batching Performance Overview."""
+    """Render one or more strings in the 3D scene.  For best performance, avoid creating lots of batches with only a few strings each. See the Batching Performance Overview."""
 
     _num_methods = 32
     _vtable_offset = IUnknown._vtable_offset + IUnknown._num_methods
@@ -18271,7 +18271,7 @@ def initialize_audio_video_with_string_uri(self, uri:str, audioUri:str) -> "Vide
 agcls.AgTypeNameMap["IVideoStreamFactory"] = IVideoStreamFactory
 
 class IMarkerBatchPrimitiveFactory(object):
-    """ Renders one or more markers in the 3D scene. Markers are 2D images that always face the viewer which can be sized in pixels or meters. Markers are also referred to as sprites or billboards..."""
+    """Render one or more markers in the 3D scene. Markers are 2D images that always face the viewer which can be sized in pixels or meters. Markers are also referred to as sprites or billboards..."""
 
     _num_methods = 7
     _vtable_offset = IUnknown._vtable_offset + IUnknown._num_methods
@@ -18575,7 +18575,7 @@ def initialize_with_pixel_sizes(self, minimumPixelSize:int, maximumPixelSize:int
 agcls.AgTypeNameMap["IPixelSizeDisplayConditionFactory"] = IPixelSizeDisplayConditionFactory
 
 class IPointBatchPrimitiveFactory(object):
-    """ Renders one or more points in the 3D scene. Each point in the batch has a unique position and an optional color. All points in the batch share the same pixel size. For best performance, avoid creating lots of batches with only a few points each..."""
+    """Render one or more points in the 3D scene. Each point in the batch has a unique position and an optional color. All points in the batch share the same pixel size. For best performance, avoid creating lots of batches with only a few points each..."""
 
     _num_methods = 4
     _vtable_offset = IUnknown._vtable_offset + IUnknown._num_methods
@@ -19208,7 +19208,7 @@ def supported(self) -> bool:
 agcls.AgTypeNameMap["ITerrainOverlayInitializer"] = ITerrainOverlayInitializer
 
 class ITextBatchPrimitiveFactory(object):
-    """ Renders one or more strings in the 3D scene.  For best performance, avoid creating lots of batches with only a few strings each. See the Batching Performance Overview."""
+    """Render one or more strings in the 3D scene.  For best performance, avoid creating lots of batches with only a few strings each. See the Batching Performance Overview."""
 
     _num_methods = 3
     _vtable_offset = IUnknown._vtable_offset + IUnknown._num_methods
@@ -21457,7 +21457,7 @@ def __setattr__(self, attrname, value):
 agcls.AgTypeNameMap["KmlNetworkLink"] = KmlNetworkLink
 
 class MarkerBatchPrimitive(IMarkerBatchPrimitive, IPrimitive):
-    """ Renders one or more markers in the 3D scene. Markers are 2D images that always face the viewer which can be sized in pixels or meters. Markers are also referred to as sprites or billboards..."""
+    """Render one or more markers in the 3D scene. Markers are 2D images that always face the viewer which can be sized in pixels or meters. Markers are also referred to as sprites or billboards..."""
 
     def __init__(self, sourceObject=None):
         IMarkerBatchPrimitive.__init__(self, sourceObject)
@@ -21656,7 +21656,7 @@ def __setattr__(self, attrname, value):
 agcls.AgTypeNameMap["PixelSizeDisplayCondition"] = PixelSizeDisplayCondition
 
 class PointBatchPrimitive(IPointBatchPrimitive, IPrimitive):
-    """ Renders one or more points in the 3D scene. Each point in the batch has a unique position and an optional color. All points in the batch share the same pixel size. For best performance, avoid creating lots of batches with only a few points each..."""
+    """Render one or more points in the 3D scene. Each point in the batch has a unique position and an optional color. All points in the batch share the same pixel size. For best performance, avoid creating lots of batches with only a few points each..."""
 
     def __init__(self, sourceObject=None):
         IPointBatchPrimitive.__init__(self, sourceObject)
@@ -22041,7 +22041,7 @@ def __setattr__(self, attrname, value):
 agcls.AgTypeNameMap["TerrainOverlay"] = TerrainOverlay
 
 class TextBatchPrimitive(ITextBatchPrimitive, IPrimitive):
-    """ Renders one or more strings in the 3D scene.  For best performance, avoid creating lots of batches with only a few strings each. See the Batching Performance Overview."""
+    """Render one or more strings in the 3D scene.  For best performance, avoid creating lots of batches with only a few strings each. See the Batching Performance Overview."""
 
     def __init__(self, sourceObject=None):
         ITextBatchPrimitive.__init__(self, sourceObject)
@@ -23115,7 +23115,7 @@ def __setattr__(self, attrname, value):
 agcls.AgTypeNameMap["VideoStreamFactory"] = VideoStreamFactory
 
 class MarkerBatchPrimitiveFactory(IMarkerBatchPrimitiveFactory):
-    """ Renders one or more markers in the 3D scene. Markers are 2D images that always face the viewer which can be sized in pixels or meters. Markers are also referred to as sprites or billboards..."""
+    """Render one or more markers in the 3D scene. Markers are 2D images that always face the viewer which can be sized in pixels or meters. Markers are also referred to as sprites or billboards..."""
 
     def __init__(self, sourceObject=None):
         IMarkerBatchPrimitiveFactory.__init__(self, sourceObject)
@@ -23217,7 +23217,7 @@ def __setattr__(self, attrname, value):
 agcls.AgTypeNameMap["PixelSizeDisplayConditionFactory"] = PixelSizeDisplayConditionFactory
 
 class PointBatchPrimitiveFactory(IPointBatchPrimitiveFactory):
-    """ Renders one or more points in the 3D scene. Each point in the batch has a unique position and an optional color. All points in the batch share the same pixel size. For best performance, avoid creating lots of batches with only a few points each..."""
+    """Render one or more points in the 3D scene. Each point in the batch has a unique position and an optional color. All points in the batch share the same pixel size. For best performance, avoid creating lots of batches with only a few points each..."""
 
     def __init__(self, sourceObject=None):
         IPointBatchPrimitiveFactory.__init__(self, sourceObject)
@@ -23421,7 +23421,7 @@ def __setattr__(self, attrname, value):
 agcls.AgTypeNameMap["TerrainOverlayInitializer"] = TerrainOverlayInitializer
 
 class TextBatchPrimitiveFactory(ITextBatchPrimitiveFactory):
-    """ Renders one or more strings in the 3D scene.  For best performance, avoid creating lots of batches with only a few strings each. See the Batching Performance Overview."""
+    """Render one or more strings in the 3D scene.  For best performance, avoid creating lots of batches with only a few strings each. See the Batching Performance Overview."""
 
     def __init__(self, sourceObject=None):
         ITextBatchPrimitiveFactory.__init__(self, sourceObject)

src/ansys/stk/core/internal/apiutil.py

@@ -14,7 +14,7 @@ def __eq__(self, other):
         return False
 
     def __hash__(self):
-        """Used primarily for reference count management."""
+        """Manage reference count."""
         return 0
 
     def __bool__(self):

src/ansys/stk/core/internal/coclassutil.py

@@ -217,7 +217,7 @@ def get_concrete_class(punk:IUnknown) -> typing.Any:
     return coclass
 
 def compare_com_objects(first, second) -> bool:
-    """Used to compare whether the given interfaces point to the same COM object."""
+    """Compare whether the given interfaces point to the same COM object."""
     if first is None and second is None:
         return True
     elif first is None or second is None:

src/ansys/stk/core/internal/comutil.py

@@ -423,7 +423,7 @@ def _add_ref_impl(pUnk:"IUnknown"):
 
     def create_ownership(self, pUnk:"IUnknown"):
         """
-        Adds pUnk to the reference manager and calls AddRef in STK.
+        Add pUnk to the reference manager and call AddRef in STK.
 
         Use if pUnk has a ref-count of 0.
         """
@@ -434,7 +434,7 @@ def create_ownership(self, pUnk:"IUnknown"):
 
     def take_ownership(self, pUnk:"IUnknown", isApplication=False):
         """
-        Adds pUnk to the reference manager; does not call AddRef in STK.
+        Add pUnk to the reference manager; does not call AddRef in STK.
 
         Use if pUnk has a ref-count of 1.
         """
@@ -509,7 +509,7 @@ def uninitialize(self):
 CoInitializeManager = _CreateCoInitializeManager()
 
 def _initialize_embedded():
-    """Called by STK during plugin initialization."""
+    """Initialize OLE libraries for STK plugin initialization."""
     OLE32Lib._initialize()
     OLEAut32Lib._initialize()
 

src/ansys/stk/core/internal/stkxrfb.py

@@ -45,7 +45,7 @@ def __setattr__(self, attrname, value):
             "arg_types" : (),
             "marshallers" : () }
     def refresh(self) -> None:
-        """A new frame is ready to be displayed."""
+        """Request a new frame to be displayed."""
         return self._intf.invoke(IRemoteFrameBufferHost._metadata, IRemoteFrameBufferHost._refresh_metadata, )
 
 
@@ -92,7 +92,7 @@ def __setattr__(self, attrname, value):
             "arg_types" : (agcom.PVOID,),
             "marshallers" : (agmarshall.PVoidArg,) }
     def snap_to_rbg_raster(self, rbgRasterPtr:agcom.PVOID) -> None:
-        """Captures the current scene to a raster."""
+        """Capture the current scene to a raster."""
         return self._intf.invoke(IRemoteFrameBuffer._metadata, IRemoteFrameBuffer._snap_to_rbg_raster_metadata, rbgRasterPtr)
 
     _set_to_off_screen_rendering_metadata = { "name" : "set_to_off_screen_rendering",
@@ -155,14 +155,14 @@ def notify_m_button_down(self, x:int, y:int, keyState:int) -> None:
             "arg_types" : (agcom.INT, agcom.INT, agcom.INT, agcom.INT,),
             "marshallers" : (agmarshall.IntArg, agmarshall.IntArg, agmarshall.IntArg, agmarshall.IntArg,) }
     def notify_mouse_move(self, x:int, y:int, buttons:int, keyState:int) -> None:
-        """Called by the client on a mouse move event."""
+        """Notifies that a mouse move event occurred."""
         return self._intf.invoke(IRemoteFrameBuffer._metadata, IRemoteFrameBuffer._notify_mouse_move_metadata, x, y, buttons, keyState)
 
     _notify_mouse_wheel_metadata = { "name" : "notify_mouse_wheel",
             "arg_types" : (agcom.INT, agcom.INT, agcom.INT, agcom.INT,),
             "marshallers" : (agmarshall.IntArg, agmarshall.IntArg, agmarshall.IntArg, agmarshall.IntArg,) }
     def notify_mouse_wheel(self, x:int, y:int, steps:int, keyState:int) -> None:
-        """Called by the client on a mouse wheel event."""
+        """Notifies that a mouse wheel event occurred."""
         return self._intf.invoke(IRemoteFrameBuffer._metadata, IRemoteFrameBuffer._notify_mouse_wheel_metadata, x, y, steps, keyState)
 
     _set_host_metadata = { "name" : "set_host",