SketchFace#

class ansys.geometry.core.sketch.face.SketchFace#

Provides for modeling a face.

Overview#

plane_change

Redefine the plane containing SketchFace objects.

edges

List of all component edges forming the face.

perimeter

Perimeter of the face.

visualization_polydata

VTK polydata representation for PyVista visualization.

Import detail#

from ansys.geometry.core.sketch.face import SketchFace

Property detail#

property SketchFace.edges: beartype.typing.List[ansys.geometry.core.sketch.edge.SketchEdge]#

List of all component edges forming the face.

property SketchFace.perimeter: pint.Quantity#

Perimeter of the face.

property SketchFace.visualization_polydata: pyvista.PolyData#

VTK polydata representation for PyVista visualization.

The representation lies in the X/Y plane within the standard global Cartesian coordinate system.

Returns:
pyvista.PolyData

VTK pyvista.Polydata configuration.

Method detail#

SketchFace.plane_change(plane: ansys.geometry.core.math.plane.Plane) → None#

Redefine the plane containing SketchFace objects.

Parameters:
planePlane

Desired new plane that is to contain the sketched face.

Notes

This implies that their 3D definition might suffer changes. This method does nothing by default. It is required to be implemented in child SketchFace classes.