`Design`#

class ansys.geometry.core.designer.design.Design(name: str, modeler: ansys.geometry.core.modeler.Modeler, read_existing_design: bool = False)#

Bases: ansys.geometry.core.designer.component.Component

Provides for organizing geometry assemblies.

This class synchronizes to a supporting Geometry service instance.

Parameters:

namestr: User-defined label for the design.
grpc_clientGrpcClient: Active supporting Geometry service instance for design modeling.
read_existing_designbool, default: False: Whether an existing design on the service should be read. This parameter is only valid when connecting to an existing service session. Otherwise, avoid using this optional parameter.

Warning

To ensure design objects are up to date, it is recommended to access design information (e.g. bodies, components, etc.) via the design instance properties and methods, rather than storing this information separately. For example, to get the bodies in a design, it is recommended to use design.bodies rather than storing the bodies in a separate variable (e.g. bodies = design.bodies) and using that variable for future reference. This is because the design may be updated after the initial retrieval of the bodies, which would make the separate variable out of date.

Overview#

Methods

`set_length_scale`	Set the length scale. This can only be done if the design is empty.
`close`	Close the design.
`add_material`	Add a material to the design.
`remove_material`	Remove a material from the design.
`download`	Export and download the design from the server.
`export_to_scdocx`	Export the design to an scdocx file.
`export_to_disco`	Export the design to a DISCO file.
`export_to_stride`	Export the design to a stride file.
`export_to_parasolid_text`	Export the design to a Parasolid text file.
`export_to_parasolid_bin`	Export the design to a Parasolid binary file.
`export_to_fmd`	Export the design to an FMD file.
`export_to_step`	Export the design to a STEP file.
`export_to_iges`	Export the design to an IGES file.
`export_to_pmdb`	Export the design to a PMDB file.
`export_to_usd`	Export the design tessellation to a USD file.
`export_to_html`	Export the design directly to a self-contained HTML viewer.
`create_named_selection`	Create a named selection on the active Geometry server instance.
`delete_named_selection`	Delete a named selection on the active Geometry server instance.
`delete_component`	Delete a component (itself or its children).
`set_shared_topology`	Set the shared topology to apply to the component.
`add_beam_circular_profile`	Add a new beam circular profile under the design for creating beams.
`get_all_parameters`	Get parameters for the design.
`set_parameter`	Set or update a parameter of the design.
`add_midsurface_thickness`	Add a mid-surface thickness to a list of bodies.
`add_midsurface_offset`	Add a mid-surface offset type to a list of bodies.
`delete_beam_profile`	Remove a beam profile on the active geometry server instance.
`insert_file`	Insert a file into the design.
`get_raw_tessellation`	Tessellate the entire design and return the geometry as triangles.

Properties

`design_id`	The design’s object unique id.
`materials`	List of materials available for the design.
`named_selections`	List of named selections available for the design.
`beam_profiles`	List of beam profile available for the design.
`parameters`	List of parameters available for the design.
`is_active`	Whether the design is currently active.
`is_closed`	Whether the design is closed (i.e. not active).
`length_scale`	Length scale of the design.

Special methods

__repr__

Represent the Design as a string.

Import detail#

from ansys.geometry.core.designer.design import Design

Property detail#

property Design.design_id: str#: The design’s object unique id.

property Design.materials: list[ansys.geometry.core.materials.material.Material]#: List of materials available for the design.

property Design.named_selections: list[ansys.geometry.core.designer.selection.NamedSelection]#: List of named selections available for the design.

property Design.beam_profiles: list[ansys.geometry.core.designer.beam.BeamProfile]#: List of beam profile available for the design.

property Design.parameters: list[ansys.geometry.core.parameters.parameter.Parameter]#: List of parameters available for the design.

property Design.is_active: bool#: Whether the design is currently active.

property Design.is_closed: bool#: Whether the design is closed (i.e. not active).

property Design.length_scale: LengthScale#: Length scale of the design.

Method detail#

Design.set_length_scale(length_scale: LengthScale) → bool#

Set the length scale. This can only be done if the design is empty.

Parameters:

length_scaleLengthScale: The length scale to set for the design.

Returns:

bool: True if the length scale was successfully set, False otherwise.

Notes

This method is only available starting on Ansys release 27R1.

Design.close() → None#: Close the design.

