Skip to content

Commit a75dfd0

Browse files
committed
update(README): add Acknowledgments section and refine geometry visualization details
1 parent 8218883 commit a75dfd0

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ Autodesk Revit plugin project organized into multiple solution files that target
2626
* [🔧 Language Support](#-language-support)
2727
* [💡 Best Practices](#-best-practices)
2828
* [🔍 Troubleshooting](#-troubleshooting)
29+
* [Acknowledgments](#acknowledgments)
2930
<!-- TOC -->
3031

3132
## Usage
@@ -68,7 +69,7 @@ Trace.TraceWarning("Element not found, using default values");
6869
Trace.TraceError("Failed to process element: " + exception.Message);
6970

7071
// Debug logging
71-
System.Diagnostics.Debug.WriteLine("Debug information: " + debugInfo);
72+
Debug.WriteLine("Debug information: " + debugInfo);
7273

7374
// Console output (automatically captured)
7475
Console.WriteLine("This will appear in the trace log");
@@ -110,11 +111,11 @@ The Geometry Visualization system allows you to display transient geometry direc
110111

111112
#### Key Features
112113

113-
- **Transient Display** - Geometry appears as temporary, non-selectable objects
114+
- **Transient Display** - use Revit's DirectContext3D for rendering which inspired by RevitLookup
114115
- **Automatic Cleanup** - Geometry is removed when document closes
115-
- **Manual Control** - Use `ClearTraceGeometry` to remove geometry on demand
116-
- **Document-specific** - Each document maintains its own geometry collection
117-
- **Performance Optimized** - Uses Revit's internal transient display methods
116+
- **Manual Control** - Use `ClearGeometry` to remove geometry on demand, `Clear Log` to clear log messages
117+
- **Performance Optimized** - Efficient rendering/Disposal of geometry
118+
- **Supports Mixed Geometry Types** - Trace collections of different geometry types in one call
118119

119120
#### How to Use Geometry Visualization
120121

@@ -168,14 +169,6 @@ var geometries = new List<GeometryObject> { face, curve, solid };
168169
Trace.Write(geometries);
169170
```
170171

171-
4. **Clear Traced Geometry**:
172-
173-
```csharp
174-
// Clear all traced geometry for the current document
175-
// Use the "Clear Geometry" button in the UI, or programmatically:
176-
// (This happens automatically via the UI button)
177-
```
178-
179172
#### Python/IronPython Geometry Visualization
180173

181174
```python
@@ -301,7 +294,14 @@ RevitDevTool works with multiple programming languages and scripting environment
301294

302295
### 🔍 Troubleshooting
303296

304-
- **No Geometry Visible**: Ensure the logger is enabled and you're viewing the correct 3D view
305-
- **Geometry Persists**: Use "Clear Geometry" button or close/reopen the document
297+
- **No Geometry Visible**: Ensure the logger is enabled and you can reset by toggling the `Start/Stop Listener`
298+
- **Geometry Persists**: Use "Clear Geometry" button
306299
- **Missing Logs**: Check that the log level is set appropriately for your trace calls
307-
- **Performance Issues**: Reduce the number of geometry objects traced simultaneously
300+
- **Performance Issues**: Reduce the number of geometry objects traced simultaneously
301+
302+
## Acknowledgments
303+
304+
Special thanks to:
305+
306+
- [**RevitLookup**](https://github.com/lookup-foundation/RevitLookup) - For the beautiful DirectContext3D implementation that powers our geometry visualization
307+
- [**RevitDevTool (Original)**](https://github.com/Zhuangkh/RevitDevTool) - For the original idea and inspiration for this project

0 commit comments

Comments
 (0)