build123d
latest
Introduction
Installation
Key Concepts (builder mode)
Key Concepts (algebra mode)
Introductory Examples
Tutorials
Objects
Operations
Builders
Joints
Assemblies
Tips, Best Practices and FAQ
Import/Export
Advanced Topics
Cheat Sheet
External Tools and Libraries
Builder Common API Reference
Direct API Reference
build123d
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
U
|
V
|
W
|
X
|
Y
|
Z
_
__abs__() (Vector method)
__add__() (Shape method)
(Vector method)
(Vertex method)
__and__() (Shape method)
(ShapeList method)
__copy__() (Axis method)
(Color method)
(Location method)
(Matrix method)
(Plane method)
(Shape method)
(Vector method)
__deepcopy__() (Axis method)
(Color method)
(Location method)
(Matrix method)
(Plane method)
(Shape method)
(Vector method)
__eq__() (Location method)
(Plane method)
(Shape method)
(Vector method)
__getitem__() (ShapeList method)
__gt__() (ShapeList method)
__hash__() (Shape method)
__lshift__() (ShapeList method)
__lt__() (ShapeList method)
__matmul__() (Curve method)
(Mixin1D method)
__mod__() (Curve method)
(Mixin1D method)
__mul__() (Location method)
(Plane method)
(Vector method)
__ne__() (Plane method)
__neg__() (Axis method)
(Face method)
(Location method)
(Plane method)
(Vector method)
__or__() (ShapeList method)
__pow__() (Location method)
__rmul__() (Shape method)
(Vector method)
__rshift__() (ShapeList method)
__sub__() (Shape method)
(ShapeList method)
(Vector method)
(Vertex method)
__truediv__() (Vector method)
A
A (Triangle attribute)
a (Triangle attribute)
ADD (Mode attribute)
add() (BoundBox method)
(in module operations_generic)
(Vector method)
add_code_to_metadata() (Mesher method)
add_meta_data() (Mesher method)
add_shape() (Mesher method)
Align (class in build_enums)
ALL (Select attribute)
angle_between() (Axis method)
apothem (RegularPolygon attribute)
ARC (Kind attribute)
arc_center (Edge property)
area (Shape property)
AREA (SortBy attribute)
Arrow (class in drafting)
ArrowHead (class in drafting)
Axis (class in geometry)
B
B (Triangle attribute)
b (Triangle attribute)
BallJoint (class in joints)
BaseLineObject (class in objects_curve)
BasePartObject (class in objects_part)
BaseSketchObject (class in objects_sketch)
Bezier (class in objects_curve)
BEZIER (GeomType attribute)
BOLD (FontStyle attribute)
BOTH (Keep attribute)
BOTTOM (Keep attribute)
BoundBox (class in geometry)
BOUNDING_BOX (CenterOf attribute)
bounding_box() (in module operations_generic)
(Shape method)
Box (class in objects_part)
BSPLINE (GeomType attribute)
build_enums
module
build_line
module
build_part
module
build_sketch
module
BuildLine (class in build_line)
BuildPart (class in build_part)
BuildSketch (class in build_sketch)
C
C (Triangle attribute)
c (Triangle attribute)
cast() (Shape class method)
CENTER (Align attribute)
center() (BoundBox method)
(Compound method)
(Face method)
(Mixin1D method)
(Mixin3D method)
(Shape method)
(Shell method)
(Vector method)
(Vertex method)
center_location (Face property)
CenterArc (class in objects_curve)
CenterOf (class in build_enums)
chamfer() (in module operations_generic)
(Mixin3D method)
chamfer_2d() (Face method)
(Wire method)
Circle (class in objects_sketch)
CIRCLE (GeomType attribute)
clean() (Shape method)
close() (Edge method)
(Wire method)
closest_points() (Shape method)
Color (class in geometry)
color (Shape property)
combine() (Wire class method)
combined_center() (Shape static method)
common_plane() (Mixin1D method)
Compound (class in topology)
compound() (Shape method)
(ShapeList method)
compounds() (Shape method)
(ShapeList method)
compute_mass() (Shape static method)
Cone (class in objects_part)
CONE (GeomType attribute)
connect_to() (BallJoint method)
(CylindricalJoint method)
(Joint method)
(LinearJoint method)
(RevoluteJoint method)
(RigidJoint method)
consolidate_edges() (BuildSketch method)
contains() (Plane method)
copy() (Shape method)
CounterBoreHole (class in objects_part)
CounterSinkHole (class in objects_part)
cross() (Vector method)
Curve (class in topology)
cut() (Compound method)
(Shape method)
Cylinder (class in objects_part)
CYLINDER (GeomType attribute)
CylindricalJoint (class in joints)
D
default() (LocationEncoder method)
diagonal (BoundBox property)
dimension (DimensionLine attribute)
(ExtensionLine attribute)
DimensionLine (class in drafting)
DISTANCE (SortBy attribute)
distance() (Shape method)
distance_to() (Shape method)
distance_to_plane() (Vector method)
distance_to_with_closest_points() (Shape method)
distances() (Shape method)
distribute_locations() (Edge method)
do_children_intersect() (Compound method)
dot() (Vector method)
DoubleTangentArc (class in objects_curve)
dprism() (Mixin3D method)
E
Edge (class in topology)
edge() (in module build_common)
(Shape method)
(ShapeList method)
edges() (Builder method)
(in module build_common)
(Shape method)
(ShapeList method)
Ellipse (class in objects_sketch)
ELLIPSE (GeomType attribute)
EllipticalCenterArc (class in objects_curve)
end_point() (Mixin1D method)
export_brep() (Shape method)
export_step() (Shape method)
export_stl() (Shape method)
exporters3d
module
ExtensionLine (class in drafting)
extrude() (in module operations_part)
(Shape class method)
extrude_linear_with_rotation() (Solid class method)
extrude_taper() (Solid class method)
extrude_until() (Solid class method)
EXTRUSION (GeomType attribute)
F
Face (class in topology)
face() (BuildLine method)
(in module build_common)
(Shape method)
(ShapeList method)
faces() (Builder method)
(BuildLine method)
(in module build_common)
(Shape method)
(ShapeList method)
faces_intersected_by_axis() (Shape method)
fillet() (in module operations_generic)
(Mixin3D method)
fillet_2d() (Face method)
(Wire method)
FilletPolyline (class in objects_curve)
filter_by() (ShapeList method)
filter_by_position() (ShapeList method)
find_intersection() (Plane method)
(Shape method)
find_outside_box_2d() (BoundBox static method)
find_tangent() (Edge method)
first (ShapeList property)
FIRST (Until attribute)
fix() (Shape method)
fix_degenerate_edges() (Wire method)
FontStyle (class in build_enums)
from_bounding_box() (Solid class method)
from_local_coords() (Plane method)
from_occt() (Axis class method)
full_round() (in module operations_sketch)
fuse() (Compound method)
(Shape method)
G
geom_type (Shape property)
geometry
module
GEOMETRY (CenterOf attribute)
geometry (Face property)
GeomType (class in build_enums)
get_angle() (Vector method)
get_mesh_properties() (Mesher method)
get_meta_data() (Mesher method)
get_meta_data_by_key() (Mesher method)
get_signed_angle() (Vector method)
get_topods_face_normal() (Plane static method)
get_type() (Compound method)
GridLocations (class in build_common)
group_by() (ShapeList method)
H
hash_code() (Shape method)
Helix (class in objects_curve)
HexLocations (class in build_common)
Hole (class in objects_part)
hollow() (Mixin3D method)
HYPERBOLA (GeomType attribute)
I
import_brep() (in module importers)
import_step() (in module importers)
import_stl() (in module importers)
import_svg() (in module importers)
import_svg_as_buildline_code() (in module importers)
importers
module
inner_wires() (Face method)
INTERSECT (Mode attribute)
intersect() (Compound method)
(Shape method)
IntersectingLine (class in objects_curve)
INTERSECTION (Kind attribute)
intersections() (Edge method)
inverse() (Location method)
(Matrix method)
is_closed (Mixin1D property)
is_coaxial() (Axis method)
is_coplanar() (Face method)
is_equal() (Shape method)
is_forward (Mixin1D property)
is_inside() (BoundBox method)
(Face method)
(Mixin3D method)
is_manifold (Shape property)
is_normal() (Axis method)
is_null() (Shape method)
is_opposite() (Axis method)
is_parallel() (Axis method)
is_same() (Shape method)
is_valid() (Shape method)
ITALIC (FontStyle attribute)
J
JernArc (class in objects_curve)
Joint (class in topology)
joints
module
K
Keep (class in build_enums)
Kind (class in build_enums)
L
LAST (Select attribute)
last (ShapeList property)
LAST (Until attribute)
length (Face property)
(Mixin1D property)
LENGTH (SortBy attribute)
length (Vector property)
library_version (Mesher property)
Line (class in objects_curve)
LINE (GeomType attribute)
LinearJoint (class in joints)
local_locations (GridLocations attribute)
(HexLocations attribute)
(Locations attribute)
(PolarLocations attribute)
locate() (Shape method)
located() (Axis method)
(Shape method)
location (Axis property)
(BuildPart property)
Location (class in geometry)
location (Plane property)
(Shape property)
location_at() (Mixin1D method)
location_between() (Plane method)
location_hook() (LocationEncoder static method)
LocationEncoder (class in geometry)
Locations (class in build_common)
locations() (Mixin1D method)
loft() (in module operations_part)
M
make_bezier() (Edge class method)
make_bezier_surface() (Face class method)
make_box() (Solid class method)
make_brake_formed() (in module operations_part)
make_circle() (Edge class method)
(Wire class method)
make_compound() (Compound class method)
make_cone() (Solid class method)
make_convex_hull() (Wire class method)
make_cylinder() (Solid class method)
make_ellipse() (Edge class method)
(Wire class method)
make_face() (in module operations_sketch)
make_from_wires() (Face class method)
make_helix() (Edge class method)
make_holes() (Face method)
make_hull() (in module operations_sketch)
make_line() (Edge class method)
make_loft() (Solid class method)
make_mid_way() (Edge class method)
make_plane() (Face class method)
make_polygon() (Wire class method)
make_rect() (Face class method)
(Wire class method)
make_shell() (Shell class method)
make_solid() (Solid class method)
make_sphere() (Solid class method)
make_spline() (Edge class method)
make_spline_approx() (Edge class method)
make_surface() (Face class method)
make_surface_from_array_of_points() (Face class method)
make_surface_from_curves() (Face class method)
make_tangent_arc() (Edge class method)
make_text() (Compound class method)
make_three_point_arc() (Edge class method)
make_torus() (Solid class method)
make_triad() (Compound class method)
make_wedge() (Solid class method)
make_wire() (Wire class method)
margin (TechnicalDrawing attribute)
MASS (CenterOf attribute)
Matrix (class in geometry)
MAX (Align attribute)
max (GridLocations attribute)
max_fillet() (Mixin3D method)
mesh() (Shape method)
mesh_count (Mesher property)
Mesher (class in mesher)
MIN (Align attribute)
min (GridLocations attribute)
mirror() (in module operations_generic)
(Shape method)
Mixin1D (class in topology)
Mixin3D (class in topology)
Mode (class in build_enums)
model_unit (Mesher property)
module
build_enums
build_line
build_part
build_sketch
exporters3d
geometry
importers
joints
objects_curve
objects_part
objects_sketch
topology
move() (Plane method)
(Shape method)
moved() (Shape method)
multiply() (Matrix method)
(Vector method)
N
NEW (Select attribute)
NEXT (Until attribute)
normal() (Mixin1D method)
normal_at() (Face method)
normalized() (Vector method)
O
objects_curve
module
objects_part
module
objects_sketch
module
OFFSET (GeomType attribute)
offset() (Face method)
(in module operations_generic)
(Plane method)
offset_2d() (Mixin1D method)
offset_3d() (Mixin3D method)
order_edges() (Wire method)
orientation (Location property)
(Shape property)
origin (Plane property)
OTHER (GeomType attribute)
outer_wire() (Face method)
P
page_sizes (TechnicalDrawing attribute)
PARABOLA (GeomType attribute)
param_at() (Mixin1D method)
param_at_point() (Edge method)
(Wire method)
Part (class in topology)
pending_edges_as_wire (BuildPart property)
perpendicular_line() (Mixin1D method)
Plane (class in geometry)
PLANE (GeomType attribute)
PolarLine (class in objects_curve)
PolarLocations (class in build_common)
Polygon (class in objects_sketch)
Polyline (class in objects_curve)
Pos (class in geometry)
position (Location property)
(Shape property)
position_at() (Face method)
(Mixin1D method)
positions() (Mixin1D method)
PREVIOUS (Until attribute)
PRIVATE (Mode attribute)
project() (in module operations_generic)
(Mixin1D method)
project_faces() (Shape method)
project_to_line() (Vector method)
project_to_plane() (Vector method)
project_to_shape() (Edge method)
(Face method)
(Wire method)
project_to_shape_alt() (Face method)
project_to_viewport() (Shape method)
project_workplane() (in module operations_part)
R
radius (Mixin1D property)
(RegularPolygon attribute)
RADIUS (SortBy attribute)
RadiusArc (class in objects_curve)
read() (Mesher method)
Rectangle (class in objects_sketch)
RectangleRounded (class in objects_sketch)
REGULAR (FontStyle attribute)
RegularPolygon (class in objects_sketch)
relative_to() (BallJoint method)
(CylindricalJoint method)
(Joint method)
(LinearJoint method)
(RevoluteJoint method)
(RigidJoint method)
relocate() (Shape method)
REPLACE (Mode attribute)
reverse() (Axis method)
(Plane method)
(Vector method)
reversed() (Edge method)
RevoluteJoint (class in joints)
REVOLUTION (GeomType attribute)
revolve() (in module operations_part)
(Solid class method)
RIGHT (Transition attribute)
RigidJoint (class in joints)
Rot (in module geometry)
rotate() (Matrix method)
(Shape method)
(Vector method)
rotated() (Plane method)
Rotation (class in geometry)
ROUND (Transition attribute)
S
SagittaArc (class in objects_curve)
scale() (in module operations_generic)
(Shape method)
section() (in module operations_part)
Select (class in build_enums)
sew_faces() (Face class method)
Shape (class in topology)
shape_type() (Shape method)
ShapeList (class in topology)
Shell (class in topology)
shell() (Shape method)
(ShapeList method)
shells() (Shape method)
(ShapeList method)
shift_origin() (Plane method)
show_topology() (Shape method)
signed_distance_from_plane() (Vector method)
size (GridLocations attribute)
sketch (BuildSketch property)
Sketch (class in topology)
SlotArc (class in objects_sketch)
SlotCenterPoint (class in objects_sketch)
SlotCenterToCenter (class in objects_sketch)
SlotOverall (class in objects_sketch)
Solid (class in topology)
solid() (BuildLine method)
(BuildSketch method)
(in module build_common)
(Shape method)
(ShapeList method)
solids() (Builder method)
(BuildLine method)
(BuildSketch method)
(in module build_common)
(Shape method)
(ShapeList method)
sort_by() (ShapeList method)
sort_by_distance() (ShapeList method)
SortBy (class in build_enums)
Sphere (class in objects_part)
SPHERE (GeomType attribute)
Spline (class in objects_curve)
split() (in module operations_generic)
(Shape method)
start_point() (Mixin1D method)
stitch() (Wire method)
sub() (Vector method)
SUBTRACT (Mode attribute)
sweep() (Face class method)
(in module operations_generic)
(Solid class method)
sweep_multi() (Solid class method)
symbol (BallJoint property)
(CylindricalJoint property)
(Joint property)
(LinearJoint property)
(RevoluteJoint property)
(RigidJoint property)
T
T (Location attribute)
TANGENT (Kind attribute)
tangent_angle_at() (Mixin1D method)
tangent_at() (Mixin1D method)
TangentArc (class in objects_curve)
TechnicalDrawing (class in drafting)
tessellate() (Shape method)
Text (class in objects_sketch)
thicken() (Face method)
(in module operations_part)
ThreePointArc (class in objects_curve)
to_align_offset() (BoundBox method)
to_arcs() (Shape method)
to_axis() (Edge method)
(Location method)
to_dir() (Vector method)
to_gp_ax2() (Plane method)
to_local_coords() (Plane method)
to_plane() (Axis method)
to_pnt() (Vector method)
to_splines() (Shape method)
to_tuple() (Color method)
(Location method)
(Vector method)
(Vertex method)
to_vtk_poly_data() (Shape method)
to_wire() (Edge method)
(Wire method)
TOP (Keep attribute)
topology
module
Torus (class in objects_part)
TORUS (GeomType attribute)
trace() (in module operations_sketch)
transform() (Vector method)
transform_geometry() (Shape method)
transform_shape() (Shape method)
TRANSFORMED (Transition attribute)
transformed() (Shape method)
Transition (class in build_enums)
translate() (Shape method)
transposed_list() (Matrix method)
Trapezoid (class in objects_sketch)
Triangle (class in objects_sketch)
triangle_counts (Mesher property)
trim() (Edge method)
(Wire method)
U
Until (class in build_enums)
V
Vector (class in geometry)
Vertex (class in topology)
vertex() (in module build_common)
(Shape method)
(ShapeList method)
vertex_counts (Mesher property)
vertices() (Builder method)
(in module build_common)
(Shape method)
(ShapeList method)
volume (Compound property)
(Face property)
(Mixin1D property)
(Shell property)
(Solid property)
VOLUME (SortBy attribute)
volume (Vertex property)
W
Wedge (class in objects_part)
width (Face property)
Wire (class in topology)
wire() (Face method)
(in module build_common)
(Shape method)
(ShapeList method)
wires() (Builder method)
(Curve method)
(in module build_common)
(Shape method)
(ShapeList method)
wrapped (Vector property)
write() (Mesher method)
X
X (Vector property)
x_axis (Location property)
Y
Y (Vector property)
y_axis (Location property)
Z
Z (Vector property)
z_axis (Location property)
Read the Docs
v: latest
Versions
latest
stable
Downloads
On Read the Docs
Project Home
Builds