Carve booleans library integration

==================================

Merging Carve library integration project into the trunk.

This commit switches Boolean modifier to another library which handles
mesh boolean operations in much stable and faster way, resolving old
well-known limitations of intern boolop library.

Carve is integrating as alternative interface for boolop library and
which makes it totally transparent for blender sources to switch between
old-fashioned boolop and new Carve backends.

Detailed changes in this commit:

- Integrated needed subset of Carve library sources into extern/
  Added script for re-bundling it (currently works only if repo
  was cloned by git-svn).
- Added BOP_CarveInterface for boolop library which can be used by
  Boolean modifier.
- Carve backend is enabled by default, can be disabled by WITH_BF_CARVE
  SCons option and WITH_CARVE CMake option.
- If Boost library is found in build environment it'll be used for
  unordered collections. If Boost isn't found, it'll fallback to TR1
  implementation for GCC compilers. Boost is obligatory if MSVC is used.

Tested on Linux 64bit and Windows 7 64bit.

NOTE: behavior of flat objects was changed. E.g. Plane-Sphere now gives
      plane with circle hole, not plane with semisphere. Don't think
      it's really issue because it's not actually defined behavior in
      such situations and both of ways might be useful. Since it's
      only known "regression" think it's OK to deal with it.

Details are there http://wiki.blender.org/index.php/User:Nazg-gul/CarveBooleans

Special thanks to:

- Ken Hughes: author of original carve integration patch.
- Campbell Barton: help in project development, review tests.
- Tobias Sargeant: author of Carve library, help in resolving some
                   merge stoppers, bug fixing.

1 files changed, 371 insertions, 0 deletions

