You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/learn/code/common/occt/shapes/wire/wire-helix-spirals.md
+54-4Lines changed: 54 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,6 +18,38 @@ import BitByBitRenderCanvas from '@site/src/components/BitByBitRenderCanvas';
18
18
19
19
# Creating Helix Wires
20
20
21
+
This tutorial demonstrates how to create three types of helical and spiral wire shapes using OpenCASCADE (OCCT). These curves are fundamental building blocks for modeling springs, threads, coils, and other spiral-based geometries.
22
+
23
+
## Types of Helix and Spiral Wires
24
+
25
+
### 1. Regular Helix Wire
26
+
A **helix** is a 3D curve that winds around an axis while rising at a constant rate. Think of a spring or a corkscrew. Key parameters include:
27
+
-**Radius**: The distance from the central axis to the helix curve
28
+
-**Pitch**: The vertical distance covered in one complete revolution (360°)
29
+
-**Height**: The total vertical extent of the helix
30
+
-**Direction**: The axis around which the helix winds (typically Y-up: `[0, 1, 0]`)
31
+
-**Clockwise**: Determines the winding direction when viewed from above
32
+
33
+
### 2. Flat Spiral Wire (Archimedean Spiral)
34
+
A **flat spiral** lies entirely in a plane and expands outward from a center point. This is useful for creating decorative patterns, clock springs, or spiral ramps. Key parameters include:
35
+
-**Start Radius**: The inner radius where the spiral begins
36
+
-**End Radius**: The outer radius where the spiral ends
37
+
-**Number of Turns**: How many complete rotations the spiral makes
38
+
-**Direction**: The normal vector of the plane containing the spiral
39
+
40
+
### 3. Tapered Helix Wire (Conical Helix)
41
+
A **tapered helix** combines the rising motion of a regular helix with a changing radius, creating a cone-shaped spiral. This is commonly used for conical springs or decorative elements. Key parameters include:
42
+
-**Start Radius**: The radius at the base of the cone
43
+
-**End Radius**: The radius at the top of the cone
44
+
-**Pitch** and **Height**: Same as a regular helix
45
+
46
+
## Example Overview
47
+
48
+
The interactive examples below create all three wire types positioned side by side:
49
+
-**Left (x = -8)**: A regular helix with radius 1, pitch 1, and height 5
50
+
-**Center (x = 0)**: A flat spiral expanding from radius 0.5 to 5 with 5 turns
51
+
-**Right (x = 8)**: A tapered helix narrowing from radius 2 to 0.5
title="Regular helix, tapered helix and flat spiral examples"
34
66
/>
35
67
</TabItem>
36
68
<TabItemvalue="typescript"label="TypeScript">
37
69
<BitByBitRenderCanvas
38
70
requireManualStart={true}
39
-
script={}
40
-
title="Bezier curves with different weight distributions"
71
+
script={{"script":"\n// Import DTOs for configuring helix and spiral wire operations\nconst { HelixWireDto, TaperedHelixWireDto, FlatSpiralWireDto } = Bit.Inputs.OCCT;\n// Import DTO for specifying drawing options\nconst { DrawOcctShapeSimpleOptions } = Bit.Inputs.Draw;\n\n// Destructure the bitbybit API to access OCCT wire creation module\nconst { wire } = bitbybit.occt.shapes;\n\n// Define an asynchronous function to execute the main logic\nconst start = async () => {\n\n // --- 1. Create Regular Helix Wire ---\n // A helix is a 3D spiral that rises along an axis\n const helixOptions = new HelixWireDto();\n helixOptions.radius = 1; // Radius of the helix\n helixOptions.pitch = 1; // Height per complete turn\n helixOptions.height = 5; // Total height of the helix\n helixOptions.center = [-8, 0, 0]; // Position it to the left\n helixOptions.direction = [0, 1, 0]; // Helix axis points up (Y direction)\n helixOptions.clockwise = false; // Counter-clockwise winding\n helixOptions.tolerance = 0.0001; // Approximation tolerance\n \n // Create the helix wire asynchronously\n const helixWire = await wire.createHelixWire(helixOptions);\n\n // --- 2. Create Flat Spiral Wire ---\n // A flat spiral lies in a plane and expands outward\n const flatSpiralOptions = new FlatSpiralWireDto();\n flatSpiralOptions.startRadius = 0.5; // Inner starting radius\n flatSpiralOptions.endRadius = 5; // Outer ending radius\n flatSpiralOptions.numTurns = 5; // Number of complete rotations\n flatSpiralOptions.center = [0, 0, 0]; // Centered at origin\n flatSpiralOptions.direction = [0, 1, 0]; // Normal to the spiral plane\n flatSpiralOptions.clockwise = false;\n flatSpiralOptions.tolerance = 0.0001;\n \n // Create the flat spiral wire\n const flatSpiralWire = await wire.createFlatSpiralWire(flatSpiralOptions);\n\n // --- 3. Create Tapered Helix Wire ---\n // A tapered helix has a varying radius (conical helix)\n const taperedHelixOptions = new TaperedHelixWireDto();\n taperedHelixOptions.startRadius = 2; // Larger radius at the bottom\n taperedHelixOptions.endRadius = 0.5; // Smaller radius at the top\n taperedHelixOptions.pitch = 1; // Height per complete turn\n taperedHelixOptions.height = 5; // Total height\n taperedHelixOptions.center = [8, 0, 0]; // Position it to the right\n taperedHelixOptions.direction = [0, 1, 0];\n taperedHelixOptions.clockwise = false;\n taperedHelixOptions.tolerance = 0.0001;\n \n // Create the tapered helix wire\n const taperedHelixWire = await wire.createTaperedHelixWire(taperedHelixOptions);\n\n // --- 4. Draw all three wires with different colors ---\n \n // Draw the regular helix in red\n const helixDrawOptions = new DrawOcctShapeSimpleOptions();\n helixDrawOptions.edgeColour = \"#ff0000\";\n helixDrawOptions.edgeWidth = 2;\n bitbybit.draw.drawAnyAsync({ entity: helixWire, options: helixDrawOptions });\n\n // Draw the flat spiral in green\n const spiralDrawOptions = new DrawOcctShapeSimpleOptions();\n spiralDrawOptions.edgeColour = \"#00ff00\";\n spiralDrawOptions.edgeWidth = 2;\n bitbybit.draw.drawAnyAsync({ entity: flatSpiralWire, options: spiralDrawOptions });\n\n // Draw the tapered helix in blue\n const taperedDrawOptions = new DrawOcctShapeSimpleOptions();\n taperedDrawOptions.edgeColour = \"#0000ff\";\n taperedDrawOptions.edgeWidth = 2;\n bitbybit.draw.drawAnyAsync({ entity: taperedHelixWire, options: taperedDrawOptions });\n\n}\n\n// Execute the main function\nstart();","type":"typescript"}}
72
+
title="Regular helix, tapered helix and flat spiral examples"
41
73
/>
42
74
</TabItem>
43
75
</Tabs>
76
+
77
+
## Practical Applications
78
+
79
+
These helix and spiral wires serve as the foundation for many real-world modeling scenarios:
80
+
81
+
-**Springs and Coils**: Use regular or tapered helixes as sweep paths to create compression springs, extension springs, or coil shapes
82
+
-**Threads and Screws**: Helixes can define the path for thread profiles when creating bolts, screws, or nuts
83
+
-**Spiral Staircases**: Flat spirals or helixes can guide the placement of steps in architectural designs
84
+
-**Decorative Elements**: Spirals add visual interest to jewelry, furniture, and artistic designs
85
+
-**Pipes and Tubing**: Sweep a circular profile along a helix to create coiled pipes or tubes
86
+
87
+
## Tips for Working with Helix Wires
88
+
89
+
1.**Tolerance Parameter**: Lower tolerance values create smoother curves but require more computation. The default `0.0001` provides a good balance for most use cases.
90
+
91
+
2.**Direction Vector**: The direction defines the axis of rotation. Use `[0, 1, 0]` for vertical helixes, `[1, 0, 0]` for horizontal ones along X, or any normalized vector for custom orientations.
92
+
93
+
3.**Combining with Other Operations**: These wires can be used with operations like `pipe`, `sweep`, or `loft` to create solid 3D shapes from the wire paths.
0 commit comments