0024473: TKMath, BVH - introduce template-based package for Bounding volume hierarchy...
[occt.git] / src / BVH / BVH_Geometry.hxx
diff --git a/src/BVH/BVH_Geometry.hxx b/src/BVH/BVH_Geometry.hxx
new file mode 100644 (file)
index 0000000..1bb856e
--- /dev/null
@@ -0,0 +1,68 @@
+// Created on: 2013-12-20
+// Created by: Denis BOGOLEPOV
+// Copyright (c) 2013 OPEN CASCADE SAS
+//
+// This file is part of Open CASCADE Technology software library.
+//
+// This library is free software; you can redistribute it and / or modify it
+// under the terms of the GNU Lesser General Public version 2.1 as published
+// by the Free Software Foundation, with special exception defined in the file
+// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
+// distribution for complete text of the license and disclaimer of any warranty.
+//
+// Alternatively, this file may be used under the terms of Open CASCADE
+// commercial license or contractual agreement.
+
+#ifndef _BVH_Geometry_Header
+#define _BVH_Geometry_Header
+
+#include <BVH_ObjectSet.hxx>
+#include <BVH_Builder.hxx>
+
+//! BVH geometry as a set of abstract geometric objects.
+template<class T, int N>
+class BVH_Geometry : public BVH_ObjectSet<T, N>
+{
+public:
+
+  //! Creates uninitialized BVH geometry.
+  BVH_Geometry();
+
+  //! Releases resources of BVH geometry.
+  virtual ~BVH_Geometry();
+
+public:
+
+  //! Marks geometry as outdated.
+  virtual void MarkDirty();
+
+  //! Returns AABB of whole geometry.
+  virtual BVH_Box<T, N> Box() const;
+
+  //! Returns constructed BVH tree.
+  virtual const NCollection_Handle<BVH_Tree<T, N> >& BVH();
+
+  //! Returns the method (builder) to construct BVH.
+  virtual const NCollection_Handle<BVH_Builder<T, N> >& Builder() const;
+
+  //! Sets the method (builder) to construct BVH.
+  virtual void SetBuilder (NCollection_Handle<BVH_Builder<T, N> >& theBuilder);
+
+protected:
+
+  //! Updates internal geometry state.
+  virtual void Update();
+
+protected:
+
+  Standard_Boolean                       myIsDirty; //!< Is geometry state outdated?
+  NCollection_Handle<BVH_Tree<T, N> >    myBVH;     //!< Constructed hight-level BVH
+  NCollection_Handle<BVH_Builder<T, N> > myBuilder; //!< Builder for hight-level BVH
+
+  mutable BVH_Box<T, N> myBox; //!< Cached bounding box of geometric objects
+
+};
+
+#include <BVH_Geometry.lxx>
+
+#endif // _BVH_Geometry_Header