`MasterBody`#

class ansys.geometry.core.designer.body.MasterBody(id: str, name: str, grpc_client: ansys.geometry.core.connection.client.GrpcClient, is_surface: bool = False)#

Bases: IBody

Represents solids and surfaces organized within the design assembly.

Solids and surfaces synchronize to a design within a supporting Geometry service instance.

Parameters:

idstr: Server-defined ID for the body.
namestr: User-defined label for the body.
parent_componentComponent: Parent component to place the new component under within the design assembly.
grpc_clientGrpcClient: Active supporting geometry service instance for design modeling.
is_surfacebool, default: False: Whether the master body is a surface or an 3D object (with volume). The default is False, in which case the master body is a surface. When True, the master body is a 3D object (with volume).

Overview#

Abstract methods

`imprint_curves`	Imprint all specified geometries onto specified faces of the body.
`project_curves`	Project all specified geometries onto the body.
`imprint_projected_curves`	Project and imprint specified geometries onto the body.
`copy`	Create a copy of the body under the specified parent.
`plot`	Plot the body.
`intersect`	Intersect two (or more) bodies.
`subtract`	Subtract two (or more) bodies.
`unite`	Unite two (or more) bodies.

Methods

`reset_tessellation_cache`	Decorate `MasterBody` methods that need tessellation cache update.
`assign_material`	Assign a material against the active design.
`get_assigned_material`	Get the assigned material of the body.
`remove_assigned_material`	Remove the material assigned to the body.
`add_midsurface_thickness`	Add a mid-surface thickness to a surface body.
`add_midsurface_offset`	Add a mid-surface offset to a surface body.
`translate`	Translate the body in a specified direction and distance.
`set_name`	Set the name of the body.
`set_fill_style`	Set the fill style of the body.
`set_suppressed`	Set the body suppression state.
`set_color`	Set the color of the body.
`set_opacity`	Set the opacity of the body.
`rotate`	Rotate the geometry body around the specified axis by a given angle.
`scale`	Scale the geometry body by the given value.
`map`	Map the geometry body to the new specified frame.
`mirror`	Mirror the geometry body across the specified plane.
`get_collision`	Get the collision state between bodies.
`get_raw_tessellation`	Tessellate the body and return the raw tessellation data.
`tessellate`	Tessellate the body and return the geometry as triangles.
`shell_body`	Shell the body to the thickness specified.
`remove_faces`	Shell by removing a given set of faces.
`combine_merge`	Combine this body with another body or bodies, merging them into a single body.

Properties

`id`	Get the ID of the body as a string.
`name`	Get the name of the body.
`fill_style`	Get the fill style of the body.
`is_suppressed`	Get the body suppression state.
`color`	Get the current color of the body.
`opacity`	Get the float value of the opacity for the body.
`is_surface`	Check if the body is a planar body.
`surface_thickness`	Get the surface thickness of a surface body.
`surface_offset`	Get the surface offset type of a surface body.
`faces`	Get a list of all faces within the body.
`edges`	Get a list of all edges within the body.
`vertices`	Get a list of all vertices within the body.
`is_alive`	Check if the body is still alive and has not been deleted.
`volume`	Calculate the volume of the body.
`material`	Get the assigned material of the body.
`bounding_box`	Get the bounding box of the body.

Special methods

__repr__

Represent the master body as a string.

Import detail#

from ansys.geometry.core.designer.body import MasterBody

Property detail#

property MasterBody.id: str#: Get the ID of the body as a string.

property MasterBody.name: str#: Get the name of the body.

property MasterBody.fill_style: str#: Get the fill style of the body.

property MasterBody.is_suppressed: bool#: Get the body suppression state.

Warning

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

property MasterBody.color: str#: Get the current color of the body.

property MasterBody.opacity: float#: Get the float value of the opacity for the body.

property MasterBody.is_surface: bool#: Check if the body is a planar body.

property MasterBody.surface_thickness: pint.Quantity | None#

Get the surface thickness of a surface body.

