0024473: TKMath, BVH - introduce template-based package for Bounding volume hierarchy...
[occt.git] / src / BVH / BVH_Geometry.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_Geometry_Header
17 #define _BVH_Geometry_Header
18
19 #include <BVH_ObjectSet.hxx>
20 #include <BVH_Builder.hxx>
21
22 //! BVH geometry as a set of abstract geometric objects.
23 template<class T, int N>
24 class BVH_Geometry : public BVH_ObjectSet<T, N>
25 {
26 public:
27
28   //! Creates uninitialized BVH geometry.
29   BVH_Geometry();
30
31   //! Releases resources of BVH geometry.
32   virtual ~BVH_Geometry();
33
34 public:
35
36   //! Marks geometry as outdated.
37   virtual void MarkDirty();
38
39   //! Returns AABB of whole geometry.
40   virtual BVH_Box<T, N> Box() const;
41
42   //! Returns constructed BVH tree.
43   virtual const NCollection_Handle<BVH_Tree<T, N> >& BVH();
44
45   //! Returns the method (builder) to construct BVH.
46   virtual const NCollection_Handle<BVH_Builder<T, N> >& Builder() const;
47
48   //! Sets the method (builder) to construct BVH.
49   virtual void SetBuilder (NCollection_Handle<BVH_Builder<T, N> >& theBuilder);
50
51 protected:
52
53   //! Updates internal geometry state.
54   virtual void Update();
55
56 protected:
57
58   Standard_Boolean                       myIsDirty; //!< Is geometry state outdated?
59   NCollection_Handle<BVH_Tree<T, N> >    myBVH;     //!< Constructed hight-level BVH
60   NCollection_Handle<BVH_Builder<T, N> > myBuilder; //!< Builder for hight-level BVH
61
62   mutable BVH_Box<T, N> myBox; //!< Cached bounding box of geometric objects
63
64 };
65
66 #include <BVH_Geometry.lxx>
67
68 #endif // _BVH_Geometry_Header