objects_segmentation#
- Modeler3D.objects_segmentation(objects_list, segmentation_thickness=None, segments_number=None, apply_mesh_sheets=False, mesh_sheets_number=2)[source]#
Get segmentation of an object given the segmentation thickness or number of segments.
- Parameters:
- objects_list
list,str List of objects to apply the segmentation to. It can either be a list of strings (object names), integers (object IDs), or a list of
pyaedt.modeler.cad.object3d.Object3dclasses.- segmentation_thickness
float,optional Segmentation thickness. Model units are automatically assigned. The default is
None.- segments_number
int,optional Number of segments to segment the object to. The default is
None.- apply_mesh_sheetsbool,
optional Whether to apply mesh sheets to selected objects. Mesh sheets are needed in case the user would like to have additional layers inside the objects for a finer mesh and more accurate results. The default is
False.- mesh_sheets_number
int,optional Number of mesh sheets within one magnet segment. If nothing is provided and
apply_mesh_sheets=True, the default value is2.
- objects_list
- Returns:
dictortupleDepending on value
apply_mesh_sheetsit returns either a dictionary or a tuple. If mesh sheets are applied the method returns a tuple where: - First dictionary is the segments that the object has been divided into. - Second dictionary is the mesh sheets eventually needed to apply the mesh. to inside the object. Keys are the object names, and values are respectively segments sheets and mesh sheets of thepyaedt.modeler.cad.object3d.Object3dclass. If mesh sheets are not applied the method returns only the dictionary of segments that the object has been divided into.Falseis returned if the method fails.