0024473: TKMath, BVH - introduce template-based package for Bounding volume hierarchy...
[occt.git] / src / BVH / BVH_Object.hxx
diff --git a/src/BVH/BVH_Object.hxx b/src/BVH/BVH_Object.hxx
new file mode 100644 (file)
index 0000000..c097c59
--- /dev/null
@@ -0,0 +1,59 @@
+// 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_Object_Header
+#define _BVH_Object_Header
+
+#include <BVH_Box.hxx>
+#include <BVH_Properties.hxx>
+
+#include <NCollection_Handle.hxx>
+
+//! Abstract geometric object.
+template<class T, int N>
+class BVH_Object
+{
+public:
+
+  //! Creates new abstract geometric object.
+  BVH_Object();
+
+  //! Releases resources of geometric object.
+  virtual ~BVH_Object() = 0;
+
+public:
+
+  //! Returns AABB of geometric object.
+  virtual BVH_Box<T, N> Box() const = 0;
+
+  //! Returns properties of geometric object.
+  virtual const NCollection_Handle<BVH_Properties>& Properties() const;
+
+  //! Sets properties of geometric object.
+  virtual void SetProperties (const NCollection_Handle<BVH_Properties>& theProperties);
+
+  //! Marks object state as outdated.
+  virtual void MarkDirty();
+
+protected:
+
+  Standard_Boolean                   myIsDirty;    //!< Marks that internal object state need to be updated
+  NCollection_Handle<BVH_Properties> myProperties; //!< Generic properties assigned to the object
+
+};
+
+#include <BVH_Object.lxx>
+
+#endif // _BVH_Object_Header