summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDon Bright <hugh.m.bright@gmail.com>2012-05-28 16:48:46 (GMT)
committerDon Bright <hugh.m.bright@gmail.com>2012-05-28 16:48:46 (GMT)
commitdd2002a81673b3875ce8c4e8a61cb10278c4eb03 (patch)
tree7aaadf1c9b12cd37a7a913d3e76256f6406fa939 /doc
parent4381762f5aa2e6a56258618e585e1510ead88684 (diff)
parent67eb2ebe90447e966dc1e08b91c43d937c521583 (diff)
Tidy up code. Generate proper test png images. Merge branch 'master' into caliston1.
Conflicts: src/PolySetCGALEvaluator.cc
Diffstat (limited to 'doc')
-rw-r--r--doc/TODO.txt19
-rw-r--r--doc/testing.txt14
2 files changed, 27 insertions, 6 deletions
diff --git a/doc/TODO.txt b/doc/TODO.txt
index 60078e2..7f8378d 100644
--- a/doc/TODO.txt
+++ b/doc/TODO.txt
@@ -1,6 +1,6 @@
-BUGS
-----
+BUGS (FIXME: Verify and move these to github)
+---------------------------------------------
o Some invalid DXF data gets pass the import checks and breaks the tessing code
o Tesselation via GLU sometimes produces strange results
o Export STL: Exports existing CGAL model even though the current model is changed, but not CGAL rendered
@@ -8,8 +8,8 @@ o Look into the polygon winding and rotate_extrude() problem reported by Britton
o CGAL Aff_transformation_3 doesn't support non-affine transformations (non-aff-matrix.scad)
o 2D union of polygons with a touching vertex doesn't work. see testdata/scad/bugs/polygon-touch.scad
-STL Import BUGS
----------------
+STL Import BUGS (FIXME: Verify and move these to github)
+--------------------------------------------------------
Using STL-imported models is tricky and triggers multiple issues:
(these all fail with the usual "Illegal polygonal object" error)
@@ -73,6 +73,7 @@ o 3D View
- 2D objects are rendered at z = -0.1 - why?
- Rewrite to use VBOs or smth. - avoid inline calculations
- Rewrite to a higher-level library (e.g. OSG)?
+ - Make navigation (e.g. zoom) available through menu entries (requested by disabled user)
o Editor wishlist
- More infrastructure for external editor (allow communication from the outside)
- Preferences GUI for the features below
@@ -93,12 +94,14 @@ o Editor wishlist
- Auto-indent on enter and on tab
o Error reporting/debugging
- Provide better error messages when polygon ordering causes CGAL errors:
+ o Detect common error: self-intersecting polyhedron()
o Supply syntax highlighting of the exact polygon indices which are
reported to be wrong
o Provide some interaction for debug walk-through?
- Provide visual highlighting of geometry corresponding to code
-> could aid debugging a lot
- Optionally output console log to a file
+ - Common error: detect and report (and ignore?) duplicate line segments in DXF
o Computation
- Multi-threaded computation (mostly important for CGAL)
- Progress: Call progresswidget more often to improve feedback
@@ -117,7 +120,6 @@ OpenCSG-related
---------------
o OpenCSG rendering: Coincident surfaces causes z-buffer fighting. Is this somehow
avoidable tuning the depth tests in OpenCSG?
-o Make the 10.000 element OpenCSG limit configurable (Preferences) ?
o When specifying a transparency with the color() statement,
the object is not sorted and will be rendered wrongly
o Bug: Using the background operator (%) on the only object in a scene triggers a
@@ -256,8 +258,13 @@ o Caching
- Test that caching is actually performed (speedup + same results)
- Test the modifier characters correctly influence the cache (also when
added/removed)
+ - Test the individual caches
+ - PolySetCache
+ - CGALCache
+ - nodecache
+ - ModuleCache
o other tests
- export
- cmd-line tests
- leaf nodes having children, e.g. cube() cylinder();
- - dependency tracking
+ - dependency tracking (use and include)
diff --git a/doc/testing.txt b/doc/testing.txt
index 542de5d..6990c2f 100644
--- a/doc/testing.txt
+++ b/doc/testing.txt
@@ -51,6 +51,20 @@ Adding a new regression test:
7) run the test normally and verify that it passes:
$ ctest -R mytest
+Adding a new example:
+---------------------
+
+This is almost the same as adding a new regression test:
+1) Create the example under examples/
+2) run the test with the environment variable TEST_GENERATE=1, e.g.:
+ $ TEST_GENERATE=1 ctest -C Examples -R exampleNNN
+ (this will generate a exampleNNN-expected.txt file which is used for regression testing)
+3) manually verify that the output is correct (tests/regression/<testapp>/exampleNNN.<suffix>)
+4) run the test normally and verify that it passes:
+ $ ctest -C Examples -R exampleNNN
+
+
+
Troubleshooting:
------------------------------
contact: Jan Huwald // Impressum