Design.add_material(material: ansys.geometry.core.materials.material.Material) → None#

Add a material to the design.

Parameters:

materialMaterial: Material to add.

Design.remove_material(material: ansys.geometry.core.materials.material.Material | list[ansys.geometry.core.materials.material.Material]) → None#

Remove a material from the design.

Parameters:

materialMaterial | list[Material]: Material or list of materials to remove.

Design.download(file_location: pathlib.Path | str, format: DesignFileFormat = DesignFileFormat.SCDOCX, write_body_facets: bool = False, fmd_options: ansys.geometry.core.misc.options.FMDExportOptions | None = None, pmdb_options: ansys.geometry.core.misc.options.PMDBExportOptions | None = None) → None#

Export and download the design from the server.

Parameters:

file_locationPath | str: Location on disk to save the file to.
formatDesignFileFormat, default: DesignFileFormat.SCDOCX: Format for the file to save to.
write_body_facetsbool, default: False: Option to write body facets into the saved file. SCDOCX and DISCO only, 26R1 and later.
fmd_optionsFMDExportOptions | None, default: None: Options for FMD export. Only applicable when format is FMD.
pmdb_optionsPMDBExportOptions | None, default: None: Options for PMDB export. Only applicable when format is PMDB.

Warning

FMD and PMDB export options are only available in Ansys 27.1 and later products. If options are provided but the backend version does not support them, the options will be ignored.

Design.export_to_scdocx(location: pathlib.Path | str | None = None, write_body_facets: bool = False) → pathlib.Path#

Export the design to an scdocx file.

Parameters:

locationPath | str, optional: Location on disk to save the file to. If None, the file will be saved in the current working directory.
write_body_facetsbool, default: False: Option to write body facets into the saved file. SCDOCX and DISCO only, 26R1 and later.

Returns:

Path: The path to the saved file.

Design.export_to_disco(location: pathlib.Path | str | None = None, write_body_facets: bool = False) → pathlib.Path#

Export the design to a DISCO file.

Parameters:

locationPath | str, optional: Location on disk to save the file to. If None, the file will be saved in the current working directory.
write_body_facetsbool, default: False: Option to write body facets into the saved file. SCDOCX and DISCO only, 26R1 and later.

Returns:

Path: The path to the saved file.

Design.export_to_stride(location: pathlib.Path | str | None = None) → pathlib.Path#

Export the design to a stride file.

Parameters:

locationPath | str, optional: Location on disk to save the file to. If None, the file will be saved in the current working directory.

Returns:

Path: The path to the saved file.

Design.export_to_parasolid_text(location: pathlib.Path | str | None = None) → pathlib.Path#

Export the design to a Parasolid text file.

Parameters:

locationPath | str, optional: Location on disk to save the file to. If None, the file will be saved in the current working directory.

Returns:

Path: The path to the saved file.

Design.export_to_parasolid_bin(location: pathlib.Path | str | None = None) → pathlib.Path#

Export the design to a Parasolid binary file.

Parameters:

locationPath | str, optional: Location on disk to save the file to. If None, the file will be saved in the current working directory.

Returns:

Path: The path to the saved file.

Design.export_to_fmd(location: pathlib.Path | str | None = None, options: ansys.geometry.core.misc.options.FMDExportOptions | None = None) → pathlib.Path#

Export the design to an FMD file.

Parameters:

locationPath | str, optional: Location on disk to save the file to. If None, the file will be saved in the current working directory.
optionsFMDExportOptions, optional: Options for FMD export. If None, default options will be used.

Returns:

Path: The path to the saved file.

Warning

FMD export options are only available in Ansys 27.1 and later products. If options are provided but the backend version does not support them, a warning will be issued and the options will be ignored.

Design.export_to_step(location: pathlib.Path | str | None = None) → pathlib.Path#

Export the design to a STEP file.

Parameters:

locationPath | str, optional: Location on disk to save the file to. If None, the file will be saved in the current working directory.

Returns:

Path: The path to the saved file.

Design.export_to_iges(location: pathlib.Path | str = None) → pathlib.Path#

Export the design to an IGES file.

Parameters:

locationPath | str, optional: Location on disk to save the file to. If None, the file will be saved in the current working directory.

Returns:

Path: The path to the saved file.

