pyaedt.modeler.Primitives3D.Primitives3D#

class pyaedt.modeler.Primitives3D.Primitives3D[source]#

Manages primitives in 3D tools.

This class is inherited in the caller application and is accessible through the primitives variable part of modeler object( e.g. hfss.modeler or icepak.modeler).

Parameters:
applicationstr

Name of the application.

Examples

Basic usage demonstrated with an HFSS, Maxwell 3D, Icepak, Q3D, or Mechanical design:

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

Methods

Primitives3D.add_bird(actor_folder[, speed, ...])

Add a Bird Multipart from 3D Components.

Primitives3D.add_environment(env_folder[, ...])

Add an Environment Multipart Component from Json file.

Primitives3D.add_new_objects()

Add objects that have been created in the modeler by previous operations.

Primitives3D.add_new_user_defined_component()

Add 3D components and user-defined models that have been created in the modeler by previous operations.

Primitives3D.add_person(actor_folder[, ...])

Add a Walking Person Multipart from 3D Components.

Primitives3D.add_vehicle(actor_folder[, ...])

Add a Moving Vehicle Multipart from 3D Components.

Primitives3D.check_choke_values(json_file[, ...])

Verify the values in the json file and create another one with corrected values next to the first one.

Primitives3D.cleanup_objects()

Clean up objects that no longer exist in the modeler because they were removed by previous operations.

Primitives3D.convert_segments_to_line(...)

Convert a CreatePolyline list of segments to lines.

Primitives3D.create_bondwire(start_position, ...)

Create a bondwire.

Primitives3D.create_box(position, ...[, ...])

Create a box.

Primitives3D.create_choke(json_file)

Create a chock from json setting file.

Primitives3D.create_circle(cs_plane, ...[, ...])

Create a circle.

Primitives3D.create_cone(cs_axis, position, ...)

Create a cone.

Primitives3D.create_cylinder(cs_axis, ...[, ...])

Create a cylinder.

Primitives3D.create_ellipse(cs_plane, ...[, ...])

Create an ellipse.

Primitives3D.create_equationbased_curve([...])

Create an equation-based curve.

Primitives3D.create_helix(polyline_name, ...)

Create an helix from a polyline.

Primitives3D.create_object_from_edge(edge)

Create a line object from an edge ID or from an pyaedt.modeler.Object3d.EdgePrimitive object.

Primitives3D.create_object_from_face(face)

Create an object from a face.

Primitives3D.create_point(position[, name, ...])

Create a point.

Primitives3D.create_polyhedron([cs_axis, ...])

Create a regular polyhedron.

Primitives3D.create_polyline(position_list)

Draw a polyline object in the 3D modeler.

Primitives3D.create_rectangle(csPlane, ...)

Create a rectangle.

Primitives3D.create_region([pad_percent])

Create an air region.

Primitives3D.create_sphere(position, radius)

Create a sphere.

Primitives3D.create_spiral([...])

Create a spiral inductor from a polyline.

Primitives3D.create_spiral_on_face(face, ...)

Create a Spiral Polyline inside a face.

Primitives3D.create_torus(center, ...[, ...])

Create a torus.

Primitives3D.create_udm(udmfullname, ...[, ...])

Create a user-defined model.

Primitives3D.create_udp(udp_dll_name, ...[, ...])

Create a user-defined primitive (UDP).

Primitives3D.delete([objects])

Delete objects or groups.

Primitives3D.delete_objects_containing(...)

Delete all objects with a given prefix.

Primitives3D.does_object_exists(object)

"Check to see if an object exists.

Primitives3D.find_closest_edges(start_obj, ...)

Retrieve the two closest edges that are not perpendicular for two objects.

Primitives3D.find_new_objects()

Find any new objects in the modeler that were created by previous operations.

Primitives3D.get_3d_component_object_list(...)

Retrieve all objects belonging to a 3D component.

Primitives3D.get_bodynames_from_position(...)

Retrieve the names of the objects that are in contact with a given point.

Primitives3D.get_closest_edgeid_to_position(...)

Get the edge ID closest to a given position.

Primitives3D.get_edge_length(edgeID)

Get the length of an edge.

Primitives3D.get_edge_midpoint(partID)

Retrieve the midpoint coordinates of a given edge ID or edge name.

