0028495: The maximal depth of the tree is used implicitly in type 'BVH_PrimitiveSet'
[occt.git] / src / BVH / BVH_PrimitiveSet.hxx
1 // Created on: 2013-12-20
2 // Created by: Denis BOGOLEPOV
3 // Copyright (c) 2013-2014 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 under
8 // the terms of the GNU Lesser General Public License 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 organized with bounding
23 //! volume hierarchy (BVH). Unlike an object set, this collection
24 //! is designed for storing structural elements of a single object
25 //! (such as triangles in the object triangulation). Because there
26 //! may be a large number of such elements, the implementations of
27 //! this interface should be sufficiently optimized.
28 //! \tparam T Numeric data type
29 //! \tparam N Vector dimension
30 template<class T, int N>
31 class BVH_PrimitiveSet : public BVH_Object<T, N>, public BVH_Set<T, N>
32 {
33 protected:
34
35   using BVH_Set<T, N>::Box;
36
37 public:
38   static const Standard_Integer MaxTreeDepth = 32;
39
40   //! Creates set of abstract primitives.
41   BVH_PrimitiveSet();
42
43   //! Releases resources of set of abstract primitives.
44   virtual ~BVH_PrimitiveSet();
45
46 public:
47
48   //! Returns AABB of primitive set.
49   virtual BVH_Box<T, N> Box() const;
50
51   //! Returns BVH tree (and builds it if necessary).
52   virtual const NCollection_Handle<BVH_Tree<T, N> >& BVH();
53
54   //! Returns the method (builder) used to construct BVH.
55   virtual const NCollection_Handle<BVH_Builder<T, N> >& Builder() const;
56
57   //! Sets the method (builder) used to construct BVH.
58   virtual void SetBuilder (NCollection_Handle<BVH_Builder<T, N> >& theBuilder);
59
60 protected:
61
62   //! Updates BVH of primitive set.
63   virtual void Update();
64
65 protected:
66
67   NCollection_Handle<BVH_Tree<T, N> >    myBVH;     //!< Constructed bottom-level BVH
68   NCollection_Handle<BVH_Builder<T, N> > myBuilder; //!< Builder for bottom-level BVH
69
70   mutable BVH_Box<T, N> myBox; //!< Cached bounding box of geometric primitives
71
72 };
73
74 #include <BVH_PrimitiveSet.lxx>
75
76 #endif // _BVH_PrimitiveSet_Header