Design.export_to_pmdb(location: pathlib.Path | str | None = None, options: ansys.geometry.core.misc.options.PMDBExportOptions | None = None) → pathlib.Path#

Export the design to a PMDB file.

Parameters:

locationPath | str, optional: Location on disk to save the file to. If None, the file will be saved in the current working directory.

Returns:

Path: The path to the saved file.

Design.export_to_usd(location: pathlib.Path | str | None = None, tess_options: ansys.geometry.core.misc.options.TessellationOptions | None = None, file_format: str = 'usda') → pathlib.Path#

Export the design tessellation to a USD file.

Tessellates all bodies in the design and writes them to a Universal Scene Description (USD) file. The export preserves the full component/body hierarchy, mesh geometry, and per-body color as a UsdPreviewSurface material.

Parameters:

locationPath | str | None, default: None

Output directory. If None, the file is saved in the current working directory using the design name as the filename.

tess_optionsTessellationOptions | None, default: None

Tessellation quality options. If None, the server default is used.

file_formatstr, default: "usda"

USD file format. One of:

"usda" — USD ASCII (human-readable)
"usdc" — USD binary crate (compact)
"usdz" — USD zip archive (self-contained)
"usd" — auto-detect (usd-core chooses binary or ASCII)

Returns:

Path: Path to the saved USD file.

Raises:

ImportError: If usd-core is not installed. Install with: pip install ansys-geometry-core[usd].
GeometryRuntimeError: If file_format is not one of the valid values.

Examples

Export to binary USD in a specific directory:

>>> path = design.export_to_usd("output/", file_format="usdc")

Design.export_to_html(location: pathlib.Path | str | None = None, tess_options: ansys.geometry.core.misc.options.TessellationOptions | None = None, show_mesh_lines: bool = True, line_color: str = '#ffffff', line_opacity: float = 0.9) → pathlib.Path#

Export the design directly to a self-contained HTML viewer.

Tessellates all bodies in the design, builds an in-memory USD stage, and converts it to a Three.js HTML viewer in a single step — no intermediate USD file is written to disk.

Parameters:

locationPath | str | None, default: None: Output directory. If None, the file is saved in the current working directory using the design name as the filename.
tess_optionsTessellationOptions | None, default: None: Tessellation quality options. If None, the server default is used.
show_mesh_linesbool, default: True: When True, injects a wireframe overlay over each mesh in the viewer.
line_colorstr, default: "#ffffff": CSS hex color for the mesh-edge overlay.
line_opacityfloat, default: 0.9: Opacity of the mesh-edge overlay (0.0–1.0).

Returns:

Path: Path to the saved HTML file.

Raises:

ImportError: If usd-core or ansys-tools-visualization-interface[usd] is not installed. Install both with: pip install ansys-geometry-core[usd].

Examples

Export to a specific directory without the wireframe overlay:

>>> html_path = design.export_to_html("output/", show_mesh_lines=False)

Create a named selection on the active Geometry server instance.

Parameters:

namestr: User-defined name for the named selection.
bodieslist[Body], default: None: All bodies to include in the named selection.
faceslist[Face], default: None: All faces to include in the named selection.
edgeslist[Edge], default: None: All edges to include in the named selection.
beamslist[Beam], default: None: All beams to include in the named selection.
design_pointslist[DesignPoint], default: None: All design points to include in the named selection.
componentslist[Component], default: None: All components to include in the named selection.
verticeslist[Vertex], default: None: All vertices to include in the named selection.
design_curveslist[DesignCurve], default: None: All design curves to include in the named selection.
datum_planeslist[DatumPlane], default: None: All datum planes to include in the named selection.
coordinate_systemslist[CoordinateSystem], default: None: All coordinate systems to include in the named selection.
datum_pointslist[DatumPoint], default: None: All datum points to include in the named selection.

Returns:

NamedSelection: Newly created named selection that maintains references to all target entities.

Raises:

ValueError: If no entities are provided for the named selection. At least one of the optional parameters must be provided.

Design.delete_named_selection(named_selection: ansys.geometry.core.designer.selection.NamedSelection | str) → None#

Delete a named selection on the active Geometry server instance.

Parameters:

named_selectionNamedSelection | str: Name of the named selection or instance.

Design.delete_component(component: ansys.geometry.core.designer.component.Component | str) → None#

Delete a component (itself or its children).

Parameters:

idUnion[Component, str]: Name of the component or instance to delete.

