get_edges_for_circuit_port_from_sheet#
- Modeler3D.get_edges_for_circuit_port_from_sheet(sheet, XY_plane=True, YZ_plane=True, XZ_plane=True, allow_perpendicular=False, tol=1e-06)[source]#
Retrieve two edge IDs that are suitable for a circuit port from a sheet.
One edge belongs to the sheet 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 one or more sheet objects as input, while the method
Primitives.get_edges_for_circuit_port()
accepts a face ID.- Parameters:
- sheet
int
,str
,or
list
ID or name for one or more sheets.
- 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
.- tol
float
,optional
Geometric tolerance. The default is
1e-6
.
- sheet
- Returns:
list
List of edge IDs.