yapcad

• yapcad package
  • Subpackages
    • yapcad.assembly package
      • Submodules
      • yapcad.assembly.assembly module
      • yapcad.assembly.constraint module
      • yapcad.assembly.datum module
      • yapcad.assembly.datum_registry module
      • yapcad.assembly.face_mate module
      • yapcad.assembly.intent module
      • yapcad.assembly.kinematic_integration module
      • yapcad.assembly.mate module
      • yapcad.assembly.mate_examples module
      • yapcad.assembly.mate_surrogates module
      • yapcad.assembly.solver module
      • Module contents
    • yapcad.boolean package
      • Submodules
      • yapcad.boolean.native module
      • yapcad.boolean.occ_engine module
      • yapcad.boolean.trimesh_engine module
      • Module contents
    • yapcad.collision package
      • Submodules
      • yapcad.collision.detector module
      • yapcad.collision.gear_interface module
      • yapcad.collision.interface module
      • yapcad.collision.registry module
      • yapcad.collision.result module
      • yapcad.collision.thread_interface module
      • Module contents
    • yapcad.contrib package
      • Submodules
      • yapcad.contrib.figgear module
      • Module contents
    • yapcad.dsl package
      • Subpackages
      • Submodules
      • yapcad.dsl.ast module
      • yapcad.dsl.checker module
      • yapcad.dsl.errors module
      • yapcad.dsl.introspection module
      • yapcad.dsl.lexer module
      • yapcad.dsl.packaging module
      • yapcad.dsl.parser module
      • yapcad.dsl.symbols module
      • yapcad.dsl.tokens module
      • yapcad.dsl.types module
      • Module contents
    • yapcad.fasteners package
      • Submodules
      • yapcad.fasteners.builders module
      • yapcad.fasteners.catalog module
      • Module contents
    • yapcad.io package
      • Submodules
      • yapcad.io.geometry_json module
      • yapcad.io.step module
      • yapcad.io.step_importer module
      • yapcad.io.stl module
      • Module contents
    • yapcad.kinematics package
      • Submodules
      • yapcad.kinematics.chain module
      • yapcad.kinematics.frame module
      • yapcad.kinematics.joint module
      • yapcad.kinematics.part module
      • yapcad.kinematics.transform module
      • Module contents
    • yapcad.manufacturing package
      • Submodules
      • yapcad.manufacturing.connectors module
      • yapcad.manufacturing.data module
      • yapcad.manufacturing.path_utils module
      • yapcad.manufacturing.rings module
      • yapcad.manufacturing.segmentation module
      • Module contents
    • yapcad.package package
      • Subpackages
      • Submodules
      • yapcad.package.core module
      • yapcad.package.signing module
      • yapcad.package.validator module
      • yapcad.package.viewer module
      • Module contents
    • yapcad.viewer package
      • Submodules
      • yapcad.viewer.api_server module
      • yapcad.viewer.config module
      • yapcad.viewer.events module
      • yapcad.viewer.vtk_viewer module
      • Module contents
  • Submodules
  • yapcad.analytic_surfaces module
    • bspline_surface()
    • bspline_surface_normal()
    • cone_surface()
    • cone_surface_normal()
    • cylinder_surface()
    • cylinder_surface_normal()
    • evaluate_bspline_surface()
    • evaluate_cone_surface()
    • evaluate_cylinder_surface()
    • evaluate_plane_surface()
    • evaluate_sphere_surface()
    • evaluate_surface()
    • evaluate_tessellated_surface()
    • evaluate_torus_surface()
    • is_analytic_surface()
    • is_bspline_surface()
    • is_cone_surface()
    • is_cylinder_surface()
    • is_plane_surface()
    • is_sphere_surface()
    • is_tessellated_surface()
    • is_torus_surface()
    • plane_surface()
    • plane_surface_normal()
    • sphere_surface()
    • sphere_surface_normal()
    • surface_normal()
    • tessellate_surface()
    • tessellated_surface()
    • tessellated_surface_normal()
    • torus_surface()
    • torus_surface_normal()
  • yapcad.brep module
    • BrepEdge
      • BrepEdge.shape
    • BrepFace
      • BrepFace.shape
    • BrepSolid
      • BrepSolid.shape
      • BrepSolid.tessellate()
    • BrepVertex
      • BrepVertex.shape
    • apply_matrix_to_brep_solid()
    • attach_brep_to_solid()
    • brep_from_solid()
    • chamfer_all_edges()
    • chamfer_edges()
    • fillet_all_edges()
    • fillet_edges()
    • has_brep_data()
    • is_brep()
    • occ_available()
    • require_occ()
  • yapcad.brep_edge_select module
    • edge_info()
    • filter_curved_edges()
    • filter_linear_edges()
    • get_all_edges()
    • intersect_edges()
    • select_bottom_edges()
    • select_edges_at_z()
    • select_edges_by_direction()
    • select_edges_by_length()
    • select_edges_crossing_z()
    • select_edges_in_cylinder()
    • select_edges_in_z_range()
    • select_edges_near_point()
    • select_horizontal_edges()
    • select_top_edges()
    • select_vertical_edges()
    • subtract_edges()
    • union_edges()
  • yapcad.combine module
    • Boolean
      • Boolean.geom
      • Boolean.mirror()
      • Boolean.rotate()
      • Boolean.scale()
      • Boolean.transform()
      • Boolean.translate()
      • Boolean.type
      • Boolean.types
  • yapcad.drawable module
    • Drawable
      • Drawable.colordict
      • Drawable.colormapAUTOCAD
      • Drawable.display()
      • Drawable.draw()
      • Drawable.draw_arc()
      • Drawable.draw_bbox()
      • Drawable.draw_circle()
      • Drawable.draw_ellipse()
      • Drawable.draw_line()
      • Drawable.draw_point()
      • Drawable.draw_text()
      • Drawable.draw_x()
      • Drawable.fillcolor
      • Drawable.layer
      • Drawable.layerlist
      • Drawable.linecolor
      • Drawable.linetype
      • Drawable.linewidth
      • Drawable.pointsize
      • Drawable.pointstyle
      • Drawable.polystyle
      • Drawable.print()
      • Drawable.str()
      • Drawable.thing2color()
  • yapcad.ezdxf_drawable module
    • ezdxfDraw
      • ezdxfDraw.display()
      • ezdxfDraw.draw_arc()
      • ezdxfDraw.draw_ellipse()
      • ezdxfDraw.draw_line()
      • ezdxfDraw.draw_text()
      • ezdxfDraw.filename
      • ezdxfDraw.linetype
  • yapcad.ezdxf_exporter module
    • is_2d_geometry()
    • write_dxf()
    • write_dxf_multi()
  • yapcad.fasteners_legacy module
    • HexCapScrewSpec
      • HexCapScrewSpec.diameter
      • HexCapScrewSpec.head_flat_diameter
      • HexCapScrewSpec.head_height
      • HexCapScrewSpec.shank_diameter
      • HexCapScrewSpec.shank_length
      • HexCapScrewSpec.starts
      • HexCapScrewSpec.thread_arc_samples
      • HexCapScrewSpec.thread_length
      • HexCapScrewSpec.thread_samples_per_pitch
      • HexCapScrewSpec.washer_diameter
      • HexCapScrewSpec.washer_thickness
    • HexNutSpec
      • HexNutSpec.diameter
      • HexNutSpec.handedness
      • HexNutSpec.pitch
      • HexNutSpec.starts
      • HexNutSpec.thickness
      • HexNutSpec.thread_arc_samples
      • HexNutSpec.thread_samples_per_pitch
      • HexNutSpec.width_flat
    • build_hex_cap_screw()
    • build_hex_nut()
    • metric_hex_cap_catalog()
    • metric_hex_cap_screw()
    • metric_hex_nut()
    • metric_hex_nut_catalog()
    • unified_hex_cap_catalog()
    • unified_hex_cap_screw()
    • unified_hex_nut()
    • unified_hex_nut_catalog()
  • yapcad.geom module
    • OVERVIEW
    • yapcad.geom geometric representations
      • constants
      • scalars
      • vectors
    • yapcad.geom simple (non-compound) figures
      • points
      • lines
      • arcs
    • yapcad.geom compound figures
      • polylines/polygons
      • geometry lists
    • COMPUTATIONAL GEOMETRY OPERATIONS
      • specialized computational geometry operations
    • add()
    • add4()
    • arc()
    • arcArcIntersectXY()
    • arcbbox()
    • arccenter()
    • arclength()
    • barycentricXY()
    • bbox()
    • bezier()
    • bspline()
    • catmullrom()
    • center()
    • circleCircleTangentsXY()
    • close()
    • cross()
    • dist()
    • dist4()
    • dot()
    • dot4()
    • ellipse()
    • ellipse_bbox()
    • ellipse_length()
    • ellipse_sample()
    • ellipse_tangent()
    • geomlistbbox()
    • homo()
    • hyperbola()
    • hyperbola_bbox()
    • hyperbola_length()
    • hyperbola_sample()
    • hyperbola_tangent()
    • intersectGeomListXY()
    • intersectSimplePolyXY()
    • intersectSimpleXY()
    • intersectXY()
    • isCardinalPlanar()
    • isInsideConvexPolyXY()
    • isInsideTriangleXY()
    • isXYPlanar()
    • isXZPlanar()
    • isYZPlanar()
    • isarc()
    • isbezier()
    • isbspline()
    • iscatmullrom()
    • iscircle()
    • isclosedgeomlist()
    • iscontinuousgeomlist()
    • isdirect()
    • isdirectlist()
    • isellipse()
    • isfullellipse()
    • isgeomlist()
    • isgeomlistXYPlanar()
    • isgoodnum()
    • ishyperbola()
    • isinsideXY()
    • isinsidearcXY()
    • isinsidebbox()
    • isinsidebbox2D()
    • isinsidegeomlistXY()
    • isinsidelineXY()
    • isinsidepointXY()
    • isinsidepolyXY()
    • isline()
    • isnurbs()
    • isparabola()
    • ispoint()
    • ispoly()
    • ispolygon()
    • ispolygonXY()
    • issimple()
    • istriangle()
    • isvect()
    • length()
    • line()
    • lineArcIntersectXY()
    • lineLineIntersectXY()
    • linePointXY()
    • linePointXYDist()
    • linebbox()
    • linecenter()
    • linelength()
    • mag()
    • mag4()
    • mirror()
    • mul()
    • mul4()
    • nurbs()
    • orthoXY()
    • parabola()
    • parabola_bbox()
    • parabola_length()
    • parabola_sample()
    • parabola_tangent()
    • point()
    • pointCircleTangentsXY()
    • pointbbox()
    • pointcenter()
    • pointlength()
    • poly()
    • polybbox()
    • polycenter()
    • polylength()
    • reverseGeomList()
    • rotate()
    • sample()
    • samplearc()
    • samplegeomlist()
    • sampleline()
    • samplepoint()
    • samplepoly()
    • scale()
    • scale3()
    • scale4()
    • segment()
    • segmentarc()
    • segmentgeomlist()
    • segmentline()
    • segmentpoly()
    • sub()
    • sub4()
    • transform()
    • translate()
    • unsample()
    • unsamplearc()
    • unsamplegeomlist()
    • unsampleline()
    • unsamplepoly()
    • vclose()
    • vect()
    • vstr()
  • yapcad.geom3d module
    • addTri2Surface()
    • bbox()
    • center()
    • issolid()
    • issolidclosed()
    • issurface()
    • linePlaneIntersect()
    • mirror()
    • mirrorsolid()
    • mirrorsurface()
    • normfunc()
    • poly2surface()
    • poly2surfaceXY()
    • reversesurface()
    • rotate()
    • rotatesolid()
    • rotatesurface()
    • scale()
    • scalesolid()
    • scalesurface()
    • signedFaceDistance()
    • signedPlaneDistance()
    • solid()
    • solid_boolean()
    • solidbbox()
    • solids_intersect()
    • surf2lines()
    • surface()
    • surfacearea()
    • surfacebbox()
    • translate()
    • translatesolid()
    • translatesurface()
    • tri2p0n()
    • triTriIntersect()
    • volumeof()
  • yapcad.geom3d_util module
    • adaptive_angr_from_radius()
    • adaptive_arc_segments()
    • addVertex()
    • circleSurface()
    • conic()
    • conic_tube()
    • contour()
    • dodecahedron()
    • extrude()
    • extrude_region2d()
    • helical_extrude()
    • linear_pattern_solid()
    • linear_pattern_surface()
    • loft()
    • makeIcoPoints()
    • makeLoftSolid()
    • makeRevolutionSolid()
    • makeRevolutionSurface()
    • makeRevolutionThetaSamplingSurface()
    • make_occ_helix()
    • oblate_spheroid()
    • prism()
    • radial_pattern_solid()
    • radial_pattern_surface()
    • rectangularPlane()
    • sphere()
    • sphere2cartesian()
    • sphereSurface()
    • spherical_shell()
    • stack_solids()
    • subdivide()
    • sweep_adaptive()
    • sweep_along_path()
    • sweep_profile_along_path()
    • tube()
  • yapcad.geom_util module
    • combineglist()
    • geomlist2poly()
    • geomlist2poly_components()
    • geomlist2poly_with_holes()
    • linear_pattern()
    • makeArcSpiral()
    • makeLineSpiral()
    • polarSampleArc()
    • radial_pattern()
    • randomArc()
    • randomCenterInBox()
    • randomPoints()
    • randomPoly()
    • triarea()
  • yapcad.geometry module
    • Overview
      • Why would I use yapcad.geometry vs. yapcad.geom
      • yapcad.geometry conveneince functions
    • Arc()
    • Figure()
    • Geometry
      • Geometry.bbox
      • Geometry.center
      • Geometry.closed
      • Geometry.continuous
      • Geometry.derived
      • Geometry.elem
      • Geometry.geom
      • Geometry.intersectXY()
      • Geometry.intersectable
      • Geometry.isclosed()
      • Geometry.iscontinuous()
      • Geometry.isderived()
      • Geometry.isinsideXY()
      • Geometry.isintersectable()
      • Geometry.issampleable()
      • Geometry.length
      • Geometry.mirror()
      • Geometry.rotate()
      • Geometry.sample()
      • Geometry.sampleable
      • Geometry.scale()
      • Geometry.segment()
      • Geometry.surface()
      • Geometry.transform()
      • Geometry.translate()
      • Geometry.unsample()
      • Geometry.update
    • Line()
    • Point()
  • yapcad.geometry_checks module
    • CheckResult
      • CheckResult.ok
      • CheckResult.warnings
    • faces_oriented()
    • is_closed_polygon()
    • surface_watertight()
  • yapcad.geometry_utils module
    • Triangle
      • Triangle.normal
      • Triangle.v0
      • Triangle.v1
      • Triangle.v2
    • orient_triangle()
    • to_point()
    • to_vec3()
    • to_vector()
    • triangle_area()
    • triangle_centroid()
    • triangle_is_degenerate()
    • triangle_normal()
    • triangles_from_mesh()
  • yapcad.mesh module
    • mesh_view()
  • yapcad.metadata module
    • ensure_solid_id()
    • ensure_surface_id()
    • get_solid_metadata()
    • get_surface_metadata()
    • set_solid_context()
    • set_solid_metadata()
    • set_surface_metadata()
    • set_surface_origin()
    • set_surface_units()
  • yapcad.native_brep module
    • ShellClosureError
    • SolidValidationError
    • TopologyGraph
      • TopologyGraph.add_edge()
      • TopologyGraph.add_face()
      • TopologyGraph.add_loop()
      • TopologyGraph.add_shell()
      • TopologyGraph.add_solid()
      • TopologyGraph.add_trim()
      • TopologyGraph.add_vertex()
      • TopologyGraph.compute_shell_closure()
      • TopologyGraph.edge_faces()
      • TopologyGraph.evaluate_edge()
      • TopologyGraph.face_edges()
      • TopologyGraph.get_edge()
      • TopologyGraph.get_face()
      • TopologyGraph.get_loop()
      • TopologyGraph.get_shell()
      • TopologyGraph.get_solid()
      • TopologyGraph.get_trim()
      • TopologyGraph.get_vertex()
      • TopologyGraph.invalidate_shell_octree()
      • TopologyGraph.shell_bbox()
      • TopologyGraph.shell_contains_point()
      • TopologyGraph.shell_edge_usage()
      • TopologyGraph.shell_octree()
      • TopologyGraph.shell_vertices()
      • TopologyGraph.shells_bboxes_overlap()
      • TopologyGraph.shells_intersect()
      • TopologyGraph.summary()
      • TopologyGraph.tessellate_shell()
      • TopologyGraph.transform()
      • TopologyGraph.validate_shell_closure()
      • TopologyGraph.validate_solid()
      • TopologyGraph.vertex_edges()
    • arc_edge()
    • attach_native_brep_to_solid()
    • brep_edge()
    • brep_face()
    • brep_loop()
    • brep_shell()
    • brep_solid()
    • brep_trim()
    • brep_vertex()
    • bspline_edge()
    • circle_edge()
    • clear_native_brep()
    • deserialize_topology_graph()
    • edge_curve_params()
    • edge_curve_type()
    • edge_id()
    • edge_vertices()
    • evaluate_edge_curve()
    • face_id()
    • face_loops()
    • face_surface()
    • has_native_brep()
    • is_brep_edge()
    • is_brep_face()
    • is_brep_loop()
    • is_brep_shell()
    • is_brep_solid_native()
    • is_brep_trim()
    • is_brep_vertex()
    • line_edge()
    • loop_id()
    • loop_trims()
    • loop_type()
    • mirror_native_brep()
    • native_brep_from_solid()
    • rotate_native_brep()
    • scale_native_brep()
    • serialize_topology_graph()
    • set_shell_closed()
    • set_vertex_location()
    • shell_closed()
    • shell_faces()
    • shell_id()
    • solid_id()
    • solid_shells()
    • transform_edge_params()
    • transform_topology_graph()
    • translate_native_brep()
    • trim_edge_id()
    • trim_id()
    • vertex_id()
    • vertex_location()
    • vertices_coincident()
  • yapcad.occ_native_convert module
    • native_brep_to_occ()
    • native_brep_to_occ_from_solid()
    • native_edge_to_occ()
    • native_face_to_occ()
    • native_loop_to_occ_wire()
    • native_surface_to_occ()
    • native_vertex_to_occ()
    • occ_available()
    • occ_edge_to_native()
    • occ_solid_to_native_brep()
    • occ_surface_to_native()
    • require_occ()
  • yapcad.octtree module
    • NTree
      • NTree.addElement()
      • NTree.depth
      • NTree.getElements()
      • NTree.maxdepth
      • NTree.mindim
      • NTree.updateCenter()
      • NTree.updateTree()
    • bbox2oct()
    • bbox2quad()
    • bboxdim()
    • box2boxes()
    • boxoverlap()
    • boxoverlap2()
    • untag()
  • yapcad.poly module
    • Circle()
    • Polygon
      • Polygon.addArc()
      • Polygon.addLine()
      • Polygon.addPoint()
      • Polygon.geom
      • Polygon.grow()
      • Polygon.remove()
      • Polygon.sample()
      • Polygon.setPoint()
      • Polygon.shrink()
    • Rect()
    • RoundRect()
    • cullZeroLength()
  • yapcad.pyglet_drawable module
    • GeomObject
    • Material
      • Material.ambient
      • Material.desc
      • Material.diffuse
      • Material.emission
      • Material.material
      • Material.shininess
      • Material.specular
    • pygletDraw
      • pygletDraw.addSurface()
      • pygletDraw.cameradist
      • pygletDraw.display()
      • pygletDraw.draw()
      • pygletDraw.draw_arc()
      • pygletDraw.draw_line()
      • pygletDraw.draw_linestrip()
      • pygletDraw.draw_point()
      • pygletDraw.draw_solid()
      • pygletDraw.draw_surface()
      • pygletDraw.draw_text()
      • pygletDraw.glSetup()
      • pygletDraw.magnify
      • pygletDraw.makeBatches()
      • pygletDraw.make_object()
      • pygletDraw.objectdict
      • pygletDraw.register_immediate()
      • pygletDraw.rx
      • pygletDraw.ry
      • pygletDraw.upbb()
      • pygletDraw.window()
    • vec()
  • yapcad.spline module
    • bezier_curve()
    • bezier_point()
    • bezier_tangent()
    • bspline_curve()
    • bspline_point()
    • bspline_tangent()
    • evaluate_bezier()
    • evaluate_bspline()
    • evaluate_catmullrom()
    • evaluate_nurbs()
    • is_bezier()
    • is_bspline()
    • is_catmullrom()
    • is_nurbs()
    • sample_bezier()
    • sample_bspline()
    • sample_catmullrom()
    • sample_nurbs()
  • yapcad.text3d module
    • calculate_text_height_for_width()
    • engrave_text()
    • find_system_font()
    • get_supported_characters()
    • text_on_surface()
    • text_solid()
    • text_solid_fitted()
    • text_to_polygons()
    • text_width()
    • validate_text_fit()
  • yapcad.threadgen module
    • ThreadProfile
      • ThreadProfile.D_nominal
      • ThreadProfile.P_pitch
      • ThreadProfile.crest_flat_ratio
      • ThreadProfile.handedness
      • ThreadProfile.internal
      • ThreadProfile.lead()
      • ThreadProfile.root_flat_ratio
      • ThreadProfile.starts
      • ThreadProfile.taper_ratio
      • ThreadProfile.thread_angle
      • ThreadProfile.thread_depth_ratio
    • metric_profile()
    • sample_thread_profile()
    • unified_profile()
  • yapcad.triangulator module
    • triangulate_polygon()
  • yapcad.xform module
    • Matrix
      • Matrix.get()
      • Matrix.getcol()
      • Matrix.getrow()
      • Matrix.mul()
      • Matrix.set()
      • Matrix.setcol()
      • Matrix.setrow()
    • Rotation()
    • Scale()
    • Translation()
  • Module contents