planex2d
About
Installation
Optional packages
API conventions
Chaining and copies
Reading the arguments
Points
Planes
Angles and units
Queries
Errors and warnings
How planex2d is tested
Tests written by hand
Agentic testing
Fuzz tests
Building and contributing
Requirements
Build
Tests
Contributing
How AI is used in this project
Development
Documentation
Testing
License and notices
Eigen 3.4.0
Licenses of the Eigen files planex2d compiles
pybind11
Taskflow 4.1.0
Libraries planex2d uses but does not include
Packages planex2d imports when they are installed
Data files under other licenses
Roadmap
Installation
Kernel
Sketch
Constraints
Measuring
OpenCASCADE
Files and integrations
Experimental
Core
Basics
Objects
Objects in planex2d
Lines and arcs
Splines
Wires and faces
Faces, shapes and compounds
In space
The plane in 3D
Moving, rotating, mirroring, scaling
Data
Names and colors
Units
Tolerances
3D
Pad and Pocket
Plotting
General
matplotlib
plotly
SVG
Marking edges
In 3D
Sketches
Sketch plots
Measurements and fields
Measurements
Fields
Everything at a glance
Quick sketch
Drawing
Sketch or QuickSketch
Lines and arcs
Circles and rectangles
Slots, keyholes and polygons
Splines
Several loops
References
To, from and until
Parallel, perpendicular, angle
Tangents
Arcs from references
Choosing between solutions
Construction elements and points
Automatic ids
Editing
Fillets and chamfers
Extending edges
Offsets
Trimming and splitting
Symmetry
Placement
Placing a sketch
Design
Parametric design
Everything at a glance
Constraint sketches
Constraining
Drawing with constraints
Converting sketches
Constraints and dimensions
Fully, under- and over-constrained
Changing the design
Changing dimensions
Expressions: design rules
Formulas: a dipstick for a tank
More geometry
Symmetry and patterns
Splines
Trim, split and project
Offsets and profiles revisited
Beyond drawings
Mechanisms: the sketch as a solver
Booleans
Two faces
Three operations
Union
Difference and intersection
Names are kept
Many faces at once
A perforated sheet
A Reuleaux triangle
A stress test
Faces and wires
A truss from its member center lines
Glued, the members stay separate
Overlapping stretches are kept once
Splitting and trimming
A segmented ring
Trimming a blank
Closed cutters punch holes
Wires
Cutters from 3D
The rules
Traces and pads
Check
Pads and drills
Everything at a glance
Measuring
Measurements
Areas, centroids and second moments
Boxes, crossings and open ends
Distances and clearances
Inside or outside
Dimensions in a sketch
Analysis
Part analysis
Everything at a glance
Files
DXF
A gasket drawing
Polylines with arcs
Units
Gaps
STEP and BREP
SVG
shapely
KiCad
gmsh
Defeaturing and simplification
Small gaps
A square that does not close
On export and when reading
Small edges
A step of 10⁻⁵
On export
Collinear lines
A bottom in four pieces
Fitting arcs
A measured bore
Tolerance
On export
Fitting splines
An ellipse from 128 segments
Arcs first
The steps, in order
Comparison with other libraries
Union of many discs
Union of traces
Merging split edges
Nearly coincident edges
Gluing many faces
Integrations
OpenCASCADE
Export
To OCC shapes
Export options
Splines as arcs
Modeling
A C-clamp, step by step
Sketching on and projecting 3D geometry
Lofting sections
Lofts with guide curves
Everything at a glance
netgen and NGSolve
Getting started
Coming from netgen's WorkPlane
Naming and marking
Identifications
Meshing and fields
Meshing a face
Fields and cuts
Solids and meshes in the webgui
Field solvers as measurements
From level sets
gmsh and FEniCSx
A minimal example
A trimmed resistor
The mesh
The resistance
Drawing the result
More
shapely
A minimal example
To shapely
Predicates and distances
From shapely and back to arcs
Line strings
SciPy
A minimal example
A dimension from a requirement
Optimizing a cold plate
Fitting a sketch to measured points
At a glance
In 3D
PyTorch
A minimal example
The plate and its two measurements
The baseline: COBYLA from the regular grid
40 layouts that fill the space
The surrogate
Search the model, solve the winners
Polish the winner
More
In 3D
KiCad
A minimal example
A real board
Both copper layers
What the board looks like
Copper per net
A clearance check
The board in 3D
Writing a board
Boards from other programs
NumPy
A minimal example
Arrays in
Arrays out
A million points at once
More
Examples
Machines and vehicles
Toy plane
Model rocket
Rear wing with DRS
Suspension kinematics
Excavator arm
Spur gears under load
Planetary gearbox
Wankel engine
Idler plate
Mechanisms
Four-bar linkage
Hood hinge
Jansen linkage
Straight-line linkages
Geneva drive
Cycloidal drive
Belt drives
Drilling a square hole
Physics
Isospectral drums
Boat stability
Flow through sand
Solar shading
Fields and simulation
Surface magnet motor
Heat sink
Hilbert heater
Parallelogram flexure
Vivaldi antenna
Patch antenna
Voronoi bone
Lens ray tracing
Airplane windows
Manufacturing
Gear cutting
Pocket milling
A slicer for 3D printing
Laser-cut box
Stencil lettering
Geometry and design
Penrose tiling
Rose window
Path planning
The moving sofa
Prince Rupert's cube
The coastline paradox
Drawing a logo
Experimental
Deformable shapes
Displacements and topology changes
Moving the hole up
What happens at a topology change
Results
Displacements from NGSolve
A harmonic extension
In motion
API
API reference
Geometry
Edges and wires
Faces, shapes and compounds
Planes
Sketches
Constraints and dimensions
References
Boolean operations and transformations
Selections and views
Files and other libraries
OpenCASCADE and netgen
Plotting
Measurements
Units, settings and warnings
Experimental
planex2d
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
|
X
|
Y
|
Z
A
Add() (Wire method)
Angle (in module planex)
angle (VertexView property)
approximation (CircleEdge property)
(SplineEdge property)
Arc() (in module planex)
(QuickSketch method)
(Sketch method)
(WorkPlane method)
ArcEdge (class in planex)
arcs (Face property)
(FaceView property)
(Shape property)
(Wire property)
ArcSlot() (QuickSketch method)
(Sketch method)
ArcTo() (WorkPlane method)
auto_constraint (Sketch property)
B
bounding_box (Compound property)
(DeformableShape property)
(EdgeView property)
(Face property)
(FaceView property)
(QuickSketch property)
(Shape property)
(Sketch property)
(Wire property)
bspline (SplineEdge property)
BSpline() (in module planex)
C
ccw (ArcEdge property)
(CircleEdge property)
center (ArcEdge property)
(CircleEdge property)
(EdgeView property)
(Face property)
(FaceView property)
(Selection property)
(Shape property)
(Wire property)
chain_start (QuickSketch property)
(Sketch property)
Chamfer() (Face method)
(FaceView method)
(QuickSketch method)
(Shape method)
(Sketch method)
(Wire method)
Chamfered() (Face method)
(FaceView method)
(Shape method)
(Wire method)
Circle() (in module planex)
(QuickSketch method)
(Sketch method)
(WorkPlane method)
CircleEdge (class in planex)
circles (Face property)
(FaceView property)
(Shape property)
(Wire property)
CircularPattern() (QuickSketch method)
(Sketch method)
Clean() (DeformableShape method)
Clearance() (in module planex.measurements)
Close() (QuickSketch method)
(Sketch method)
(WorkPlane method)
ClosedOpenWires() (in module planex)
CloseGaps() (Face method)
(FaceView method)
(Shape method)
(Wire method)
ClosestPoint() (Compound method)
(EdgeView method)
(Face method)
(FaceView method)
(Shape method)
(Wire method)
cm (in module planex)
Coincident (in module planex)
col (EdgesView property)
(EdgeView property)
(Face property)
(FacesView property)
(FaceView property)
(Selection property)
(Shape property)
(Wire property)
Commit() (DeformableShape method)
Compound (class in planex)
Concentric (in module planex)
condition (Sketch property)
config (class in planex)
Constrain() (Sketch method)
Constraint (class in planex)
constraints (Sketch property)
construction (Selection property)
Construction() (QuickSketch method)
(Sketch method)
Contains() (Compound method)
(Face method)
(FaceView method)
(Shape method)
Copy() (ArcEdge method)
(CircleEdge method)
(Compound method)
(DeformableShape method)
(EdgesView method)
(EdgeView method)
(Face method)
(FacesView method)
(FaceView method)
(LineEdge method)
(Plane method)
(QuickSketch method)
(Selection method)
(Shape method)
(Sketch method)
(SplineEdge method)
(Vertex method)
(VertexView method)
(VerticesView method)
(Wire method)
cur_dir (WorkPlane attribute)
(WorkPlane property)
cur_loc (WorkPlane attribute)
(WorkPlane property)
Cut() (ArcEdge method)
(LineEdge method)
D
default_sketch_type (config attribute)
Defeature() (DeformableShape method)
DeformableShape (class in planex)
Diameter (in module planex)
dimensions (Sketch property)
Direction() (QuickSketch method)
(Sketch method)
(WorkPlane method)
Distance (in module planex)
Distance() (Compound method)
(EdgeView method)
(Face method)
(FaceView method)
(Selection method)
(Shape method)
(VertexView method)
(Wire method)
dof (Sketch property)
E
Edge (class in planex)
edge (EdgeView property)
Edge() (QuickSketch method)
(Sketch method)
edges (Face property)
(FaceView property)
(Selection property)
(Shape property)
(Wire property)
EdgesView (class in planex)
EdgeView (class in planex)
elements (QuickSketch property)
(Sketch property)
Ellipse() (WorkPlane method)
end (ArcEdge property)
(CircleEdge property)
(EdgeView property)
(LineEdge property)
(SplineEdge property)
Equal (in module planex)
error_on_branch_change (Sketch property)
Expression() (Sketch method)
expressions (Sketch property)
F
Face (class in planex)
Face() (QuickSketch method)
(Shape method)
(Sketch method)
(Wire method)
(WorkPlane method)
faces (Face property)
(FaceView property)
(Selection property)
(Shape property)
(Wire property)
FacesView (class in planex)
FaceView (class in planex)
Fillet() (Face method)
(FaceView method)
(QuickSketch method)
(Shape method)
(Sketch method)
(Wire method)
Filleted() (Face method)
(FaceView method)
(Shape method)
(Wire method)
Find() (in module planex)
Finish() (QuickSketch method)
(Sketch method)
(WorkPlane method)
first (in module planex)
FitArcs() (Face method)
(FaceView method)
(Shape method)
(Wire method)
Fix (in module planex)
from_spline (ArcEdge property)
(LineEdge property)
FromDXF() (in module planex)
FromKiCad() (in module planex)
FromLevelSet() (in module planex)
FromNACA() (in module planex)
FromOCC() (in module planex)
FromPolyline() (in module planex)
FromShapely() (in module planex)
G
Geometry() (QuickSketch method)
(Sketch method)
GetTransformation() (in module planex)
Glue() (in module planex)
H
h (DeformableShape property)
H (in module planex)
h (Plane property)
(Vertex property)
(VertexView property)
Hausdorff() (EdgeView method)
(Face method)
(in module planex.measurements)
(Selection method)
(Shape method)
(Wire method)
Hexagon() (QuickSketch method)
(Sketch method)
Horizontal (in module planex)
hpref (EdgesView property)
(EdgeView property)
(Face property)
(FacesView property)
(FaceView property)
(Selection property)
(Shape property)
(VertexView property)
(VerticesView property)
(Wire property)
HydraulicDiameter() (in module planex.measurements)
I
id (Compound property)
(EdgeView property)
(Face property)
(FaceView property)
(QuickSketch property)
(Shape property)
(Sketch property)
(VertexView property)
(Wire property)
identifications (Face property)
(FaceView property)
(Shape property)
Identify() (Face method)
(FaceView method)
(Shape method)
ids (Selection property)
inch (in module planex)
inertia (Face property)
(FaceView property)
(Shape property)
(Wire property)
inner (Face property)
(FaceView property)
Intersect() (in module planex)
Intersect3d() (in module planex)
(QuickSketch method)
(Sketch method)
Intersections() (Face method)
(FaceView method)
(Wire method)
IsClosed() (Face method)
(FaceView method)
(Wire method)
IsValid() (DeformableShape method)
J
jacobian (Sketch property)
K
Keyhole() (QuickSketch method)
(Sketch method)
L
last (in module planex)
Last() (WorkPlane method)
layer (EdgesView property)
(EdgeView property)
(Face property)
(FacesView property)
(FaceView property)
(Selection property)
(Shape property)
(Wire property)
Line() (in module planex)
(QuickSketch method)
(Sketch method)
(WorkPlane method)
LinearPattern() (QuickSketch method)
(Sketch method)
LineEdge (class in planex)
lines (Face property)
(FaceView property)
(Shape property)
(Wire property)
LineTo() (WorkPlane method)
Location() (QuickSketch method)
(Sketch method)
locations (QuickSketch property)
(Sketch property)
M
m (in module planex)
mass (DeformableShape property)
(EdgeView property)
(Face property)
(FaceView property)
(Shape property)
(Wire property)
Max() (EdgesView method)
(FacesView method)
(Selection method)
(VerticesView method)
maxh (EdgesView property)
(EdgeView property)
(Face property)
(FacesView property)
(FaceView property)
(Selection property)
(Shape property)
(VertexView property)
(VerticesView property)
(Wire property)
MaxThickness() (in module planex.measurements)
Measure() (EdgeView method)
(Face method)
(FaceView method)
(QuickSketch method)
(Selection method)
(Shape method)
(Sketch method)
(Wire method)
measures (EdgeView property)
(Face property)
(FaceView property)
(QuickSketch property)
(Shape property)
(Sketch property)
(Wire property)
MergeCollinearEdges() (Face method)
(FaceView method)
(Shape method)
(Wire method)
midpoint (EdgeView property)
MidPoint() (ArcEdge method)
(CircleEdge method)
(LineEdge method)
(SplineEdge method)
mil (in module planex)
Min() (EdgesView method)
(FacesView method)
(Selection method)
(VerticesView method)
min_distance (DeformableShape property)
minh (EdgesView property)
(EdgeView property)
(Face property)
(FacesView property)
(FaceView property)
(Selection property)
(Shape property)
(Wire property)
MinThickness() (in module planex.measurements)
Mirror() (Compound method)
(Face method)
(FaceView method)
(QuickSketch method)
(Shape method)
(Sketch method)
(Wire method)
Mirrored() (Compound method)
(EdgeView method)
(Face method)
(FaceView method)
(Plane method)
(QuickSketch method)
(Shape method)
(Sketch method)
(Wire method)
mm (in module planex)
mode (Sketch property)
module
planex.measurements
Move() (in module planex)
(QuickSketch method)
(Sketch method)
(WorkPlane method)
MoveTo() (WorkPlane method)
N
name (EdgesView property)
(EdgeView property)
(Face property)
(FacesView property)
(FaceView property)
(Selection property)
(Shape property)
(VertexView property)
(VerticesView property)
(Wire property)
NameVertex() (WorkPlane method)
napprox (SplineEdge property)
normal (Plane property)
Normal() (Face method)
(FaceView method)
(QuickSketch method)
(Shape method)
(Sketch method)
(Wire method)
O
OCCGeometry() (in module planex)
Offset() (ArcEdge method)
(CircleEdge method)
(Face method)
(FaceView method)
(LineEdge method)
(Plane method)
(QuickSketch method)
(Shape method)
(Sketch method)
(SplineEdge method)
(Wire method)
(WorkPlane method)
OpenEnds() (Face method)
(FaceView method)
(Wire method)
origin (CircleEdge property)
(in module planex)
(Plane property)
(QuickSketch property)
(Sketch property)
outer (Face property)
(FaceView property)
outline (Selection property)
P
p (VertexView property)
Pad() (in module planex)
Parallel (in module planex)
partition (EdgesView property)
(EdgeView property)
(Selection property)
(Wire property)
pen (QuickSketch property)
(Sketch property)
Perpendicular (in module planex)
Plane (class in planex)
planex.measurements
module
PlanexWarning (class in planex)
Plot() (Compound method)
(DeformableShape method)
(Face method)
(FaceView method)
(in module planex)
(QuickSketch method)
(Shape method)
(Sketch method)
(Wire method)
(WorkPlane method)
Plot3d() (Compound method)
(Face method)
(FaceView method)
(in module planex)
(QuickSketch method)
(Shape method)
(Sketch method)
(Wire method)
PlotField() (in module planex)
PlotMesh() (in module planex)
Pocket() (in module planex)
PointAt() (EdgeView method)
points (QuickSketch property)
(Sketch property)
(SplineEdge property)
Polygon() (QuickSketch method)
(Sketch method)
Polylines() (Compound method)
(Face method)
(FaceView method)
(QuickSketch method)
(Shape method)
(Sketch method)
(Wire method)
Project() (Face method)
(FaceView method)
(in module planex)
(QuickSketch method)
(Shape method)
(Sketch method)
(Wire method)
Q
quad_dominated (Face property)
(FacesView property)
(FaceView property)
(Selection property)
(Shape property)
QuickSketch (class in planex)
R
radius (ArcEdge property)
(CircleEdge property)
Radius (in module planex)
radius (VertexView property)
Rectangle() (QuickSketch method)
(Sketch method)
(WorkPlane method)
RectangleC() (QuickSketch method)
(Sketch method)
(WorkPlane method)
redundant (Sketch property)
ReferenceVertices() (DeformableShape method)
Refine() (DeformableShape method)
Remove() (QuickSketch method)
(Sketch method)
RemoveExpression() (Sketch method)
RemoveIdentification() (Face method)
(FaceView method)
(Shape method)
RemoveMeasure() (EdgeView method)
(Face method)
(FaceView method)
(QuickSketch method)
(Shape method)
(Sketch method)
(Wire method)
RemoveSmallEdges() (Face method)
(FaceView method)
(Shape method)
(Wire method)
ResetIdCounters() (in module planex)
Reverse() (WorkPlane method)
RigidGroup (in module planex)
RigidGroup() (Sketch method)
RingSizes() (DeformableShape method)
Rotate() (Compound method)
(Face method)
(FaceView method)
(QuickSketch method)
(Shape method)
(Sketch method)
(Wire method)
(WorkPlane method)
Rotated() (Compound method)
(EdgeView method)
(Face method)
(FaceView method)
(Plane method)
(QuickSketch method)
(Shape method)
(Sketch method)
(Wire method)
Rotation() (in module planex)
S
Sample() (EdgeView method)
(SplineEdge method)
Scale() (Compound method)
(Face method)
(FaceView method)
(QuickSketch method)
(Shape method)
(Sketch method)
(Wire method)
Scaled() (Compound method)
(EdgeView method)
(Face method)
(FaceView method)
(QuickSketch method)
(Shape method)
(Sketch method)
(Wire method)
Selection (class in planex)
SetDeformation() (DeformableShape method)
SetOrigin() (QuickSketch method)
(Sketch method)
Shape (class in planex)
Shape() (DeformableShape method)
(QuickSketch method)
(Sketch method)
Simplified() (Face method)
(FaceView method)
(Shape method)
(Wire method)
Simplify() (Face method)
(FaceView method)
(Shape method)
(Wire method)
Sketch (class in planex)
sketch (WorkPlane attribute)
(WorkPlane property)
Slot() (QuickSketch method)
(Sketch method)
SmallEdges() (Face method)
(FaceView method)
(Wire method)
Sorted() (EdgesView method)
(FacesView method)
(Selection method)
(VerticesView method)
Spline() (in module planex)
(QuickSketch method)
(Sketch method)
(WorkPlane method)
SplineEdge (class in planex)
splines (Face property)
(FaceView property)
(Shape property)
(Wire property)
Split() (Face method)
(FaceView method)
(QuickSketch method)
(Shape method)
(Sketch method)
(Wire method)
start (ArcEdge property)
(CircleEdge property)
(EdgeView property)
(LineEdge property)
(SplineEdge property)
start_pnt (WorkPlane attribute)
(WorkPlane property)
status (Sketch property)
Subtract() (in module planex)
sweep (ArcEdge property)
Symmetric (in module planex)
SymmetricCarriers (in module planex)
SymmetryLine() (QuickSketch method)
(Sketch method)
T
Tangent (in module planex)
Tangent() (ArcEdge method)
(CircleEdge method)
(LineEdge method)
(SplineEdge method)
TangentAt() (EdgeView method)
ToHV() (Face method)
(FaceView method)
(Plane method)
(QuickSketch method)
(Shape method)
(Sketch method)
(Wire method)
ToOCCAxes() (Plane method)
ToOCCFace() (Face method)
(FaceView method)
(QuickSketch method)
(Shape method)
(Sketch method)
(Wire method)
(WorkPlane method)
ToOCCShape() (Compound method)
(Face method)
(FaceView method)
(QuickSketch method)
(Shape method)
(Sketch method)
(Wire method)
(WorkPlane method)
ToOCCWire() (Face method)
(FaceView method)
(QuickSketch method)
(Sketch method)
(Wire method)
(WorkPlane method)
ToOCCWires() (Face method)
(FaceView method)
(QuickSketch method)
(Shape method)
(Sketch method)
(Wire method)
(WorkPlane method)
ToPolyline() (Wire method)
TorsionConstant() (in module planex.measurements)
ToShapely() (Compound method)
(Face method)
(FaceView method)
(in module planex)
(QuickSketch method)
(Shape method)
(Sketch method)
(Wire method)
ToSVG() (Compound method)
(DeformableShape method)
(Face method)
(FaceView method)
(in module planex)
(QuickSketch method)
(Shape method)
(Sketch method)
(Wire method)
ToXYZ() (Face method)
(FaceView method)
(Plane method)
(QuickSketch method)
(Shape method)
(Sketch method)
(Wire method)
Translate() (Compound method)
(Face method)
(FaceView method)
(QuickSketch method)
(Shape method)
(Sketch method)
(Wire method)
Translated() (Compound method)
(EdgeView method)
(Face method)
(FaceView method)
(Plane method)
(QuickSketch method)
(Shape method)
(Sketch method)
(Wire method)
Translation() (in module planex)
Trim() (Face method)
(FaceView method)
(QuickSketch method)
(Shape method)
(Sketch method)
(Wire method)
Turn() (QuickSketch method)
(Sketch method)
U
um (in module planex)
Unify() (in module planex)
Update() (Sketch method)
V
V (in module planex)
v (Plane property)
(Vertex property)
(VertexView property)
Vertex (class in planex)
Vertex() (QuickSketch method)
(Sketch method)
VertexNames() (DeformableShape method)
VertexView (class in planex)
Vertical (in module planex)
vertices (Face property)
(FaceView property)
(Shape property)
(Wire property)
Vertices() (DeformableShape method)
VerticesView (class in planex)
W
Wire (class in planex)
Wire() (EdgeView method)
(Face method)
(FaceView method)
(QuickSketch method)
(Selection method)
(Shape method)
(Sketch method)
(WorkPlane method)
wires (Face property)
(FaceView property)
(QuickSketch property)
(Shape property)
(Sketch property)
(Wire property)
Wires() (DeformableShape method)
(in module planex)
(QuickSketch method)
(Sketch method)
(WorkPlane method)
WorkPlane (class in planex)
WriteBrep() (Compound method)
(Face method)
(FaceView method)
(in module planex)
(QuickSketch method)
(Shape method)
(Sketch method)
(Wire method)
WriteDXF() (Compound method)
(Face method)
(FaceView method)
(in module planex)
(QuickSketch method)
(Shape method)
(Sketch method)
(Wire method)
WriteGeo() (Compound method)
(Face method)
(FaceView method)
(in module planex)
(QuickSketch method)
(Shape method)
(Sketch method)
(Wire method)
WriteKiCad() (in module planex)
WriteStep() (Compound method)
(Face method)
(FaceView method)
(in module planex)
(QuickSketch method)
(Shape method)
(Sketch method)
(Wire method)
X
x (Vertex property)
(VertexView property)
XY (in module planex)
Y
y (Vertex property)
(VertexView property)
YZ (in module planex)
Z
z (VertexView property)
ZX (in module planex)