osecore.app.shape.face

Name

Description

is_face_parallel_to_xy_plane

Check if the given face is parallel to the XY plane.

is_face_parallel_to_xz_plane

Check if the given face is parallel to the XZ plane.

is_face_parallel_to_yz_plane

Check if the given face is parallel to the YZ plane.

is_face_planar

Returns whether a face is planar or not.

make_face_from_vectors

Make a Face from list of vectors.


is_face_parallel_to_xy_plane(face: Part.Face) → bool

Check if the given face is parallel to the XY plane.

Parameters

face (Part.Face) – A face.

Returns

True if the face is parallel to the XY plane, False otherwise.

Return type

bool

is_face_parallel_to_xz_plane(face: Part.Face) → bool

Check if the given face is parallel to the XZ plane.

Parameters

face (Part.Face) – A face.

Returns

True if the face is parallel to the XZ plane, False otherwise.

Return type

bool

is_face_parallel_to_yz_plane(face: Part.Face) → bool

Check if the given face is parallel to the YZ plane.

Parameters

face (Part.Face) – A face.

Returns

True if the face is parallel to the YZ plane, False otherwise.

Return type

bool

is_face_planar(face: Part.Face) → bool

Returns whether a face is planar or not.

Returns False for cylindrical faces like holes.

Parameters

face (Part.Face) – A face.

Returns

True if the face is planar, False otherwise.

Return type

bool

make_face_from_vectors(vectors: List[Base.Vector]) → Part.Face

Make a Face from list of vectors.

See Part::TopoShapeFacePy Class Reference:

https://www.freecadweb.org/api/d9/d35/classPart_1_1TopoShapeFacePy.html

Raises
  • ValueError – When there’s less than three vectors in a list.

  • ValueError – When vectors don’t form a closed wire.

Returns

A face

Return type

Part.Face