Skip to content

Commit eb9834c

Browse files
Finalize documentation and cross-platform build fixes.
- Updated doc/README.md with comprehensive shape and transformation details. - Ensured consistency of TargetFramework across the entire solution. - Verified successful build and test of the entire solution on Linux. - Confirmed GitHub Actions workflow handles multi-targeting correctly. Co-authored-by: roboter <386485+roboter@users.noreply.github.com>
1 parent db66b70 commit eb9834c

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

doc/README.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -42,12 +42,19 @@ Creates an extrusion of a regular polygon.
4242
### LinearExtrude
4343
Extrudes a 2D shape along a linear path.
4444
- **Constructors**:
45-
- `LinearExtrude(IEnumerable<Vector2> points, double height, string name = "")`
45+
- `LinearExtrude(double[] points, double height, Alignment alignment = Alignment.z, double twistRadians = 0, string name = "")`
46+
- `LinearExtrude(Vector2[] points, double height, Alignment alignment = Alignment.z, double twistRadians = 0, string name = "")`
4647

4748
### RotateExtrude
4849
Extrudes a 2D shape by rotating it around an axis.
4950
- **Constructors**:
50-
- `RotateExtrude(IEnumerable<Vector2> points, int sides = 20, string name = "")`
51+
- `RotateExtrude(double[] points, double axisOffset = 0, Alignment alignment = Alignment.z, string name = "")`
52+
- `RotateExtrude(Vector2[] points, double axisOffset, Alignment alignment = Alignment.z, string name = "")`
53+
54+
### MeshContainer (Import STL)
55+
Loads a mesh from a file (e.g., STL).
56+
- **Constructors**:
57+
- `MeshContainer(string fileOnDisk, string name = "")`
5158

5259
### Round
5360
Creates a box with rounded edges or corners.
@@ -67,29 +74,32 @@ Creates a box with rounded edges or corners.
6774
### Translate
6875
Moves an object in 3D space.
6976
- **Example**: `new Translate(myObject, x: 10, y: 0, z: 5);`
77+
- **Example**: `new Translate(myObject, new Vector3(10, 0, 5));`
7078

7179
### Rotate
72-
Rotates an object around the X, Y, and Z axes.
80+
Rotates an object around the X, Y, and Z axes (in radians).
7381
- **Example**: `new Rotate(myObject, x: MathHelper.DegreesToRadians(45));`
7482

7583
### Scale
7684
Changes the size of an object.
7785
- **Example**: `new Scale(myObject, x: 2, y: 1, z: 1);`
86+
- **Example**: `new Scale(myObject, new Vector3(2, 1, 1));`
7887

7988
### Align
8089
Aligns one object to another based on their faces.
8190
- **Example**: `new Align(objectToMove, Face.Left, targetObject, Face.Right);`
8291

8392
### SetCenter
8493
Sets the center of an object to a specific position.
94+
- **Example**: `new SetCenter(myObject, x: 0, y: 0, z: 0);`
8595
- **Example**: `new SetCenter(myObject, new Vector3(0, 0, 0));`
8696

8797
### Mirror
8898
Mirrors an object across a plane.
8999
- **Methods**:
90-
- `NewMirrorAccrossX(double offsetFromOrigin = 0)`
91-
- `NewMirrorAccrossY(double offsetFromOrigin = 0)`
92-
- `NewMirrorAccrossZ(double offsetFromOrigin = 0)`
100+
- `myObject.NewMirrorAccrossX(double offsetFromOrigin = 0)`
101+
- `myObject.NewMirrorAccrossY(double offsetFromOrigin = 0)`
102+
- `myObject.NewMirrorAccrossZ(double offsetFromOrigin = 0)`
93103

94104
---
95105

@@ -109,7 +119,7 @@ Subtracts one object from another.
109119

110120
### Intersection
111121
Keeps only the overlapping part of two objects.
112-
- **C# operator**: `obj1 & obj2` (or similar depending on implementation)
122+
- **C# operator**: `obj1 & obj2` (Not directly supported as operator in some versions, use `new Intersection(obj1, obj2)`)
113123

114124
![Intersection](examples/intersection.svg)
115125

0 commit comments

Comments
 (0)