0024473: TKMath, BVH - introduce template-based package for Bounding volume hierarchy...
[occt.git] / src / BVH / BVH_Set.hxx
diff --git a/src/BVH/BVH_Set.hxx b/src/BVH/BVH_Set.hxx
new file mode 100644 (file)
index 0000000..e2abaed
--- /dev/null
@@ -0,0 +1,60 @@
+// 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_Set_Header
+#define _BVH_Set_Header
+
+#include <BVH_Box.hxx>
+
+//! Set of abstract entities to build BVH.
+template<class T, int N>
+class BVH_Set
+{
+public:
+
+  typedef BVH_Box<T, N> BVH_BoxNt;
+
+public:
+
+  //! Creates new abstract set of objects.
+  BVH_Set();
+
+  //! Releases resources of set of objects.
+  virtual ~BVH_Set() = 0;
+
+  //! Returns AABB of entire set of objects.
+  virtual BVH_Box<T, N> Box() const;
+
+public:
+
+  //! Return total number of objects.
+  virtual Standard_Integer Size() const = 0;
+
+  //! Returns AABB of specified object.
+  virtual BVH_Box<T, N> Box (const Standard_Integer theIndex) const = 0;
+
+  //! Returns centroid position in specified axis.
+  virtual T Center (const Standard_Integer theIndex,
+                    const Standard_Integer theAxis) const = 0;
+
+  //! Swaps indices of two specified objects in the set.
+  virtual void Swap (const Standard_Integer theIndex1,
+                     const Standard_Integer theIndex2) = 0;
+
+};
+
+#include <BVH_Set.lxx>
+
+#endif // _BVH_Set_Header