0024002: Overall code and build procedure refactoring -- automatic
[occt.git] / src / BndLib / BndLib_Add3dCurve.hxx
diff --git a/src/BndLib/BndLib_Add3dCurve.hxx b/src/BndLib/BndLib_Add3dCurve.hxx
new file mode 100644 (file)
index 0000000..009abe2
--- /dev/null
@@ -0,0 +1,118 @@
+// Created on: 1993-07-08
+// Created by: Isabelle GRIGNON
+// Copyright (c) 1993-1999 Matra Datavision
+// Copyright (c) 1999-2014 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 License 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 _BndLib_Add3dCurve_HeaderFile
+#define _BndLib_Add3dCurve_HeaderFile
+
+#include <Standard.hxx>
+#include <Standard_DefineAlloc.hxx>
+#include <Standard_Handle.hxx>
+
+#include <Standard_Real.hxx>
+class Adaptor3d_Curve;
+class Bnd_Box;
+
+
+//! Computes the bounding box for a curve in 3d.
+//! Functions to add a 3D curve to a bounding box.
+//! The 3D curve is defined from a Geom curve.
+class BndLib_Add3dCurve 
+{
+public:
+
+  DEFINE_STANDARD_ALLOC
+
+  
+  //! Adds to the bounding box B the curve C
+  //! B is then enlarged by the tolerance value Tol.
+  //! Note: depending on the type of curve, one of the following
+  //! representations of the curve C is used to include it in the bounding box B:
+  //! -   an exact representation if C is built from a line, a circle   or a conic curve,
+  //! -   the poles of the curve if C is built from a Bezier curve or   a BSpline curve,
+  //! if not, the points of an approximation of the curve C.
+  //! Warning
+  //! C is an adapted curve, that is, an object which is an interface between:
+  //! -   the services provided by a 3D curve from the package   Geom
+  //! -   and those required of the curve by the computation algorithm.
+  //! The adapted curve is created in the following way:
+  //! Handle(Geom_Curve) mycurve = ... ;
+  //! GeomAdaptor_Curve C(mycurve);
+  //! The bounding box B is then enlarged by adding it:
+  //! Bnd_Box B;
+  //! // ...
+  //! Standard_Real Tol = ... ;
+  //! Add3dCurve::Add ( C, Tol, B );
+  //! Exceptions
+  //! Standard_Failure if the curve is built from:
+  //! -   a Geom_Line, or
+  //! -   a Geom_Parabola, or
+  //! -   a Geom_Hyperbola,
+  //! and P1 and P2 are either two negative infinite real
+  //! numbers, or two positive infinite real numbers.
+  Standard_EXPORT static void Add (const Adaptor3d_Curve& C, const Standard_Real Tol, Bnd_Box& B);
+  
+  //! Adds to the bounding box B the curve C
+  //! the arc of the curve C limited by the two parameter values P1 and P2.
+  //! Note: depending on the type of curve, one of the following
+  //! representations of the curve C is used to include it in the bounding box B:
+  //! -   an exact representation if C is built from a line, a circle   or a conic curve,
+  //! -   the poles of the curve if C is built from a Bezier curve or   a BSpline curve,
+  //! if not, the points of an approximation of the curve C.
+  //! Warning
+  //! C is an adapted curve, that is, an object which is an interface between:
+  //! -   the services provided by a 3D curve from the package   Geom
+  //! -   and those required of the curve by the computation algorithm.
+  //! The adapted curve is created in the following way:
+  //! Handle(Geom_Curve) mycurve = ... ;
+  //! GeomAdaptor_Curve C(mycurve);
+  //! The bounding box B is then enlarged by adding it:
+  //! Bnd_Box B;
+  //! // ...
+  //! Standard_Real Tol = ... ;
+  //! Add3dCurve::Add ( C, Tol, B );
+  //! Exceptions
+  //! Standard_Failure if the curve is built from:
+  //! -   a Geom_Line, or
+  //! -   a Geom_Parabola, or
+  //! -   a Geom_Hyperbola,
+  //! and P1 and P2 are either two negative infinite real
+  //! numbers, or two positive infinite real numbers.
+  Standard_EXPORT static void Add (const Adaptor3d_Curve& C, const Standard_Real U1, const Standard_Real U2, const Standard_Real Tol, Bnd_Box& B);
+
+
+
+
+protected:
+
+
+
+
+
+private:
+
+
+
+
+
+};
+
+
+
+
+
+
+
+#endif // _BndLib_Add3dCurve_HeaderFile