Polygon#

class pyaedt.modeler.advanced_cad.stackup_3d.Polygon(application, point_list, signal_layer, poly_name='poly', mat_name='copper', is_void=False, reference_system=None)[source]#

Polygon Class in Stackup3D. It is preferable to use the add_polygon method in the class Layer3D than directly the class constructor.

Parameters:
applicationpyaedt.hfss.Hfss

HFSS design or project where the variable is to be created.

point_listlist

Points list of [x,y] coordinates.

signal_layerpyaedt.modeler.stackup_3d.Layer3D

The signal layer where the line will be drawn.

poly_namestr, optional

Polygon name. The default is poly.

mat_namestr, optional

The polygon material name.

is_voidbool, optional

Whether the polygon is a void. The default is False. On ground layers, it will act opposite of the Boolean value because the ground is negative.

reference_systemstr, None, optional

Coordinate system of the polygon. By default, None.

Examples

>>> from pyaedt import Hfss
>>> from pyaedt.modeler.stackup_3d import Stackup3D
>>> hfss = Hfss(new_desktop_session=True)
>>> my_stackup = Stackup3D(hfss, 2.5e9)
>>> gnd = my_stackup.add_ground_layer("gnd", thickness=None)
>>> my_stackup.add_dielectric_layer("diel1", thickness=1.5, material="Duroid (tm)")
>>> top = my_stackup.add_signal_layer("top", thickness=None)
>>> my_polygon = top.add_polygon([[0, 0], [0, 1], [1, 1], [1, 0]])
>>> my_stackup.dielectric_x_position = "2mm"
>>> my_stackup.dielectric_y_position = "2mm"
>>> my_stackup.dielectric_length = "-3mm"
>>> my_stackup.dielectric_width = "-3mm"

Attributes

Polygon.aedt_object

PyAEDT object 3D.

Polygon.application

App object.

Polygon.dielectric_layer

Dielectric layer that the object belongs to.

Polygon.layer_name

Layer name.

Polygon.layer_number

Layer ID.

Polygon.material_name

Material name.

Polygon.name

Object name.

Polygon.points_on_layer

Object Bounding Box.

Polygon.reference_system

Coordinate system of the object.

Polygon.signal_layer

Signal layer that the object belongs to.