include/opencascade/GeomBndLib_Hyperbola.hxx

0001 // Copyright (c) 2025 OPEN CASCADE SAS
0002 //
0003 // This file is part of Open CASCADE Technology software library.
0004 //
0005 // This library is free software; you can redistribute it and/or modify it under
0006 // the terms of the GNU Lesser General Public License version 2.1 as published
0007 // by the Free Software Foundation, with special exception defined in the file
0008 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0009 // distribution for complete text of the license and disclaimer of any warranty.
0010 //
0011 // Alternatively, this file may be used under the terms of Open CASCADE
0012 // commercial license or contractual agreement.
0013
0014 #ifndef GeomBndLib_Hyperbola_HeaderFile
0015 #define GeomBndLib_Hyperbola_HeaderFile
0016
0017 #include <Bnd_Box.hxx>
0018 #include <Geom_Hyperbola.hxx>
0019 #include <Standard.hxx>
0020 #include <Standard_DefineAlloc.hxx>
0021 #include <gp_Hypr.hxx>
0022
0023 //! Computes bounding box for a 3D hyperbola (Geom_Hyperbola).
0024 //! Handles infinite parameters by opening the box in appropriate directions.
0025 //!
0026 //! Static method accepting gp_Hypr can be used directly without
0027 //! constructing a Geom_Hyperbola handle.
0028 class GeomBndLib_Hyperbola
0029 {
0030 public:
0031   DEFINE_STANDARD_ALLOC
0032
0033   GeomBndLib_Hyperbola(const occ::handle<Geom_Hyperbola>& theHyperbola)
0034       : myGeom(theHyperbola)
0035   {
0036   }
0037
0038   GeomBndLib_Hyperbola(const GeomBndLib_Hyperbola&)            = delete;
0039   GeomBndLib_Hyperbola& operator=(const GeomBndLib_Hyperbola&) = delete;
0040   GeomBndLib_Hyperbola(GeomBndLib_Hyperbola&&)                 = delete;
0041   GeomBndLib_Hyperbola& operator=(GeomBndLib_Hyperbola&&)      = delete;
0042
0043   const occ::handle<Geom_Hyperbola>& Geometry() const { return myGeom; }
0044
0045   //! Compute bounding box for arc [theU1, theU2].
0046   [[nodiscard]] Bnd_Box Box(double theU1, double theU2, double theTol) const
0047   {
0048     return Box(myGeom->Hypr(), theU1, theU2, theTol);
0049   }
0050
0051   //! Compute bounding box for full curve.
0052   [[nodiscard]] Bnd_Box Box(double theTol) const
0053   {
0054     return Box(myGeom->FirstParameter(), myGeom->LastParameter(), theTol);
0055   }
0056
0057   //! For analytical curves, BoxOptimal is same as Box.
0058   [[nodiscard]] Bnd_Box BoxOptimal(double theU1, double theU2, double theTol) const
0059   {
0060     return Box(theU1, theU2, theTol);
0061   }
0062
0063   //! Compute bounding box for a hyperbola arc [theU1, theU2] defined by gp_Hypr.
0064   [[nodiscard]] Standard_EXPORT static Bnd_Box Box(const gp_Hypr& theHypr,
0065                                                    double         theU1,
0066                                                    double         theU2,
0067                                                    double         theTol);
0068
0069 private:
0070   occ::handle<Geom_Hyperbola> myGeom;
0071 };
0072
0073 #endif // GeomBndLib_Hyperbola_HeaderFile