0024473: TKMath, BVH - introduce template-based package for Bounding volume hierarchy...
[occt.git] / src / BVH / BVH_PrimitiveSet.hxx
1 // Created on: 2013-12-20
2 // Created by: Denis BOGOLEPOV
3 // Copyright (c) 2013 OPEN CASCADE SAS
4 //
5 // This file is part of Open CASCADE Technology software library.
6 //
7 // This library is free software; you can redistribute it and / or modify it
8 // under the terms of the GNU Lesser General Public version 2.1 as published
9 // by the Free Software Foundation, with special exception defined in the file
10 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
11 // distribution for complete text of the license and disclaimer of any warranty.
12 //
13 // Alternatively, this file may be used under the terms of Open CASCADE
14 // commercial license or contractual agreement.
15
16 #ifndef _BVH_PrimitiveSet_Header
17 #define _BVH_PrimitiveSet_Header
18
19 #include <BVH_Object.hxx>
20 #include <BVH_Builder.hxx>
21
22 //! Set of abstract geometric primitives.
23 template<class T, int N>
24 class BVH_PrimitiveSet : public BVH_Object<T, N>, public BVH_Set<T, N>
25 {
26   using BVH_Set<T, N>::Box;
27
28 public:
29
30   //! Creates set of abstract primitives.
31   BVH_PrimitiveSet();
32
33   //! Releases resources of set of abstract primitives.
34   virtual ~BVH_PrimitiveSet();
35
36 public:
37
38   //! Returns AABB of primitive set.
39   virtual BVH_Box<T, N> Box() const;
40
41   //! Returns constructed BVH tree.
42   virtual const NCollection_Handle<BVH_Tree<T, N> >& BVH();
43
44   //! Returns the method (builder) to construct BVH.
45   virtual const NCollection_Handle<BVH_Builder<T, N> >& Builder() const;
46
47   //! Sets the method (builder) to construct BVH.
48   virtual void SetBuilder (NCollection_Handle<BVH_Builder<T, N> >& theBuilder);
49
50 protected:
51
52   //! Updates BVH of primitive set.
53   virtual void Update();
54
55 protected:
56
57   NCollection_Handle<BVH_Tree<T, N> >    myBVH;     //!< Constructed bottom-level BVH
58   NCollection_Handle<BVH_Builder<T, N> > myBuilder; //!< Builder for bottom-level BVH
59
60   mutable BVH_Box<T, N> myBox; //!< Cached bounding box of geometric primitives
61
62 };
63
64 #include <BVH_PrimitiveSet.lxx>
65
66 #endif // _BVH_PrimitiveSet_Header