Primitives3D.get_edge_vertices(edgeID)

Retrieve the vertex IDs of a given edge ID or edge name.

Primitives3D.get_edgeid_from_position(position)

Get an edge ID from a position.

Primitives3D.get_edgeids_from_vertexid(...)

Retrieve edge IDs for a vertex ID.

Primitives3D.get_edges_for_circuit_port(face_id)

Retrieve two edge IDs suitable for the circuit port.

Primitives3D.get_edges_for_circuit_port_from_sheet(sheet)

Retrieve two edge IDs that are suitable for a circuit port from a sheet.

Primitives3D.get_edges_on_bounding_box(sheets)

Retrieve the edges of the sheets passed in the input that are lying on the bounding box.

Primitives3D.get_equivalent_parallel_edges(...)

Create two new edges that are parallel and equal to the smallest edge given a parallel couple of edges.

Primitives3D.get_existing_polyline(object)

Retrieve a polyline object to manipulate it.

Primitives3D.get_face_area(face_id)

Retrieve the area of a given face ID.

Primitives3D.get_face_center(face_id)

Retrieve the center position for a given planar face ID.

Primitives3D.get_face_edges(partId)

Retrieve the edge IDs of a given face name or face ID.

Primitives3D.get_face_vertices(face_id)

Retrieve the vertex IDs of a given face ID or face name.

Primitives3D.get_faceid_from_position(position)

Retrieve a face ID from a position.

Primitives3D.get_mid_points_on_dir(sheet, ...)

Retrieve midpoints on a given axis direction.

Primitives3D.get_model_bounding_box()

Retrieve the model's bounding box.

Primitives3D.get_obj_id(objname)

Return the object ID from an object name.

Primitives3D.get_object_edges(partId)

Retrieve the edge IDs of a given object ID or object name.

Primitives3D.get_object_faces(partId)

Retrieve the face IDs of a given object ID or object name.

Primitives3D.get_object_from_name(objname)

Return the object from an object name.

Primitives3D.get_object_vertices(partID)

Retrieve the vertex IDs of a given object name or object ID.

Primitives3D.get_objects_by_material(...)

Retrieve a list of the IDs for objects of a specified material.

Primitives3D.get_objects_w_string(stringname)

Retrieve all objects with a given string in their names.

Primitives3D.get_vertex_position(vertex_id)

Retrieve a vector of vertex coordinates.

Primitives3D.insert_3d_component(compFile[, ...])

Insert a new 3D component.

Primitives3D.refresh()

Refresh this object.

Primitives3D.refresh_all_ids()

Refresh all IDs.

Primitives3D.remove_point(name)

Remove a point.

Primitives3D.update_object(obj)

Update any pyaedt.modeler.Object3d.Object3d derivatives that have potentially been modified by a modeler operation.

Primitives3D.update_udp(object_name, ...)

Update an existing geometrical object that was originally created using a user-defined primitive (UDP).

Primitives3D.value_in_object_units(value)

Convert one or more strings for numerical lengths to floating point values.

Attributes

Primitives3D.defaultmaterial

Default material.

Primitives3D.line_names

List of the names of all line objects.

Primitives3D.line_objects

List of all line objects.

Primitives3D.logger

Logger.

Primitives3D.model_consistency_report

Summary of detected inconsistencies between the AEDT modeler and PyAEDT structures.

Primitives3D.model_objects

List of the names of all model objects.

Primitives3D.model_units

Model units.

Primitives3D.modeler

Modeler.

Primitives3D.non_model_objects

List of names of all non-model objects.

Primitives3D.object_list

List of all objects.

Primitives3D.object_names

List of the names of all objects.

Primitives3D.points

List of points.

Primitives3D.points_by_name

Dictionary containing all points where the keys are the name of the points.

Primitives3D.sheet_names

List of the names of all sheet objects.

Primitives3D.sheet_objects

List of all sheet objects.

Primitives3D.solid_names

List of the names of all solid objects.

Primitives3D.solid_objects

List of all solid objects.

Primitives3D.unclassified_names

List of the names of all unclassified objects.

Primitives3D.unclassified_objects

List of all unclassified objects.

Primitives3D.user_defined_component_names

List of the names of all 3D component objects.

Primitives3D.version

Version.