pyaedt.modeler.Object3d.Object3d#

class pyaedt.modeler.Object3d.Object3d(primitives, name=None)[source]#

Manages object attributes for the AEDT 3D Modeler.

Parameters:
primitivespyaedt.modeler.Primitives3D.Primitives3D

Inherited parent object.

namestr

Examples

Basic usage demonstrated with an HFSS design:

>>> from pyaedt import Hfss
>>> aedtapp = Hfss()
>>> prim = aedtapp.modeler

Create a part, such as box, to return an pyaedt.modeler.Object3d.Object3d.

>>> id = prim.create_box([0, 0, 0], [10, 10, 5], "Mybox", "Copper")
>>> part = prim[id]

Methods

Object3d.clone()

Clone the object and return the new 3D object.

Object3d.delete()

Delete the object.

Object3d.duplicate_along_line(vector[, ...])

Duplicate the object along a line.

Object3d.duplicate_around_axis(cs_axis[, ...])

Duplicate the object around the axis.

Object3d.edges_by_length(length[, ...])

Filter edges by length.

Object3d.export_image([file_path])

Export the model to path.

Object3d.faces_by_area(area[, area_filter, ...])

Filter faces by area.

Object3d.largest_face([n])

Return only the face with the greatest area.

Object3d.longest_edge([n])

Return only the edge with the greatest length.

Object3d.mirror(position, vector)

Mirror a selection.

Object3d.move(vector)

Move objects from a list.

Object3d.plot([show])

Plot model with PyVista.

Object3d.rotate(cs_axis[, angle, unit])

Rotate the selection.

Object3d.section(plane[, create_new, ...])

Section the object.

Object3d.shortest_edge([n])

Return only the edge with the smallest length.

Object3d.smallest_face([n])

Return only the face with the smallest area.

Object3d.subtract(tool_list[, keep_originals])

Subtract one or more parts from the object.

Object3d.sweep_along_path(sweep_object[, ...])

Sweep the selection along a vector.

Object3d.sweep_along_vector(sweep_vector[, ...])

Sweep the selection along a vector.

Object3d.sweep_around_axis(cs_axis[, ...])

Sweep around an axis.

Object3d.translate(vector)

Translate the object and return the 3D object.

Object3d.unite(object_list)

Unite a list of objects with this object.

Attributes

Object3d.bottom_edge_x

Bottom edge in the X direction of the object.

Object3d.bottom_edge_y

Bottom edge in the X direction of the object.

Object3d.bottom_edge_z

Bottom edge in the Z direction of the object.

Object3d.bottom_face_x

Bottom face in the X direction of the object.

Object3d.bottom_face_y

Bottom face in the X direction of the object.

Object3d.bottom_face_z

Bottom face in the Z direction of the object.

Object3d.bounding_box

Bounding box of a part.

Object3d.bounding_dimension

Retrieve the dimension array of the bounding box.

Object3d.color

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

Object3d.color_string

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

Object3d.display_wireframe

Wireframe property of the part.

Object3d.edges

Information for each edge in the given part.

Object3d.face_closest_to_bounding_box

Return only the face ids of the face closest to the bounding box.

Object3d.faces

Information for each face in the given part.

Object3d.faces_on_bounding_box

Return only the face ids of the faces touching the bounding box.

Object3d.group_name

Group the object belongs to.

Object3d.id

ID of the object.

Object3d.is3d

Check for if the object is 3D.

Object3d.logger

Logger.

Object3d.m_Editor

Pointer to the oEditor object in the AEDT API.

Object3d.mass

Object mass.

Object3d.material_name

Material name of the object.

Object3d.model

Part Model/Non-model property.

Object3d.name

Name of the object as a string value.

Object3d.object_type

Type of the object.

Object3d.object_units

Object units.

Object3d.part_coordinate_system

Part coordinate system.

Object3d.solve_inside

Part solve inside flag.

Object3d.surface_material_name

Surface material name of the object.

Object3d.top_edge_x

Top edge in the X direction of the object.

Object3d.top_edge_y

Top edge in the Y direction of the object.

Object3d.top_edge_z

Top edge in the Z direction of the object.

Object3d.top_face_x

Top face in the X direction of the object.

Object3d.top_face_y

Top face in the Y direction of the object.

Object3d.top_face_z

Top face in the Z direction of the object.

Object3d.touching_objects

Get the objects that touch one of the vertex, edge midpoint or face of the object.

Object3d.transparency

Part transparency as a value between 0.0 and 1.0.

Object3d.valid_properties

Valid properties.

Object3d.vertices

Information for each vertex in the given part.

Object3d.volume

Object volume.