Raises:

ValueError: The design itself cannot be deleted.

Notes

If the component is not this component (or its children), it is not deleted.

Design.set_shared_topology(share_type: ansys.geometry.core.designer.component.SharedTopologyType) → None#

Set the shared topology to apply to the component.

Parameters:

share_typeSharedTopologyType: Shared topology type to assign.

Raises:

ValueError: Shared topology does not apply to a design.

Add a new beam circular profile under the design for creating beams.

Parameters:

namestr: User-defined label for the new beam circular profile.
radiusQuantity | Distance: Radius of the beam circular profile.
centerndarray | RealSequence | Point3D: Center of the beam circular profile.
direction_xndarray | RealSequence | UnitVector3D | Vector3D: X-plane direction.
direction_yndarray | RealSequence | UnitVector3D | Vector3D: Y-plane direction.

Design.get_all_parameters() → list[ansys.geometry.core.parameters.parameter.Parameter]#

Get parameters for the design.

Returns:

list[Parameter]: List of parameters for the design.

Warning

This method is only available starting on Ansys release 25R1.

Design.set_parameter(dimension: ansys.geometry.core.parameters.parameter.Parameter) → ansys.geometry.core.parameters.parameter.ParameterUpdateStatus#

Set or update a parameter of the design.

Parameters:

dimensionParameter: Parameter to set.

Returns:

ParameterUpdateStatus: Status of the update operation.

Warning

This method is only available starting on Ansys release 25R1.

Design.add_midsurface_thickness(thickness: ansys.geometry.core.misc.measurements.Distance | pint.Quantity | ansys.geometry.core.typing.Real, bodies: list[ansys.geometry.core.designer.body.Body]) → None#

Add a mid-surface thickness to a list of bodies.

Parameters:

thicknessQuantity: Thickness to be assigned.
bodieslist[Body]: All bodies to include in the mid-surface thickness assignment.

Notes

Only surface bodies will be eligible for mid-surface thickness assignment.

Design.add_midsurface_offset(offset_type: ansys.geometry.core.designer.body.MidSurfaceOffsetType, bodies: list[ansys.geometry.core.designer.body.Body]) → None#

Add a mid-surface offset type to a list of bodies.

Parameters:

offset_typeMidSurfaceOffsetType: Surface offset to be assigned.
bodieslist[Body]: All bodies to include in the mid-surface offset assignment.

Notes

Only surface bodies will be eligible for mid-surface offset assignment.

Design.delete_beam_profile(beam_profile: ansys.geometry.core.designer.beam.BeamProfile | str) → None#

Remove a beam profile on the active geometry server instance.

Parameters:

beam_profileBeamProfile | str: A beam profile name or instance that should be deleted.

Design.insert_file(file_location: pathlib.Path | str, import_options: ansys.geometry.core.misc.options.ImportOptions = ImportOptions(), import_options_definitions: ansys.geometry.core.misc.options.ImportOptionsDefinitions = ImportOptionsDefinitions()) → ansys.geometry.core.designer.component.Component#

Insert a file into the design.

Parameters:

file_locationPath | str: Location on disk where the file is located.
import_optionsImportOptions, optional: The options to pass into upload file. If none are provided, default options are used.
import_options_definitionsImportOptionsDefinitions, optional: Additional options to pass into insert file. If none are provided, default options are used.

Returns:

Component: The newly inserted component.

Warning

This method is only available starting on Ansys release 24R2.

Design.get_raw_tessellation(tess_options: ansys.geometry.core.misc.options.TessellationOptions | None = None, reset_cache: bool = False, include_faces: bool = True, include_edges: bool = False) → dict#

Tessellate the entire design and return the geometry as triangles.

Parameters:

tess_optionsTessellationOptions, optional: Options for the tessellation. If None, default options are used.
reset_cachebool, default: False: Whether to reset the cache before performing the tessellation.
include_facesbool, default: True: Whether to include faces in the tessellation.
include_edgesbool, default: False: Whether to include edges in the tessellation.

Returns:

dict: A dictionary with body IDs as keys and another dictionary as values. The inner dictionary has face and edge IDs as keys and the corresponding face/vertice arrays as values.

Design.__repr__() → str#: Represent the Design as a string.

Design#

Overview#

Import detail#

Property detail#

Method detail#

`Design`#