Notes

This method is only for surface-type bodies that have been assigned a surface thickness.

property MasterBody.surface_offset: MidSurfaceOffsetType | None#

Get the surface offset type of a surface body.

Notes

This method is only for surface-type bodies that have been assigned a surface offset.

property MasterBody.faces: list[ansys.geometry.core.designer.face.Face]#

Get a list of all faces within the body.

Returns:

list[Face]

property MasterBody.edges: list[ansys.geometry.core.designer.edge.Edge]#

Get a list of all edges within the body.

Returns:

list[Edge]

property MasterBody.vertices: list[ansys.geometry.core.designer.vertex.Vertex]#

Get a list of all vertices within the body.

Returns:

list[Vertex]

property MasterBody.is_alive: bool#: Check if the body is still alive and has not been deleted.

property MasterBody.volume: pint.Quantity#

Calculate the volume of the body.

Notes

When dealing with a planar surface, a value of 0 is returned as a volume.

property MasterBody.material: ansys.geometry.core.materials.material.Material#

Get the assigned material of the body.

Returns:

Material: Material assigned to the body.

property MasterBody.bounding_box: ansys.geometry.core.math.bbox.BoundingBox#

Get the bounding box of the body.

Returns:

BoundingBox: Bounding box of the body.

Warning

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

Method detail#

MasterBody.reset_tessellation_cache()#

Decorate MasterBody methods that need tessellation cache update.

Parameters:

funcmethod: Method to call.

Returns:

Any: Output of the method, if any.

MasterBody.assign_material(material: ansys.geometry.core.materials.material.Material) → None#

Assign a material against the active design.

Parameters:

materialMaterial: Source material data.

MasterBody.get_assigned_material() → ansys.geometry.core.materials.material.Material#

Get the assigned material of the body.

Returns:

Material: Material assigned to the body.

MasterBody.remove_assigned_material() → None#: Remove the material assigned to the body.

MasterBody.add_midsurface_thickness(thickness: ansys.geometry.core.misc.measurements.Distance | pint.Quantity | ansys.geometry.core.typing.Real) → None#

Add a mid-surface thickness to a surface body.

Parameters:

thicknessDistance | Quantity | Real: Thickness to assign.

Notes

Only surface bodies are eligible for mid-surface thickness assignment.

MasterBody.add_midsurface_offset(offset: MidSurfaceOffsetType) → None#

Add a mid-surface offset to a surface body.

Parameters:

offset_typeMidSurfaceOffsetType: Surface offset to assign.

Notes

Only surface bodies are eligible for mid-surface offset assignment.

abstractmethod MasterBody.imprint_curves(faces: list[ansys.geometry.core.designer.face.Face], sketch: ansys.geometry.core.sketch.sketch.Sketch) → tuple[list[ansys.geometry.core.designer.edge.Edge], list[ansys.geometry.core.designer.face.Face]]#

Imprint all specified geometries onto specified faces of the body.

Parameters:

faces: list[Face]: list of faces to imprint the curves of the sketch onto.
sketch: Sketch: All curves to imprint on the faces.

Returns:

tuple[list[Edge], list[Face]]: All impacted edges and faces from the imprint operation.

abstractmethod MasterBody.project_curves(direction: ansys.geometry.core.math.vector.UnitVector3D, sketch: ansys.geometry.core.sketch.sketch.Sketch, closest_face: bool, only_one_curve: bool = False) → list[ansys.geometry.core.designer.face.Face]#

Project all specified geometries onto the body.

Parameters:

direction: UnitVector3D: Direction of the projection.
sketch: Sketch: All curves to project on the body.
closest_face: bool: Whether to target the closest face with the projection.
only_one_curve: bool, default: False: Whether to project only one curve of the entire sketch. When True, only one curve is projected.

Returns:

list[Face]: All faces from the project curves operation.

Notes

The only_one_curve parameter allows you to optimize the server call because projecting curves is an expensive operation. This reduces the workload on the server side.

