pyaedt.modeler.Primitives.Polyline

class pyaedt.modeler.Primitives.Polyline(primitives, src_object=None, position_list=None, segment_type=None, cover_surface=False, close_surface=False, name=None, matname=None, xsection_type=None, xsection_orient=None, xsection_width=1, xsection_topwidth=1, xsection_height=1, xsection_num_seg=0, xsection_bend_type=None)[source]

Creates and manipulates a polyline.

The constructor for this class is intended to be called from the pyaedt.modeler.Primitives.Primitives.create_polyline() method. The documentation is provided there.

The returned Polyline object exposes the methods for manipulating the polyline.

Parameters
primitivespyaedt.modeler.Primitives3D.Primitives3D

Pointer to the parent Primitives object.

src_objectoptional

The default is None.

position_listlist, optional

List of positions in the [x, y, z] format. The default is None.

segment_typestr or list, optional

Define the list of segment types. Valid arguments are "Line", "Arc", "Spline", "AngularArc". The default is None.

cover_surfacebool, optional

The default is False.

close_surfacebool, optional

The default is False.

namestr, optional

The default is None.

matnamestr, optional

Name of the material. The default is None.

xsection_typestr, optional

Type of the cross-section. Options are "Line", "Circle", "Rectangle", and "Isosceles Trapezoid". The default is None.

xsection_orientstr, optional

Direction of the normal vector to the width of the cross-section. Options are "X", "Y", "Z", and "Auto". The default is None.

xsection_widthfloat or str, optional

Width or diameter of the cross-section for all types. The default is 1.

xsection_topwidthfloat or str, optional

Top width of the cross-section for the type "Isosceles Trapezoid" only. The default is 1.

xsection_heightfloat or str, optional

Height of the cross-section for the types "Rectangle" and "Isosceles Trapezoid" only. The default is 1.

xsection_num_segint, optional

Number of segments in the cross-section surface for the types "Circle", "Rectangle" and "Isosceles Trapezoid". The default is 0. The value must be 0 or greater than 2.

xsection_bend_typestr, optional

Type of the bend. The default is None, in which case the bend type is set to "Corner". For the type "Circle", the bend type should be set to "Curved".

Methods

Polyline.clone()

Clone a polyline object.

Polyline.delete()

Delete the object.

Polyline.duplicate_along_line(vector[, …])

Duplicate the object along a line.

Polyline.duplicate_around_axis(cs_axis[, …])

Duplicate the object around the axis.

Polyline.export_image([file_path])

Export the model to path.

Polyline.insert_segment(position_list[, segment])

Add a segment to an existing polyline.

Polyline.plot([show])

Plot model with PyVista.

Polyline.remove_edges(edge_id)

Remove a vertex from an existing polyline by position.

Polyline.remove_vertex(position[, abstol])

Remove a vertex from an existing polyline by position.

Polyline.section(plane[, create_new, …])

Section the object.

Polyline.set_crosssection_properties([type, …])

Set the properties of an existing polyline object.

Polyline.subtract(tool_list[, keep_originals])

Subtract one or more parts from the object.

Polyline.sweep_along_path(sweep_object[, …])

Sweep the selection along a vector.

Polyline.sweep_along_vector(sweep_vector[, …])

Sweep the selection along a vector.

Polyline.sweep_around_axis(cs_axis[, …])

Sweep around an axis.

Polyline.translate(vector)

Translate the object and return the 3D object.

Polyline.unite(object_list)

Unite a list of objects with this object.

Attributes

Polyline.bottom_face_x

Bottom face in the X direction of the object.

Polyline.bottom_face_y

Bottom face in the X direction of the object.

Polyline.bottom_face_z

Bottom face in the Z direction of the object.

Polyline.bounding_box

Bounding box of a part.

Polyline.color

Part color as a tuple of integer values for (Red, Green, Blue) color values.

Polyline.color_string

Color tuple as a string in the format ‘(Red, Green, Blue)’.

Polyline.display_wireframe

Wireframe property of the part.

Polyline.edges

Information for each edge in the given part.

Polyline.end_point

List of the [x, y, z] coordinates for the ending point in the polyline object in the object’s coordinate system.

Polyline.faces

Information for each face in the given part.

Polyline.group_name

Group the object belongs to.

Polyline.id

ID of the object.

Polyline.is3d

Check for if the object is 3D.

Polyline.logger

Logger.

Polyline.m_Editor

Pointer to the oEditor object in the AEDT API.

Polyline.material_name

Material name of the object.

Polyline.model

Part Model/Non-model property.

Polyline.name

Name of the object as a string value.

Polyline.object_type

Type of the object.

Polyline.object_units

Object units.

Polyline.part_coordinate_system

Part coordinate system.

Polyline.points

Polyline Points.

Polyline.solve_inside

Part solve inside flag.

Polyline.start_point

List of the [x, y, z] coordinates for the starting point in the polyline object in the object’s coordinate system.

Polyline.surface_material_name

Surface material name of the object.

Polyline.top_face_x

Top face in the X direction of the object.

Polyline.top_face_y

Top face in the Y direction of the object.

Polyline.top_face_z

Top face in the Z direction of the object.

Polyline.transparency

Part transparency as a value between 0.0 and 1.0.

Polyline.valid_properties

Valid properties.

Polyline.vertex_positions

List of the [x, y, z] coordinates for all vertex positions in the polyline object in the object’s coordinate system.

Polyline.vertices

Information for each vertex in the given part.