Skip to content

Commit 0303bea

Browse files
authored
Trailcode/Enhance Usage Guide Documentation for Sketch Tools (#21)
* Improve usage guide * Draw rectangles and squares update * Doc Add arc segments * Update slot tool usage doc
1 parent bc56087 commit 0303bea

1 file changed

Lines changed: 272 additions & 4 deletions

File tree

usage.md

Lines changed: 272 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -92,11 +92,11 @@ EzyCad (Easy CAD) is a CAD application for hobbyist machinists to design and edi
9292
1. **Basic Tools**
9393
- Add nodes
9494
- [Create line edges](#line-edge-creation-tools) ![Line Edge Tool](icons/Sketcher_Element_Line_Edge.png)
95-
- Draw multi-line edges
96-
- Add arc segments
95+
- [Draw multi-line edges](#multi-line-edge-tool) ![Multi-line Edge Tool](icons/ls.png)
96+
- [Add arc segments](#arc-segment-creation-tool) ![Arc Segment Tool](icons/Sketcher_Element_Arc_Edge.png)
9797
- [Create circles](#circle-creation-tools) ![Circle Tool](icons/Sketcher_CreateCircle.png)
98-
- Draw rectangles and squares
99-
- Add slots
98+
- [Draw rectangles and squares](#rectangle-and-square-creation-tools) ![Rectangle Tool](icons/Sketcher_CreateRectangle.png) ![Square Tool](icons/Sketcher_CreateSquare.png)
99+
- [Add slots](#slot-creation-tool) ![Slot Tool](icons/Sketcher_CreateSlot.png)
100100

101101
2. **Sketch Operations**
102102
- [Define operation axis](#operation-axis-tool) ![Operation Axis Tool](icons/Sketcher_MirrorSketch.png)
@@ -138,6 +138,54 @@ The single line edge tool allows you to create straight line segments between tw
138138
- The line tool works in any sketch plane
139139
- Multiple line edges can be created in sequence by right-clicking after each line
140140

141+
#### Multi-Line Edge Tool
142+
143+
![Multi-line Edge Tool](icons/ls.png)
144+
145+
The multi-line edge tool allows you to create multiple connected line segments in a single operation, making it efficient for drawing continuous paths, polylines, or complex connected geometries.
146+
147+
**Features:**
148+
- **Continuous edge creation**: Click multiple points to create a chain of connected line segments
149+
- **Real-time preview**: See each edge shape while moving the mouse before clicking
150+
- **Precise length control**: Use the distance input dialog (Tab key) for exact edge lengths
151+
- **Snap support**: Automatically snaps to existing nodes and geometry
152+
- **Distance annotations**: Real-time distance display for the current edge being drawn
153+
- **Flexible finalization**: Continue adding edges until you right-click to finalize the entire sequence
154+
155+
**How to use:**
156+
1. Select the **Multi-line Edge** tool from the toolbar ![ls](icons/ls.png)
157+
2. Click to set the first point (start of the first edge)
158+
3. Move the mouse to see a preview of the first edge
159+
4. Click to set the second point (end of first edge, start of second edge), or press **Tab** to enter an exact length value
160+
5. Continue clicking to add more connected edges, each new click starts a new edge from the previous edge's end point
161+
6. Press **Right-click** to finalize the entire multi-line sequence and add all edges to your sketch
162+
163+
**Keyboard shortcuts:**
164+
- **Tab**: Open distance input dialog for precise length control of the current edge
165+
- **Escape**: Cancel the entire multi-line creation operation
166+
- **Enter**: Finalize the current edge length (if using distance input) and continue to the next edge
167+
- **Right-click**: Finalize the entire multi-line sequence and complete the operation
168+
169+
**Workflow details:**
170+
- Each click after the first creates a new edge connected to the previous edge's end point
171+
- After entering a distance with Tab, the tool automatically starts a new edge from the end of the previous one
172+
- The distance annotation shows the length of the edge currently being drawn
173+
- All edges in the sequence are added to the sketch together when you right-click to finalize
174+
175+
**Tips:**
176+
- Use the snap feature to create multi-line edges that connect precisely to existing geometry
177+
- Multi-line edges are ideal for creating continuous paths, outlines, or complex connected shapes
178+
- The tool works in any sketch plane
179+
- Keep clicking to add more edges - there's no limit. For example, you can click 3 times to create 2 edges, or 10 times to create 9 edges. All edges remain temporary until you right-click, which adds all of them to your sketch at once
180+
- If you make a mistake, press Escape to cancel the entire sequence and start over
181+
- The last edge in the sequence will be removed if it hasn't been finalized (no end point set) when you right-click
182+
183+
**Comparison with Single Line Edge Tool:**
184+
- **Single Line Edge**: Creates one edge at a time, finalizes automatically after two points
185+
- **Multi-Line Edge**: Creates multiple connected edges in sequence, requires right-click to finalize
186+
- Use single line edges when you need individual disconnected segments
187+
- Use multi-line edges when you need a continuous chain of connected segments
188+
141189
#### Circle Creation Tools
142190

143191
EzyCad provides a method for creating circles in sketch mode using the **center-radius approach**.
@@ -205,6 +253,226 @@ The circle tool follows this workflow:
205253
- **Invalid Geometry**: Circles that would be too small are rejected
206254
- **Snap Integration**: Use existing snap points for precise circle placement
207255

256+
#### Arc Segment Creation Tool
257+
258+
![Arc Segment Tool](icons/Sketcher_Element_Arc_Edge.png)
259+
260+
The arc segment tool allows you to create circular arc edges by defining three points that lie on the arc: a start point, a middle point, and an end point.
261+
262+
**Features:**
263+
- **Three-point creation**: Click to set the start point, then the middle point, then the end point
264+
- **Real-time preview**: See the arc shape while moving the mouse after setting the first two points
265+
- **Automatic finalization**: The arc is automatically created and added to your sketch after the third point is clicked
266+
- **Circular arc**: Creates a smooth circular arc that passes through all three points
267+
- **Snap support**: Automatically snaps to existing nodes and geometry
268+
- **Unique points**: All three points must be different (cannot be coincident)
269+
270+
**How to use:**
271+
1. Select the **Arc Segment** tool from the toolbar ![Sketcher_Element_Arc_Edge](icons/Sketcher_Element_Arc_Edge.png)
272+
2. Click to set the start point of the arc (first point)
273+
3. Click to set a point on the arc between start and end (middle point)
274+
4. Move the mouse to see a preview of the arc
275+
5. Click to set the end point of the arc (third point)
276+
6. The arc segment will be automatically created and added to your sketch
277+
278+
**Point order:**
279+
- **First click**: Start point - where the arc begins
280+
- **Second click**: Middle point - a point that lies on the arc between start and end
281+
- **Third click**: End point - where the arc ends
282+
283+
**Keyboard shortcuts:**
284+
- **Escape**: Cancel the current arc creation (clears all points)
285+
- **Note**: The arc is automatically finalized after the third point, so no manual finalization is needed
286+
287+
**Tips:**
288+
- The three points define a unique circular arc that passes through all of them
289+
- Use the snap feature to create arcs that connect precisely to existing geometry
290+
- The arc tool works in any sketch plane
291+
- Arc segments can be used as part of closed shapes that form faces
292+
- The middle point helps define the arc's curvature and direction
293+
- All three points must be unique - clicking the same point twice will be ignored
294+
295+
**Technical details:**
296+
- The arc is created using the three points to define a circle, then trimming it to the arc segment
297+
- Internally, the arc is represented as two connected edges for proper topology
298+
- Arc segments can be combined with straight edges to create complex closed shapes
299+
300+
**Comparison with Circle Tool:**
301+
- **Circle Tool**: Creates a full circle from center and radius point (2 points)
302+
- **Arc Segment Tool**: Creates a partial arc from three points on the arc (3 points)
303+
- Use circles when you need a complete circular shape
304+
- Use arc segments when you need a curved edge that's part of a larger shape
305+
306+
#### Rectangle and Square Creation Tools
307+
308+
EzyCad provides three tools for creating rectangular shapes in sketch mode: square, rectangle from two points, and rectangle with center point.
309+
310+
##### Square Tool
311+
312+
![Square Tool](icons/Sketcher_CreateSquare.png)
313+
314+
The square tool allows you to create perfect squares by defining a center point and an edge midpoint.
315+
316+
**Features:**
317+
- **Two-point creation**: Click to set the center point, then click to set the midpoint of one edge
318+
- **Real-time preview**: See the square shape while moving the mouse
319+
- **Perfect square**: Automatically ensures all sides are equal length
320+
- **Orientation control**: The square's orientation is determined by the direction from center to edge midpoint
321+
- **Precise size control**: Use the distance input dialog (Tab key) for exact side lengths
322+
- **Snap support**: Automatically snaps to existing nodes and geometry
323+
324+
**How to use:**
325+
1. Select the **Square** tool from the toolbar ![Sketcher_CreateSquare](icons/Sketcher_CreateSquare.png)
326+
2. Click to set the center point of the square
327+
3. Move the mouse to see a preview of the square
328+
4. Click to set the midpoint of one edge (this defines both the size and orientation), or press **Tab** to enter an exact side length value
329+
5. The square will be created with four edges and added to your sketch
330+
331+
**Keyboard shortcuts:**
332+
- **Tab**: Open distance input dialog for precise side length control
333+
- **Escape**: Cancel the current square creation
334+
- **Enter**: Finalize the square (if using distance input)
335+
336+
**Tips:**
337+
- The distance from center to edge midpoint determines half the side length
338+
- Use the snap feature to create squares that are precisely positioned relative to existing geometry
339+
- The square tool works in any sketch plane
340+
- Squares automatically form closed faces that can be extruded
341+
342+
##### Rectangle Tool (Two Points)
343+
344+
![Rectangle Tool](icons/Sketcher_CreateRectangle.png)
345+
346+
The rectangle tool allows you to create rectangles by defining two opposite corners.
347+
348+
**Features:**
349+
- **Two-point creation**: Click to set the first corner, then click to set the opposite corner
350+
- **Real-time preview**: See the rectangle shape while moving the mouse
351+
- **Precise size control**: Use the distance input dialog (Tab key) for exact dimensions
352+
- **Snap support**: Automatically snaps to existing nodes and geometry
353+
- **Automatic corner calculation**: The system automatically calculates the other two corners
354+
355+
**How to use:**
356+
1. Select the **Rectangle** tool from the toolbar ![Sketcher_CreateRectangle](icons/Sketcher_CreateRectangle.png)
357+
2. Click to set the first corner point
358+
3. Move the mouse to see a preview of the rectangle
359+
4. Click to set the opposite corner point, or press **Tab** to enter exact distance values
360+
5. The rectangle will be created with four edges and added to your sketch
361+
362+
**Keyboard shortcuts:**
363+
- **Tab**: Open distance input dialog for precise dimension control
364+
- **Escape**: Cancel the current rectangle creation
365+
- **Enter**: Finalize the rectangle (if using distance input)
366+
367+
**Tips:**
368+
- The two points define opposite corners of the rectangle (diagonal)
369+
- The rectangle edges are automatically aligned with the coordinate axes
370+
- Use the snap feature to create rectangles that are precisely positioned relative to existing geometry
371+
- The rectangle tool works in any sketch plane
372+
- Rectangles automatically form closed faces that can be extruded
373+
374+
##### Rectangle Tool (Center Point)
375+
376+
![Rectangle Center Tool](icons/Sketcher_CreateRectangle_Center.png)
377+
378+
The rectangle with center point tool allows you to create rectangles by defining a center point and a corner point.
379+
380+
**Features:**
381+
- **Two-point creation**: Click to set the center point, then click to set a corner point
382+
- **Real-time preview**: See the rectangle shape while moving the mouse
383+
- **Centered creation**: The rectangle is centered on the first point
384+
- **Precise size control**: Use the distance input dialog (Tab key) for exact dimensions
385+
- **Snap support**: Automatically snaps to existing nodes and geometry
386+
387+
**How to use:**
388+
1. Select the **Rectangle with Center Point** tool from the toolbar ![Sketcher_CreateRectangle_Center](icons/Sketcher_CreateRectangle_Center.png)
389+
2. Click to set the center point of the rectangle
390+
3. Move the mouse to see a preview of the rectangle
391+
4. Click to set a corner point (defines both size and orientation), or press **Tab** to enter exact distance values
392+
5. The rectangle will be created with four edges and added to your sketch
393+
394+
**Keyboard shortcuts:**
395+
- **Tab**: Open distance input dialog for precise dimension control
396+
- **Escape**: Cancel the current rectangle creation
397+
- **Enter**: Finalize the rectangle (if using distance input)
398+
399+
**Tips:**
400+
- The rectangle is centered on the first point you click
401+
- The distance from center to corner determines the rectangle's dimensions
402+
- Use the snap feature to create rectangles that are precisely positioned relative to existing geometry
403+
- The rectangle tool works in any sketch plane
404+
- Rectangles automatically form closed faces that can be extruded
405+
406+
**Comparison of Rectangle Tools:**
407+
- **Rectangle (Two Points)**: Define opposite corners - useful when you know the corner positions
408+
- **Rectangle (Center Point)**: Define center and corner - useful when you want the rectangle centered on a specific point
409+
- **Square**: Always creates a perfect square - use when you need equal sides
410+
411+
#### Slot Creation Tool
412+
413+
![Slot Tool](icons/Sketcher_CreateSlot.png)
414+
415+
The slot tool allows you to create an oblong or oval-shaped slot with rounded ends. A slot consists of two semicircular arcs connected by two straight parallel edges.
416+
417+
**Features:**
418+
- **Three-point creation**: Click to set the first arc center, then the second arc center, then a point to define the radius
419+
- **Real-time preview**: See the slot shape while moving the mouse after setting the first two points
420+
- **Automatic finalization**: The slot is automatically created and added to your sketch after the third point is clicked
421+
- **Rounded ends**: Creates semicircular arcs at both ends with equal radius
422+
- **Parallel edges**: The two straight edges connecting the arcs are always parallel
423+
- **Precise size control**: Use the distance input dialog (Tab key) for exact dimensions
424+
- **Snap support**: Automatically snaps to existing nodes and geometry
425+
426+
**How to use:**
427+
1. Select the **Slot** tool from the toolbar ![Sketcher_CreateSlot](icons/Sketcher_CreateSlot.png)
428+
2. Click to set the center point of the first arc (start of slot)
429+
3. Move the mouse to see a preview of the first edge
430+
4. Click to set the center point of the second arc (end of slot)
431+
5. Move the mouse to see a preview of the slot shape
432+
6. Click to set a point that defines the radius of the arcs, or press **Tab** to enter exact distance values
433+
- **Important**: The radius is measured from the second arc center (the point you clicked in step 4) to this third point
434+
- This radius determines the cross section: the slot's cross-section dimension equals 2 × radius
435+
7. The slot will be automatically created with two arcs and two straight edges and added to your sketch
436+
437+
**Point order:**
438+
- **First click**: First arc center - the center of the arc at one end of the slot
439+
- **Second click**: Second arc center - the center of the arc at the other end of the slot
440+
- **Third click**: Radius point - defines the radius of both arcs
441+
- The distance from the **second arc center** (second click) to this point determines the arc radius
442+
- The slot's cross section (perpendicular to the slot length) equals twice this radius
443+
- Both arcs use the same radius, creating a symmetric slot
444+
445+
**Keyboard shortcuts:**
446+
- **Tab**: Open distance input dialog for precise dimension control
447+
- **Escape**: Cancel the current slot creation
448+
- **Enter**: Finalize the slot (if using distance input)
449+
- **Note**: The slot is automatically finalized after the third point, so no manual finalization is needed
450+
451+
**Tips:**
452+
- The slot length is determined by the distance between the first and second arc centers
453+
- The radius of both arcs is determined by the distance from the second arc center to the radius point (third click)
454+
- The slot's cross section (the dimension perpendicular to the slot length) equals 2 × radius
455+
- This is because each arc is a semicircle with the specified radius, extending equally in both perpendicular directions
456+
- For example, if you click the radius point 3 units away from the second arc center, the slot cross section will be 6 units
457+
- Both arcs have the same radius, creating a symmetric slot shape
458+
- The slot orientation (which dimension is length vs width/height) is determined by the direction from the first to the second arc center
459+
- Use the snap feature to create slots that connect precisely to existing geometry
460+
- The slot tool works in any sketch plane
461+
- Slots automatically form closed faces that can be extruded
462+
- The slot orientation is determined by the direction from the first to the second arc center
463+
464+
**Technical details:**
465+
- The slot consists of four edges: two semicircular arcs and two straight parallel edges
466+
- The arcs are created using the arc segment functionality
467+
- The straight edges connect the arcs at their endpoints
468+
- The slot forms a closed shape suitable for face creation and extrusion
469+
470+
**Common use cases:**
471+
- Creating mounting slots for screws or bolts
472+
- Designing elongated holes for adjustment
473+
- Creating rounded-end cutouts in parts
474+
- Designing slots for sliding mechanisms
475+
208476
#### Operation Axis Tool
209477

210478
The operation axis tool allows you to define a reference line for mirroring and revolving operations in sketches.

0 commit comments

Comments
 (0)