abstractmethod MasterBody.imprint_projected_curves(direction: ansys.geometry.core.math.vector.UnitVector3D, sketch: ansys.geometry.core.sketch.sketch.Sketch, closest_face: bool, only_one_curve: bool = False) → list[ansys.geometry.core.designer.face.Face]#

Project and imprint specified geometries onto the body.

This method combines the project_curves() and imprint_curves() method into one method. It has higher performance than calling them back-to-back when dealing with many curves. Because it is a specialized function, this method only returns the faces (and not the edges) from the imprint operation.

Parameters:

direction: UnitVector3D: Direction of the projection.
sketch: Sketch: All curves to project on the body.
closest_face: bool: Whether to target the closest face with the projection.
only_one_curve: bool, default: False: Whether to project only one curve of the entire sketch. When True, only one curve is projected.

Returns:

list[Face]: All imprinted faces from the operation.

Notes

The only_one_curve parameter allows you to optimize the server call because projecting curves is an expensive operation. This reduces the workload on the server side.

MasterBody.translate(direction: ansys.geometry.core.math.vector.UnitVector3D, distance: pint.Quantity | ansys.geometry.core.misc.measurements.Distance | ansys.geometry.core.typing.Real) → None#

Translate the body in a specified direction and distance.

Parameters:

direction: UnitVector3D: Direction of the translation.
distance: ~pint.Quantity | Distance | Real: Distance (magnitude) of the translation.

MasterBody.set_name(name: str) → None#: Set the name of the body.

Warning

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

MasterBody.set_fill_style(fill_style: FillStyle) → None#: Set the fill style of the body.

Warning

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

MasterBody.set_suppressed(suppressed: bool) → None#: Set the body suppression state.

Warning

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

MasterBody.set_color(color: str | tuple[float, float, float] | tuple[float, float, float, float]) → None#

Set the color of the body.

Parameters:

colorstr | tuple[float, float, float] | tuple[float, float, float, float]: Color to set the body to. This can be a string representing a color name or a tuple of RGB values in the range [0, 1] (RGBA) or [0, 255] (pure RGB).

Warning

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

MasterBody.set_opacity(opacity: float) → None#: Set the opacity of the body.

Warning

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

MasterBody.rotate(axis_origin: ansys.geometry.core.math.point.Point3D, axis_direction: ansys.geometry.core.math.vector.UnitVector3D, angle: pint.Quantity | ansys.geometry.core.misc.measurements.Angle | ansys.geometry.core.typing.Real) → None#

Rotate the geometry body around the specified axis by a given angle.

Parameters:

axis_origin: Point3D: Origin of the rotational axis.
axis_direction: UnitVector3D: The axis of rotation.
angle: ~pint.Quantity | Angle | Real: Angle (magnitude) of the rotation.

Warning

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

MasterBody.scale(value: ansys.geometry.core.typing.Real) → None#

Scale the geometry body by the given value.

The calling object is directly modified when this method is called. Thus, it is important to make copies if needed.

Parameters:

value: Real: Value to scale the body by.

Warning

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

MasterBody.map(frame: ansys.geometry.core.math.frame.Frame) → None#

Map the geometry body to the new specified frame.

The calling object is directly modified when this method is called. Thus, it is important to make copies if needed.

Parameters:

frame: Frame: Structure defining the orientation of the body.

Warning

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

MasterBody.mirror(plane: ansys.geometry.core.math.plane.Plane) → None#

Mirror the geometry body across the specified plane.

The calling object is directly modified when this method is called. Thus, it is important to make copies if needed.

Parameters:

plane: Plane: Represents the mirror.

Warning

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

MasterBody.get_collision(body: Body) → CollisionType#

Get the collision state between bodies.

Parameters:

body: Body: Object that the collision state is checked with.

Returns:

CollisionType: Enum that defines the collision state between bodies.

Warning

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

abstractmethod MasterBody.copy(parent: ansys.geometry.core.designer.component.Component, name: str = None) → Body#

Create a copy of the body under the specified parent.

