Skip to content

agdturner/ccg-v3d

Repository files navigation

Description

A modular three-dimensional (3D) Euclidean geometry Java library.

There are two main implementations distinguished by the type of numbers used for calculations and to represent coordinates:

  1. Coordinates and calculations using Java double precision primitive numbers.
  2. Coordinates and calculations using a combination of BigRational and Math_BigRationalSqrt numbers.

Vectors are defined using cartesian coordinates. The orthogonal X, Y and Z axes meet at the origin - a point <x,y,z> where x=y=z=0.

Geometry calculation with Java double precision primitives typically use a small tollerance value (epsilon) to evaluate whether two vectors are the same. The accuracy of this geometry varies due to the nature of floating point arithmetic.

Geometry calculation with BigRational and Math_BigRationalSqrt can be done with a more arbitrarily specified precision based on the Order of Magnitude (OOM) of the precision wanted. Math_BigRationalSqrt allow for coordinate values at precise non-rational square roots e.g. $\sqrt{2}$, $\sqrt{3}$, $\sqrt{5}$.

The coordinate systems are "right handed", so: if X increases to the right of this page; and, Y increases towards the top of this page, then Z increases out from the page, (see Orientation and the note on the choice of right over left handedness for details of why this handedness was chosen.

I envisaged using this library to develop a Digital Twin Earth.

The development of the library is aided by ccg-r3d - a rendering library for visualising 3D spatial geometry.

Details

Lightweight Geometry

Heavyweight Geometry

Development plans and progress

  • An initial implementation resulted in visualisations of the Utah Teapot. The library has since been redeveloped and the rendering of the Utah Tepot no longer works. This wants fixing...
  • 3D convex hull
  • 3D Shape with external holes.
  • 3D Shape with internal holes.
  • Create a model of Earth and images in 3D revealing land/ice and water.

arbitrary precision geometrical functionality...

  • Intersections -- It would be useful to be able to distinguish between geometries that touch at a point, along a line or line_segment or over an area; and those that overlap (all or part of) another geometry. -- Geometry intersections calculations for triangular or simpler geometries are supported. -- Implementations of methods to calculate the intersection between tetrahedrons and simpler geometries are wanted.
  • Distances -- There are methods for calculating the minimum distance between geometries including triangles and simpler geometries. -- Implementations of methods to calulate distances between tetrahedrons and simpler geometries are wanted.
  • New geometries are wanted for surfaces.
  • Surface Areas, Perimeters and Volumes -- For some shapes there are implementations of methods for calculating these.

Contributing

  • Thanks for thinking about this.
  • If this is to form into a collaborative project, it could do with a Code of Conduct and Contributor Guidelines based on something like this: Open Source Guide

LICENSE

Acknowledgements and thanks

  • The University of Leeds has indirectly supported this work by employing me over the years and encouraging me to develop the skills necessary to produce this library.
  • Thank you Eric for the BigMath library.

Notes

For a solar system model or a model of Earth, it is probably best to set the origin at the centre of mass (CoM).

Handedness

Handedness or chirality concerns the assignment of coordinate axes/directions. The choice of left-handed or right-handed is somewhat arbitrary, but this library uses a right-handed system as it is suggested this is more commonly used in geography and physics (video). Originally the library began using a left-handed system based on the logic of vertical viewing screens, graphs and zooming in and out by the viewer moving closer and further away from the screen.

Projections

References

Similar software for review

  • Apache Commons Geometry (see also: Apache Commons Geometry GitHub Repository)
    • Java
    • Uses both floating point and large rational numbers for coordinates.
  • Geometric Tools Library
    • C++.
    • Uses both floating point and large rational numbers for coordinates.
  • VTK-m - README - VTK-m GitHub Mirror
    • C/C++.
    • Uses floating point for coordinates.
  • VisIt
    • Open Source, interactive, scalable, visualization, animation and analysis tool.
    • Languages: C 75.8%, C++ 12.8%, Python 3.8%, Java 3.0%
    • Github repository
  • Fides
    • Fides enables complex scientific workflows to seamlessly integrate simulation and visualization. This is done by providing a data model in JSON that describes the mesh and fields in the data to be read. Using this data model, Fides maps ADIOS2 data arrays (from files or streams) to VTK-m datasets, enabling visualization of the data using shared- and distributed-memory parallel algorithms.
    • Can be used with Paraview
  • ParaView
    • Open source post-processing visualization engine.
    • Uses VTK - an open-source, freely available software system for 3D computer graphics, modeling, image processing, volume rendering, scientific visualization, and 2D plotting - VTK GitHub Mirror