get_edges_for_circuit_port

Modeler2D.get_edges_for_circuit_port(face_id, XY_plane=True, YZ_plane=True, XZ_plane=True, allow_perpendicular=False, tol=1e-06)

Retrieve two edge IDs suitable for the circuit port.

One edge belongs to the face ID passed in the input, and the second edge is the closest edge’s coplanar to the first edge (aligned to the XY, YZ, or XZ plane). This method creates new lines for the detected edges and returns the IDs of these lines.

This method accepts a face ID in the input, while the get_edges_for_circuit_port_from_port method accepts one or more sheet objects.

Parameters
face_id

ID of the face.

XY_planebool, optional

Whether the edge’s pair are to be on the XY plane. The default is True.

YZ_planebool, optional

Whether the edge’s pair are to be on the YZ plane. The default is True.

XZ_planebool, optional

Whether the edge’s pair are to be on the XZ plane. The default is True.

allow_perpendicularbool, optional

Whether the edge’s pair are to be perpendicular. The default is False.

tolfloat, optional

Geometric tolerance. The default is 1e-6.

Returns
list

List of edge IDs.