Updated documentation

Frederik · Frederik · commit 13ad73247112 · 2025-05-15T16:56:28.000+02:00
diff --git a/docs/source/nxopentse.cad.rst b/docs/source/nxopentse.cad.rst
@@ -12,6 +12,14 @@ nxopentse.cad.code module
    :undoc-members:
    :show-inheritance:
 
+nxopentse.cad.assemblies module
+-------------------------
+
+.. automodule:: nxopentse.cad.assemblies
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Module contents
 ---------------
 
diff --git a/docs/source/nxopentse.tools.rst b/docs/source/nxopentse.tools.rst
@@ -20,6 +20,14 @@ nxopentse.tools.general module
    :undoc-members:
    :show-inheritance:
 
+nxopentse.tools.vector_arithmetic module
+------------------------------
+
+.. automodule:: nxopentse.tools.vector_arithmetic
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Module contents
 ---------------
 
diff --git a/src/nxopentse/cad/assemblies.py b/src/nxopentse/cad/assemblies.py
@@ -162,3 +162,32 @@ def create_component_from_bodies(bodies: List[NXOpen.Body],
 
     return component
 
+
+def add_parts_to_assembly(parts: List[NXOpen.Part], assembly: NXOpen.Part) -> None:
+    """
+    Add a part to an assembly.
+
+    Parameters
+    ----------
+    part : NXOpen.Part
+        The part to add to the assembly.
+    assembly : NXOpen.Part
+        The assembly to add the part to.
+
+    NOTES
+    -----
+    Tested in Simcenter 2406
+    """
+    add_component_builder: NXOpen.Assemblies.AddComponentBuilder = assembly.AssemblyManager.CreateAddComponentBuilder()
+    add_component_builder.SetCount(1)
+    add_component_builder.SetComponentAnchor(NXOpen.Assemblies.ProductInterface.InterfaceObject.Null)
+    add_component_builder.SetInitialLocationType(NXOpen.Assemblies.AddComponentBuilder.LocationType.WorkPartAbsolute)
+    add_component_builder.ReferenceSet = "Use Model"
+    add_component_builder.Layer = -1
+    add_component_builder.SetPartsToAdd(parts)
+    add_component_builder.ComponentName = assembly.Name
+
+    add_component_builder.Commit()
+    add_component_builder.ResetPartsToAdd()
+    add_component_builder.Destroy()
+
diff --git a/src/nxopentse/cad/code.py b/src/nxopentse/cad/code.py
@@ -3,16 +3,126 @@
 from typing import List, Tuple, Optional, cast, Union
 
 import NXOpen
+import NXOpen.UF
 import NXOpen.Features
 import NXOpen.GeometricUtilities
 import NXOpen.Assemblies
 
 from ..tools.vector_arithmetic import dot_product_vector3d
 
 the_session: NXOpen.Session = NXOpen.Session.GetSession()
+the_uf_session: NXOpen.UF.UFSession = NXOpen.UF.UFSession.GetUFSession()
 the_lw: NXOpen.ListingWindow = the_session.ListingWindow
 
 
+class MassProps3d:
+    '''
+    Object to store the mass properties of a body and easily access and compare them.
+    '''
+    def __init__(
+        self,
+        surface_area: float = 0.0,
+        volume: float = 0.0,
+        mass: float = 0.0,
+        center_of_mass: Optional[List[float]] = None,
+        first_moments: Optional[List[float]] = None,
+        moments_of_inertia_wcs: Optional[List[float]] = None,
+        moments_of_inertia_centroidal: Optional[List[float]] = None,
+        spherical_moment_of_inertia: float = 0.0,
+        inertia_products_wcs: Optional[List[float]] = None,
+        inertia_products_centroidal: Optional[List[float]] = None,
+        principal_axes_wcs: Optional[List[float]] = None,
+        principal_moments_centroidal: Optional[List[float]] = None,
+        radii_of_gyration_wcs: Optional[List[float]] = None,
+        radii_of_gyration_centroidal: Optional[List[float]] = None,
+        spherical_radius_of_gyration: float = 0.0,
+        density: float = 0.0,
+    ):
+        self.surface_area = surface_area
+        self.volume = volume
+        self.mass = mass
+        self.center_of_mass = center_of_mass or [0.0, 0.0, 0.0]
+        self.first_moments = first_moments or [0.0, 0.0, 0.0]
+        self.moments_of_inertia_wcs = moments_of_inertia_wcs or [0.0, 0.0, 0.0]
+        self.moments_of_inertia_centroidal = moments_of_inertia_centroidal or [0.0, 0.0, 0.0]
+        self.spherical_moment_of_inertia = spherical_moment_of_inertia
+        self.inertia_products_wcs = inertia_products_wcs or [0.0, 0.0, 0.0]
+        self.inertia_products_centroidal = inertia_products_centroidal or [0.0, 0.0, 0.0]
+        self.principal_axes_wcs = principal_axes_wcs or [0.0, 0.0, 0.0]
+        self.principal_moments_centroidal = principal_moments_centroidal or [0.0, 0.0, 0.0]
+        self.radii_of_gyration_wcs = radii_of_gyration_wcs or [0.0, 0.0, 0.0]
+        self.radii_of_gyration_centroidal = radii_of_gyration_centroidal or [0.0, 0.0, 0.0]
+        self.spherical_radius_of_gyration = spherical_radius_of_gyration
+        self.density = density
+
+
+    def __str__(self) -> str:
+        return (
+            f"MassProps3d(\n"
+            f"  Surface Area={self.surface_area},\n"
+            f"  Volume (0.0 For Thin Shell)={self.volume},\n"
+            f"  Mass={self.mass},\n"
+            f"  Center Of Mass (COFM), WCS={self.center_of_mass},\n"
+            f"  First Moments (centroidal)={self.first_moments},\n"
+            f"  Moments Of Inertia, WCS={self.moments_of_inertia_wcs},\n"
+            f"  Moments Of Inertia (centroidal)={self.moments_of_inertia_centroidal},\n"
+            f"  Spherical Moment Of Inertia={self.spherical_moment_of_inertia},\n"
+            f"  Inertia Products, WCS={self.inertia_products_wcs},\n"
+            f"  Inertia Products (centroidal)={self.inertia_products_centroidal},\n"
+            f"  Principal Axes, WCS={self.principal_axes_wcs},\n"
+            f"  Principal Moments (centroidal)={self.principal_moments_centroidal},\n"
+            f"  Radii Of Gyration, WCS={self.radii_of_gyration_wcs},\n"
+            f"  Radii Of Gyration (centroidal)={self.radii_of_gyration_centroidal},\n"
+            f"  Spherical Radius Of Gyration={self.spherical_radius_of_gyration},\n"
+            f"  Density={self.density}\n"
+            f")"
+        )
+
+
+    def __eq__(self, other) -> bool:
+        if not isinstance(other, MassProps3d):
+            return False
+        return (
+            self.surface_area == other.surface_area
+            and self.volume == other.volume
+            and self.mass == other.mass
+            and self.center_of_mass == other.center_of_mass
+            and self.first_moments == other.first_moments
+            and self.moments_of_inertia_wcs == other.moments_of_inertia_wcs
+            and self.moments_of_inertia_centroidal == other.moments_of_inertia_centroidal
+            and self.spherical_moment_of_inertia == other.spherical_moment_of_inertia
+            and self.inertia_products_wcs == other.inertia_products_wcs
+            and self.inertia_products_centroidal == other.inertia_products_centroidal
+            and self.principal_axes_wcs == other.principal_axes_wcs
+            and self.principal_moments_centroidal == other.principal_moments_centroidal
+            and self.radii_of_gyration_wcs == other.radii_of_gyration_wcs
+            and self.radii_of_gyration_centroidal == other.radii_of_gyration_centroidal
+            and self.spherical_radius_of_gyration == other.spherical_radius_of_gyration
+            and self.density == other.density
+        )
+
+
+    def __hash__(self) -> int:
+        return hash((
+            self.surface_area,
+            self.volume,
+            self.mass,
+            tuple(self.center_of_mass),
+            tuple(self.first_moments),
+            tuple(self.moments_of_inertia_wcs),
+            tuple(self.moments_of_inertia_centroidal),
+            self.spherical_moment_of_inertia,
+            tuple(self.inertia_products_wcs),
+            tuple(self.inertia_products_centroidal),
+            tuple(self.principal_axes_wcs),
+            tuple(self.principal_moments_centroidal),
+            tuple(self.radii_of_gyration_wcs),
+            tuple(self.radii_of_gyration_centroidal),
+            self.spherical_radius_of_gyration,
+            self.density,
+        ))
+
+
 def nx_hello():
     """
     Print a greeting message to the listing window.
@@ -46,6 +156,68 @@ def get_all_bodies_in_part(work_part: NXOpen.Part=None # type: ignore
     return all_bodies
 
 
+def get_body_properties(body: NXOpen.Body) -> MassProps3d:
+    '''
+    Get the properties of a body In METER and KG!!!!
+
+    Parameters
+    ----------
+    body : NXOpen.Body
+        The body to get the properties of.
+
+    Returns
+    -------
+    MassProps3d
+        A MassProps3d object with the properties of the body.
+
+    NOTES
+    -----
+    This is based on the GUI funcionality of getting the properties of a body.
+    Tested in Simcenter 2406
+    '''
+    # should update the code to use workpart.MeasureManager
+    (massProps, Stats) = the_uf_session.Modeling.AskMassProps3d([body.Tag], 1, 1, 4, 0.0, 1, [0.99,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0])
+    # Mass properties
+    # [0] = Surface Area
+    # [1] = Volume (0.0 For Thin Shell)
+    # [2] = Mass
+    # [3-5] = Center Of Mass (COFM), WCS
+    # [6-8] = First Moments (centroidal)
+    # [9-11] = Moments Of Inertia, WCS
+    # [12-14] = Moments Of Inertia (centroidal)
+    # [15] = Spherical Moment Of Inertia
+    # [16-18] = Inertia Products, WCS
+    # [19-21] = Inertia Products (centroidal)
+    # [22-30] = Principal Axes, WCS
+    # [31-33] = Principal Moments (centroidal)
+    # [34-36] = Radii Of Gyration, WCS
+    # [37-39] = Radii Of Gyration (centroidal)
+    # [40] = Spherical Radius Of Gyration
+    # [41-45] = Unused
+    # [46] = Density
+    # the_lw.WriteFullline(f"MassProps: {massProps}")
+
+    properties = MassProps3d(massProps[0],
+                             massProps[1],
+                             massProps[2],
+                             massProps[3:6],
+                             massProps[6:9],
+                             massProps[9:12],
+                             massProps[12:15],
+                             massProps[15],
+                             massProps[16:19],
+                             massProps[19:22],
+                             massProps[22:31],
+                             massProps[31:34],
+                             massProps[34:37],
+                             massProps[37:40],
+                             massProps[40],
+                             massProps[46])
+
+    return properties
+
+
+
 def get_all_vertices_in_body(body: NXOpen.Body) -> List[NXOpen.Point3d]:
     '''
     Get all the unique vertices in a body.
diff --git a/src/nxopentse/tools/general.py b/src/nxopentse/tools/general.py
@@ -303,3 +303,66 @@ def get_expression_by_name(name: str,
     else:
         # something wrong
         raise ValueError(f'Found {len(expression)} with name {name}')
+
+
+def save_view_to_file(file_path: str) -> str:
+    """
+    Saves the current view of the model to a file in TIFF format.
+
+    This function exports the current view of the model to an image file in TIFF format. If the specified file already exists, 
+    it is deleted to ensure that the new image overwrites the previous one. The image export options are set to enhance edges, 
+    make the background transparent, and save in the TIFF file format.
+
+    Parameters
+    ----------
+    file_name : str
+        The full paht of the file to save the image to. File extension will be updated in line with the type.
+    type : NXOpen.Gateway.ImageExportBuilder.FileFormats, optional
+        The file format to save the image as. The default is `.Tiff`.
+
+    Returns
+    -------
+    str
+        The full path of the saved image file. Note that the file extension is not included in the return value.
+
+    Raises
+    ------
+    FileNotFoundError
+        If the file path is invalid or the file cannot be created.
+        
+    IOError
+        If an error occurs during the image export process.
+
+    Notes
+    -----
+    - The function currently only supports saving images in TIFF format.
+    - If the file already exists, it will be deleted and overwritten with the new image.
+    - Tested in SC2312. SC2406
+    - Errors on a second run "Gateway does not Exist on NXOpen" because of NXOpen.Gateway.ImageExportBuilder.FileFormats.Tiff
+      NXOpen.Gateway.ImageExportBuilder.BackgroundOptions.Transparent
+    """
+    if not os.path.isabs(file_path):
+        raise FileNotFoundError(f"Invalid file path: {file_path}")
+    
+    file_path_without_extension = os.path.splitext(file_path)[0]  # NX adds the extension for the specific file format
+    # delete existing file to mimic overwriting
+    if (os.path.exists(file_path)):
+        os.remove(file_path)
+    
+    image_export_builder: NXOpen.Gateway.ImageExportBuilder = the_UI.CreateImageExportBuilder()
+    try:
+        # Options
+        image_export_builder.EnhanceEdges = True
+        image_export_builder.RegionMode = False
+        # image_export_builder.FileFormat = NXOpen.Gateway.ImageExportBuilder.FileFormats.Tiff
+        image_export_builder.FileName = file_path_without_extension # NX adds the extension for the specific file format
+        # image_export_builder.BackgroundOption = NXOpen.Gateway.ImageExportBuilder.BackgroundOptions.Transparent
+        # Commit the builder
+        image_export_builder.Commit()
+    except Exception as e:
+        the_lw.WriteFullline(str(e))
+
+    file_name = image_export_builder.FileName
+    image_export_builder.Destroy()
+    return file_name
+ 