diff --git a/extern/carve/lib/csg_collector.cpp b/extern/carve/lib/csg_collector.cpp
new file mode 100644
index 00000000000..6e86b128b51
--- /dev/null
+++ b/extern/carve/lib/csg_collector.cpp
@@ -0,0 +1,371 @@
+// Begin License:
+// Copyright (C) 2006-2011 Tobias Sargeant (tobias.sargeant@gmail.com).
+// All rights reserved.
+//
+// This file is part of the Carve CSG Library (http://carve-csg.com/)
+//
+// This file may be used under the terms of the GNU General Public
+// License version 2.0 as published by the Free Software Foundation
+// and appearing in the file LICENSE.GPL2 included in the packaging of
+// this file.
+//
+// This file is provided "AS IS" with NO WARRANTY OF ANY KIND,
+// INCLUDING THE WARRANTIES OF DESIGN, MERCHANTABILITY AND FITNESS FOR
+// A PARTICULAR PURPOSE.
+// End:
+
+
+#if defined(HAVE_CONFIG_H)
+#  include <carve_config.h>
+#endif
+
+#include <carve/csg.hpp>
+#include <iostream>
+#include "intersect_debug.hpp"
+
+#if defined(CARVE_DEBUG_WRITE_PLY_DATA)
+void writePLY(const std::string &out_file, const carve::mesh::MeshSet<3> *poly, bool ascii);
+#endif
+
+
+namespace carve {
+  namespace csg {
+    namespace {
+
+      class BaseCollector : public CSG::Collector {
+        BaseCollector();
+        BaseCollector(const BaseCollector &);
+        BaseCollector &operator=(const BaseCollector &);
+
+      protected:
+        struct face_data_t {
+          carve::mesh::MeshSet<3>::face_t *face;
+          const carve::mesh::MeshSet<3>::face_t *orig_face;
+          bool flipped;
+          face_data_t(carve::mesh::MeshSet<3>::face_t *_face,
+                      const carve::mesh::MeshSet<3>::face_t *_orig_face,
+                      bool _flipped) : face(_face), orig_face(_orig_face), flipped(_flipped) {
+          };
+        };
+
+        std::list<face_data_t> faces;
+
+        const carve::mesh::MeshSet<3> *src_a;
+        const carve::mesh::MeshSet<3> *src_b;
+    
+        BaseCollector(const carve::mesh::MeshSet<3> *_src_a,
+                      const carve::mesh::MeshSet<3> *_src_b) : CSG::Collector(), src_a(_src_a), src_b(_src_b) {
+        }
+
+        virtual ~BaseCollector() {
+        }
+
+        void FWD(const carve::mesh::MeshSet<3>::face_t *orig_face,
+                 const std::vector<carve::mesh::MeshSet<3>::vertex_t *> &vertices,
+                 carve::geom3d::Vector /* normal */,
+                 bool /* poly_a */,
+                 FaceClass face_class,
+                 CSG::Hooks &hooks) {
+          std::vector<carve::mesh::MeshSet<3>::face_t *> new_faces;
+          new_faces.reserve(1);
+          new_faces.push_back(orig_face->create(vertices.begin(), vertices.end(), false));
+          hooks.processOutputFace(new_faces, orig_face, false);
+          for (size_t i = 0; i < new_faces.size(); ++i) {
+            faces.push_back(face_data_t(new_faces[i], orig_face, false));
+          }
+
+#if defined(CARVE_DEBUG) && defined(DEBUG_PRINT_RESULT_FACES)
+          std::cerr << "+" << ENUM(face_class) << " ";
+          for (unsigned i = 0; i < vertices.size(); ++i) std::cerr << " " << vertices[i] << ":" << *vertices[i];
+          std::cerr << std::endl;
+#endif
+        }
+
+        void REV(const carve::mesh::MeshSet<3>::face_t *orig_face,
+                 const std::vector<carve::mesh::MeshSet<3>::vertex_t *> &vertices,
+                 carve::geom3d::Vector /* normal */,
+                 bool /* poly_a */,
+                 FaceClass face_class,
+                 CSG::Hooks &hooks) {
+          // normal = -normal;
+          std::vector<carve::mesh::MeshSet<3>::face_t *> new_faces;
+          new_faces.reserve(1);
+          new_faces.push_back(orig_face->create(vertices.begin(), vertices.end(), true));
+          hooks.processOutputFace(new_faces, orig_face, true);
+          for (size_t i = 0; i < new_faces.size(); ++i) {
+            faces.push_back(face_data_t(new_faces[i], orig_face, true));
+          }
+
+#if defined(CARVE_DEBUG) && defined(DEBUG_PRINT_RESULT_FACES)
+          std::cerr << "-" << ENUM(face_class) << " ";
+          for (unsigned i = 0; i < vertices.size(); ++i) std::cerr << " " << vertices[i] << ":" << *vertices[i];
+          std::cerr << std::endl;
+#endif
+        }
+
+        virtual void collect(const carve::mesh::MeshSet<3>::face_t *orig_face,
+                             const std::vector<carve::mesh::MeshSet<3>::vertex_t *> &vertices,
+                             carve::geom3d::Vector normal,
+                             bool poly_a,
+                             FaceClass face_class,
+                             CSG::Hooks &hooks) =0;
+
+        virtual void collect(FaceLoopGroup *grp, CSG::Hooks &hooks) {
+          std::list<ClassificationInfo> &cinfo = (grp->classification);
+
+          if (cinfo.size() == 0) {
+            std::cerr << "WARNING! group " << grp << " has no classification info!" << std::endl;
+            return;
+          }
+          
+          FaceClass fc = FACE_UNCLASSIFIED;
+
+          unsigned fc_closed_bits = 0;
+          unsigned fc_open_bits = 0;
+          unsigned fc_bits = 0;
+
+          for (std::list<ClassificationInfo>::const_iterator i = grp->classification.begin(), e = grp->classification.end(); i != e; ++i) {
+
+            if ((*i).intersected_mesh == NULL) {
+              // classifier only returns global info
+              fc_closed_bits = class_to_class_bit((*i).classification);
+              break;
+            }
+
+            if ((*i).classification == FACE_UNCLASSIFIED) continue;
+            if ((*i).intersectedMeshIsClosed()) {
+              fc_closed_bits |= class_to_class_bit((*i).classification);
+            } else {
+              fc_open_bits |= class_to_class_bit((*i).classification);
+            }
+          }
+
+          if (fc_closed_bits) {
+            fc_bits = fc_closed_bits;
+          } else {
+            fc_bits = fc_open_bits;
+          }
+
+          fc = class_bit_to_class(fc_bits);
+
+          // handle the complex cases where a group is classified differently with respect to two or more closed manifolds.
+          if (fc == FACE_UNCLASSIFIED) {
+            unsigned inout_bits = fc_bits & FACE_NOT_ON_BIT;
+            unsigned on_bits = fc_bits & FACE_ON_BIT;
+
+            // both in and out. indicates an invalid manifold embedding.
+            if (inout_bits == (FACE_IN_BIT | FACE_OUT_BIT)) goto out;
+
+            // on, both orientations. could be caused by two manifolds touching at a face.
+            if (on_bits == (FACE_ON_ORIENT_IN_BIT | FACE_ON_ORIENT_OUT_BIT)) goto out;
+
+            // in or out, but also on (with orientation). the on classification takes precedence.
+            fc = class_bit_to_class(on_bits);
+          }
+
+        out:
+
+          if (fc == FACE_UNCLASSIFIED) {
+            std::cerr << "group " << grp << " is unclassified!" << std::endl;
+
+#if defined(CARVE_DEBUG_WRITE_PLY_DATA)
+            static int uc_count = 0;
+
+            std::vector<carve::mesh::MeshSet<3>::face_t *> faces;
+
+            for (FaceLoop *f = grp->face_loops.head; f; f = f->next) {
+              carve::mesh::MeshSet<3>::face_t *temp = f->orig_face->create(f->vertices.begin(), f->vertices.end(), false);
+              faces.push_back(temp);
+            }
+
+            carve::mesh::MeshSet<3> *p = new carve::mesh::MeshSet<3>(faces);
+
+            std::ostringstream filename;
+            filename << "classifier_fail_" << ++uc_count << ".ply";
+            std::string out(filename.str().c_str());
+            ::writePLY(out, p, false);
+
+            delete p;
+#endif
+
+            return;
+          }
+
+          bool is_poly_a = grp->src == src_a;
+
+          for (FaceLoop *f = grp->face_loops.head; f; f = f->next) {
+            collect(f->orig_face, f->vertices, f->orig_face->plane.N, is_poly_a, fc, hooks);
+          }
+        }
+
+        virtual carve::mesh::MeshSet<3> *done(CSG::Hooks &hooks) {
+          std::vector<carve::mesh::MeshSet<3>::face_t *> f;
+          f.reserve(faces.size());
+          for (std::list<face_data_t>::iterator i = faces.begin(); i != faces.end(); ++i) {
+            f.push_back((*i).face);
+          }
+
+          carve::mesh::MeshSet<3> *p = new carve::mesh::MeshSet<3>(f);
+
+          if (hooks.hasHook(carve::csg::CSG::Hooks::RESULT_FACE_HOOK)) {
+            for (std::list<face_data_t>::iterator i = faces.begin(); i != faces.end(); ++i) {
+              hooks.resultFace((*i).face, (*i).orig_face, (*i).flipped);
+            }
+          }
+
+          return p;
+        }
+      };
+
+
+
+      class AllCollector : public BaseCollector {
+      public:
+        AllCollector(const carve::mesh::MeshSet<3> *_src_a,
+                     const carve::mesh::MeshSet<3> *_src_b) : BaseCollector(_src_a, _src_b) {
+        }
+        virtual ~AllCollector() {
+        }
+        virtual void collect(FaceLoopGroup *grp, CSG::Hooks &hooks) {
+          for (FaceLoop *f = grp->face_loops.head; f; f = f->next) {
+            FWD(f->orig_face, f->vertices, f->orig_face->plane.N, f->orig_face->mesh->meshset == src_a, FACE_OUT, hooks);
+          }
+        }
+        virtual void collect(const carve::mesh::MeshSet<3>::face_t *orig_face,
+                             const std::vector<carve::mesh::MeshSet<3>::vertex_t *> &vertices,
+                             carve::geom3d::Vector normal,
+                             bool poly_a,
+                             FaceClass face_class,
+                             CSG::Hooks &hooks) {
+          FWD(orig_face, vertices, normal, poly_a, face_class, hooks);
+        }
+      };
+
+
+
+      class UnionCollector : public BaseCollector {
+      public:
+        UnionCollector(const carve::mesh::MeshSet<3> *_src_a,
+                       const carve::mesh::MeshSet<3> *_src_b) : BaseCollector(_src_a, _src_b) {
+        }
+        virtual ~UnionCollector() {
+        }
+        virtual void collect(const carve::mesh::MeshSet<3>::face_t *orig_face,
+                             const std::vector<carve::mesh::MeshSet<3>::vertex_t *> &vertices,
+                             carve::geom3d::Vector normal,
+                             bool poly_a,
+                             FaceClass face_class,
+                             CSG::Hooks &hooks) {
+          if (face_class == FACE_OUT || (poly_a && face_class == FACE_ON_ORIENT_OUT)) {
+            FWD(orig_face, vertices, normal, poly_a, face_class, hooks);
+          }
+        }
+      };
+
+
+
+      class IntersectionCollector : public BaseCollector {
+      public:
+        IntersectionCollector(const carve::mesh::MeshSet<3> *_src_a,
+                              const carve::mesh::MeshSet<3> *_src_b) : BaseCollector(_src_a, _src_b) {
+        }
+        virtual ~IntersectionCollector() {
+        }
+        virtual void collect(const carve::mesh::MeshSet<3>::face_t *orig_face,
+                             const std::vector<carve::mesh::MeshSet<3>::vertex_t *> &vertices,
+                             carve::geom3d::Vector normal,
+                             bool poly_a,
+                             FaceClass face_class,
+                             CSG::Hooks &hooks) {
+          if (face_class == FACE_IN || (poly_a && face_class == FACE_ON_ORIENT_OUT)) {
+            FWD(orig_face, vertices, normal, poly_a, face_class, hooks);
+          }
+        }
+      };
+
+
+
+      class SymmetricDifferenceCollector : public BaseCollector {
+      public:
+        SymmetricDifferenceCollector(const carve::mesh::MeshSet<3> *_src_a,
+                                     const carve::mesh::MeshSet<3> *_src_b) : BaseCollector(_src_a, _src_b) {
+        }
+        virtual ~SymmetricDifferenceCollector() {
+        }
+        virtual void collect(const carve::mesh::MeshSet<3>::face_t *orig_face,
+                             const std::vector<carve::mesh::MeshSet<3>::vertex_t *> &vertices,
+                             carve::geom3d::Vector normal,
+                             bool poly_a,
+                             FaceClass face_class,
+                             CSG::Hooks &hooks) {
+          if (face_class == FACE_OUT) {
+            FWD(orig_face, vertices, normal, poly_a, face_class, hooks);
+          } else if (face_class == FACE_IN) {
+            REV(orig_face, vertices, normal, poly_a, face_class, hooks);
+          }
+        }
+      };
+
+
+
+      class AMinusBCollector : public BaseCollector {
+      public:
+        AMinusBCollector(const carve::mesh::MeshSet<3> *_src_a,
+                         const carve::mesh::MeshSet<3> *_src_b) : BaseCollector(_src_a, _src_b) {
+        }
+        virtual ~AMinusBCollector() {
+        }
+        virtual void collect(const carve::mesh::MeshSet<3>::face_t *orig_face,
+                             const std::vector<carve::mesh::MeshSet<3>::vertex_t *> &vertices,
+                             carve::geom3d::Vector normal,
+                             bool poly_a,
+                             FaceClass face_class,
+                             CSG::Hooks &hooks) {
+          if ((face_class == FACE_OUT || face_class == FACE_ON_ORIENT_IN) && poly_a) {
+            FWD(orig_face, vertices, normal, poly_a, face_class, hooks);
+          } else if (face_class == FACE_IN && !poly_a) {
+            REV(orig_face, vertices, normal, poly_a, face_class, hooks);
+          }
+        }
+      };
+
+
+
+      class BMinusACollector : public BaseCollector {
+      public:
+        BMinusACollector(const carve::mesh::MeshSet<3> *_src_a,
+                         const carve::mesh::MeshSet<3> *_src_b) : BaseCollector(_src_a, _src_b) {
+        }
+        virtual ~BMinusACollector() {
+        }
+        virtual void collect(const carve::mesh::MeshSet<3>::face_t *orig_face,
+                             const std::vector<carve::mesh::MeshSet<3>::vertex_t *> &vertices,
+                             carve::geom3d::Vector normal,
+                             bool poly_a,
+                             FaceClass face_class,
+                             CSG::Hooks &hooks) {
+          if ((face_class == FACE_OUT || face_class == FACE_ON_ORIENT_IN) && !poly_a) {
+            FWD(orig_face, vertices, normal, poly_a, face_class, hooks);
+          } else if (face_class == FACE_IN && poly_a) {
+            REV(orig_face, vertices, normal, poly_a, face_class, hooks);
+          }
+        }
+      };
+
+    }
+
+    CSG::Collector *makeCollector(CSG::OP op,
+                                  const carve::mesh::MeshSet<3> *poly_a,
+                                  const carve::mesh::MeshSet<3> *poly_b) {
+      switch (op) {
+      case CSG::UNION:                return new UnionCollector(poly_a, poly_b);
+      case CSG::INTERSECTION:         return new IntersectionCollector(poly_a, poly_b);
+      case CSG::A_MINUS_B:            return new AMinusBCollector(poly_a, poly_b);
+      case CSG::B_MINUS_A:            return new BMinusACollector(poly_a, poly_b);
+      case CSG::SYMMETRIC_DIFFERENCE: return new SymmetricDifferenceCollector(poly_a, poly_b);
+      case CSG::ALL:                  return new AllCollector(poly_a, poly_b);
+      }
+      return NULL;
+    }
+  }
+}