Skip to main content

Module sketch

Module sketch 

Source
Expand description

The sketch target: PlacedSketch, a sketch and the plane it was placed on (SketchPlane) — the value of a sketch’s target (sketch) — and what it is to the steps that build on it: as a whole, its profile or a path (PlacedSketch, Path), its plane (Plane), and its points and curves, as what they are (Point, Line, Circle, Round, Curve). It is drawn into the viewport as itself (PlacedSketch::draw), and each of those is picked from what is drawn of it.

What a sketch’s curves are named after, when they are built into the model, is the sketch and its element ids: a sketch curve c3 of sketch K is K,c3, its ends K,p1 after the points there (see piece_names).

The step that draws a sketch is geop_ops_sketch’s; what reads one — an extrusion, a hole, a pattern — needs only this. figures draws the sketches examples and tests write down; fields are the building blocks of the forms of what is drawn in a sketch.

Modules§

fields
Building blocks of the forms of what is drawn in a sketch, here and in a 3-D sketch: a filled region, how a sketch’s constraints stand.
figures
Figures drawn into a sketch the way the examples and tests write them down: closed polygons, rectangles and circles, fully constrained where the figure says so, and a sketch solved once it is drawn; sketches of one figure, unconstrained, as a test draws a body’s outline; and the planes a test sketches on. Every number is design data (n).

Structs§

PlacedSketch
A sketch together with the plane it lies on: plane.u/plane.v are the sketch’s x/y (unit, orthogonal), plane.w = u x v its unit normal — and its name, the id of the step that drew it, which what is built from it is named after.
SketchDrawer
Draws a part’s sketches, each as the target it is, and lists them.

Enums§

SketchPlane
The plane a sketch is placed on: a flat face, a datum plane — the origin’s among them — or another sketch’s plane.

Functions§

chain_of_pieces
The pieces of a loop or a chain of the sketch sketch as a chain named after it and its elements (see piece_names).
piece_names
The names of the pieces of a sketch loop or chain, and of its joints: sketch,c3 for a piece and sketch,p2 for a joint. An open chain also names its end joint.
shape_profiles
The profiles of shape, one of the sketch name’s, its points at geometry: each region’s loops, its outer loop first and then its holes, one region after the other — or the one open chain — each named after the sketch and its elements (see chain_of_pieces).
sketch
The sketch name: what the step of that id draws.
sketch_element
The element element — a point p3 or a curve c3 — of the sketch name, as what K it is.
whole_sketch
The sketch name, read whole: what is swept.

Type Aliases§

Constraint
A sketch constraint as a program holds it.
CurveKind
A sketch curve’s kind as a program holds it.
Sketch
A sketch as a program holds it.
SketchRef
A sketch of the part, read whole: what is swept.