Module documentation for 0.1.0.6
CSG: constructive solid geometry library
CSG is a constructive solid geometry library with support for ray casting. CSG allows you to define a complex solid as a composition of primitives. It also provides functions to perform ray casting (find an intersection of a ray and the defined solid) or test whether a point belongs to the solid (for Monte Carlo volume calculation).
-- "Data.CSG" uses 'Vec3' to represent vectors and points: >>> let p1 = fromXYZ (5, -6.5, -5) >>> toXYZ (origin :: Point) (0.0,0.0,0.0) -- Define some solids: >>> let s = sphere origin 5.0 >>> let b = cuboid (fromXYZ (-1, -1, -1)) (fromXYZ (1, 1, 1)) -- Test if a point is inside the solid: >>> origin `inside` (s `intersect` b) True >>> origin `inside` (s `subtract` b) False -- Find the distance to the next intersection of a ray with a solid, along with the -- surface normal: >>> let axis = fromXYZ (1, 2, 10) >>> let solid = cylinder origin axis 2.0 `intersect` sphere origin 3.5 >>> let ray = Ray (p1, origin <-> p1) >>> ray `cast` solid Just (HitPoint 0.7422558525331708 (Just (CVec3 0.7155468474912454 (-0.6952955216188516) 6.750441957464598e-2))) -- Load a solid definition from a file: >>> import Data.CSG.Parser >>> Right solid2 <- parseGeometryFile "examples/reentry.geo" >>> ray `cast` solid2 Just (HitPoint 10.877824491509912 (Just (CVec3 (-0.5690708596937849) 0.7397921176019203 0.3589790793088691)))
Please consult the Hackage page for csg for full documentation.
csg is built using
CVec3 from simple-vec3 to
represent vectors and points, which according to benchmarks shows
better performance with Unboxed and Storable vectors. Build
triples flag to use
(Double, Double, Double) instead which may be
a more convenient programmatic interface that needs no
See alternatives too.
The package also includes
csg-raycaster executable, which is a
simple interactive GUI for the ray casting algorithm.
csg-raycaster takes a geometry defintion file as input. See
solid box = orthobrick (-150, -150, -150; 150, 150, 150); solid rounded = sphere (0, 0, 0; 200); solid roundedbox = rounded and box; solid cylinder1 = cylinder (-160, 0, 0; 160, 0, 0; 100); solid cylinder2 = cylinder (0, -160, 0; 0, 160, 0; 100); solid cylinder3 = cylinder (0, 0, -160; 0, 0, 160; 100); solid cross = cylinder1 or cylinder2 or cylinder3; solid cutout = not cross; solid top = roundedbox and cutout; tlo top;
Please consult the Hackage page for Data.CSG.Parser for full format specification.
csg-raycaster may be run as
csg-raycaster --help to see all options.
When run without a file argument,
csg-raycaster will try to display
an arbitrary CSG solid.
In the GUI window the following controls are supported:
|Left mouse button + drag||Rotate|
|Right mouse button + drag||Pan|
|Mouse wheel up||Zoom in|
|Mouse wheel down||Zoom out|
||Reset zoom level and camera position|
csg library performs no surface interpolation when doing ray casting. Instead, we only solve ray-surface intersection equation numerically. The library was written with Repa/vector compatibility and performance in mind.
There’re other Haskell libraries for CSG:
Has more ray tracing-specific features, such as light sources, different textures and materials.
csg, has no tests or benchmarks.
csgsolids use the same type as opposed to different types with an existential box in
Offers a much richer operation set.
Uses function representation for CSG solids.
implicithad ray-casting support in early 2012 then I probably wouldn’t write
Only provides types and functions to define solids and export definitions to external formats.
No support for ray casting.
0.1.0.6 - 2018-01-18
- GHC 8.6.x support
0.1.0.5 - 2018-08-20
- Dependencies bump
0.1.0.4 - 2018-07-16
- Benchmark dependencies bump
0.1.0.3 - 2018-06-29
- Test suite dependencies bump
0.1.0.2 - 2018-05-12
- Test suite dependencies bump
0.1.0.1 - 2018-05-11
GHC 8.4.x support
doctest-driver-gento run doctests