Parameters:

parent: Component: Parent component to place the new body under within the design assembly.
name: str: Name to give the new body.

Returns:

Body: Copy of the body.

MasterBody.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 body and return the raw tessellation data.

Parameters:

transformMatrix44, default: IDENTITY_MATRIX44: A transformation matrix to apply to the tessellation.
tess_optionsTessellationOptions | None, default: None: A set of options to determine the tessellation quality.
reset_cachebool, default: False: Whether to reset the tessellation cache and re-request the tessellation from the server.
include_facesbool, default: True: Whether to include face tessellation data in the output.
include_edgesbool, default: False: Whether to include edge tessellation data in the output.

Returns:

dict: Dictionary with face and edge IDs as keys and face and edge tessellation data as values.

MasterBody.tessellate(merge: bool = False, transform: ansys.geometry.core.math.matrix.Matrix44 = IDENTITY_MATRIX44, tess_options: ansys.geometry.core.misc.options.TessellationOptions | None = None, reset_cache: bool = False, include_faces: bool = True, include_edges: bool = False) → pyvista.PolyData | pyvista.MultiBlock#

Tessellate the body and return the geometry as triangles.

Parameters:

mergebool, default: False: Whether to merge the body into a single mesh. When False (default), the number of triangles are preserved and only the topology is merged. When True, the individual faces of the tessellation are merged.
tess_optionsTessellationOptions | None, default: None: A set of options to determine the tessellation quality.
reset_cachebool, default: False: Whether to reset the tessellation cache and re-request the tessellation from the server.
include_facesbool, default: True: Whether to include face tessellation data in the output.
include_edgesbool, default: False: Whether to include edge tessellation data in the output.

Returns:

PolyData, MultiBlock: Merged pyvista.PolyData if merge=True or a composite dataset.

Examples

Extrude a box centered at the origin to create a rectangular body and tessellate it:

>>> from ansys.geometry.core.misc.units import UNITS as u
>>> from ansys.geometry.core.sketch import Sketch
>>> from ansys.geometry.core.math import Plane, Point2D, Point3D, UnitVector3D
>>> from ansys.geometry.core import Modeler
>>> modeler = Modeler()
>>> origin = Point3D([0, 0, 0])
>>> plane = Plane(origin, direction_x=[1, 0, 0], direction_y=[0, 0, 1])
>>> sketch = Sketch(plane)
>>> box = sketch.box(Point2D([2, 0]), 4, 4)
>>> design = modeler.create_design("my-design")
>>> my_comp = design.add_component("my-comp")
>>> body = my_comp.extrude_sketch("my-sketch", sketch, 1 * u.m)
>>> blocks = body.tessellate()
>>> blocks
>>> MultiBlock(0x7F94EC757460)
     N Blocks:  6
     X Bounds:  0.000, 4.000
     Y Bounds:  -1.000, 0.000
     Z Bounds:  -0.500, 4.500

Merge the body:

>>> mesh = body.tessellate(merge=True)
>>> mesh
PolyData (0x7f94ec75f3a0)
  N Cells:      12
  N Points:     24
  X Bounds:     0.000e+00, 4.000e+00
  Y Bounds:     -1.000e+00, 0.000e+00
  Z Bounds:     -5.000e-01, 4.500e+00
  N Arrays:     0

MasterBody.shell_body(offset: ansys.geometry.core.misc.measurements.Distance | pint.Quantity | ansys.geometry.core.typing.Real) → bool#

Shell the body to the thickness specified.

Parameters:

offsetDistance | Quantity | Real: Shell thickness.

Returns:

bool: True when successful, False when failed.

Warning

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

MasterBody.remove_faces(selection: ansys.geometry.core.designer.face.Face | collections.abc.Iterable[ansys.geometry.core.designer.face.Face], offset: ansys.geometry.core.misc.measurements.Distance | pint.Quantity | ansys.geometry.core.typing.Real) → bool#

Shell by removing a given set of faces.

Parameters:

selectionFace | Iterable[Face]: Face or faces to be removed.
offsetDistance | Quantity | Real: Shell thickness.

Returns:

bool: True when successful, False when failed.

Warning

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

MasterBody.combine_merge(other: Body | list[Body]) → None#

Combine this body with another body or bodies, merging them into a single body.

Parameters:

otherUnion[Body, list[Body]]: The body or list of bodies to combine with this body.

Notes

The self parameter is directly modified, and the other bodies are consumed.

abstractmethod MasterBody.plot(merge: bool = True, screenshot: str | None = None, use_trame: bool | None = None, use_service_colors: bool | None = None, **plotting_options: dict | None) → None#

Plot the body.

Parameters:

mergebool, default: True: Whether to merge the body into a single mesh. Performance improved when True. When True (default), the individual faces of the tessellation are merged. When False, the number of triangles are preserved and only the topology is merged.
screenshotstr, default: None: Path for saving a screenshot of the image that is being represented.
use_tramebool, default: None: Whether to enable the use of trame. The default is None, in which case the ansys.tools.visualization_interface.USE_TRAME global setting is used.
use_service_colorsbool, default: None: Whether to use the colors assigned to the body in the service. The default is None, in which case the ansys.geometry.core.USE_SERVICE_COLORS global setting is used.
**plotting_optionsdict, default: None: Keyword arguments for plotting. For allowable keyword arguments, see the Plotter.add_mesh method.

Examples

Extrude a box centered at the origin to create rectangular body and plot it:

>>> from ansys.geometry.core.misc.units import UNITS as u
>>> from ansys.geometry.core.sketch import Sketch
>>> from ansys.geometry.core.math import Plane, Point2D, Point3D, UnitVector3D
>>> from ansys.geometry.core import Modeler
>>> modeler = Modeler()
>>> origin = Point3D([0, 0, 0])
>>> plane = Plane(origin, direction_x=[1, 0, 0], direction_y=[0, 0, 1])
>>> sketch = Sketch(plane)
>>> box = sketch.box(Point2D([2, 0]), 4, 4)
>>> design = modeler.create_design("my-design")
>>> mycomp = design.add_component("my-comp")
>>> body = mycomp.extrude_sketch("my-sketch", sketch, 1 * u.m)
>>> body.plot()

Plot the body and color each face individually:

>>> body.plot(multi_colors=True)

abstractmethod MasterBody.intersect(other: Body | collections.abc.Iterable[Body], keep_other: bool = False) → None#

Intersect two (or more) bodies.

Parameters:

otherBody: Body to intersect with.
keep_otherbool, default: False: Whether to retain the intersected body or not.

Raises:

ValueError: If the bodies do not intersect.

Notes

The self parameter is directly modified with the result, and the other parameter is consumed. Thus, it is important to make copies if needed. If the keep_other parameter is set to True, the intersected body is retained.

abstractmethod MasterBody.subtract(other: Body | collections.abc.Iterable[Body], keep_other: bool = False) → None#

Subtract two (or more) bodies.

Parameters:

otherBody: Body to subtract from the self parameter.
keep_otherbool, default: False: Whether to retain the subtracted body or not.

Raises:

ValueError: If the subtraction results in an empty (complete) subtraction.

Notes

The self parameter is directly modified with the result, and the other parameter is consumed. Thus, it is important to make copies if needed. If the keep_other parameter is set to True, the subtracted body is retained.

abstractmethod MasterBody.unite(other: Body | collections.abc.Iterable[Body], keep_other: bool = False) → None#

Unite two (or more) bodies.

Parameters:

otherBody: Body to unite with the self parameter.
keep_otherbool, default: False: Whether to retain the united body or not.

Notes

The self parameter is directly modified with the result, and the other parameter is consumed. Thus, it is important to make copies if needed. If the keep_other parameter is set to True, the united body is retained.

MasterBody.__repr__() → str#: Represent the master body as a string.

MasterBody#

Overview#

Import detail#

Property detail#

Method detail#

`MasterBody`#