EIC code displayed by LXR master/​include/​opencascade/​Bnd_Box2d.hxx	Source navigation Diff markup Identifier search General search
	Version: master test Revert   Change

File indexing completed on 2025-01-18 10:03:03

 // Created on: 1991-01-28
 // Created by: Remi Lequette
 // Copyright (c) 1991-1999 Matra Datavision
 // Copyright (c) 1999-2012 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 _Bnd_Box2d_HeaderFile
 #define _Bnd_Box2d_HeaderFile
 
 #include <gp_Lin2d.hxx>
 #include <gp_Pnt2d.hxx>
 #include <Standard.hxx>
 #include <Standard_DefineAlloc.hxx>
 #include <Standard_Handle.hxx>
 
 #include <Standard_Real.hxx>
 #include <Standard_Integer.hxx>
 #include <Standard_Boolean.hxx>
 class gp_Dir2d;
 class gp_Trsf2d;
 
 
 //! Describes a bounding box in 2D space.
 //! A bounding box is parallel to the axes of the coordinates
 //! system. If it is finite, it is defined by the two intervals:
 //! -   [ Xmin,Xmax ], and
 //! -   [ Ymin,Ymax ].
 //! A bounding box may be infinite (i.e. open) in one or more
 //! directions. It is said to be:
 //! -   OpenXmin if it is infinite on the negative side of the   "X Direction";
 //! -   OpenXmax if it is infinite on the positive side of the   "X Direction";
 //! -   OpenYmin if it is infinite on the negative side of the   "Y Direction";
 //! -   OpenYmax if it is infinite on the positive side of the   "Y Direction";
 //! -   WholeSpace if it is infinite in all four directions. In
 //! this case, any point of the space is inside the box;
 //! -   Void if it is empty. In this case, there is no point included in the box.
 //! A bounding box is defined by four bounds (Xmin, Xmax, Ymin and Ymax) which
 //! limit the bounding box if it is finite, six flags (OpenXmin, OpenXmax, OpenYmin,
 //! OpenYmax, WholeSpace and Void) which describe the bounding box if it is infinite or empty, and
 //! -   a gap, which is included on both sides in any direction when consulting the finite bounds of the box.
 class Bnd_Box2d 
 {
 public:
 
   DEFINE_STANDARD_ALLOC
 
   //! Creates an empty 2D bounding box.
   //! The constructed box is qualified Void. Its gap is null.
   Bnd_Box2d() : Xmin(0.), Xmax(0.), Ymin(0.), Ymax(0.), Gap(0.), Flags (VoidMask) {}
 
   //! Sets this bounding box so that it covers the whole 2D
   //! space, i.e. it is infinite in all directions.
   void SetWhole() { Flags = WholeMask; }
 
   //! Sets this 2D bounding box so that it is empty. All points are outside a void box.
   void SetVoid()
   {
     Flags = VoidMask;
     Gap   = 0.0;
   }
 
   //! Sets this 2D bounding box so that it bounds
   //! the point P. This involves first setting this bounding box
   //! to be void and then adding the point PThe rectangle bounds   the  point <P>.
   void Set (const gp_Pnt2d& thePnt)
   {
     Flags = VoidMask;
     Gap   = 0.0;
     Add (thePnt);
   }
 
   //! Sets this 2D bounding box so that it bounds
   //! the half-line defined by point P and direction D, i.e. all
   //! points M defined by M=P+u*D, where u is greater than
   //! or equal to 0, are inside the bounding area. This involves
   //! first setting this 2D box to be void and then adding the   half-line.
   void Set (const gp_Pnt2d& thePnt, const gp_Dir2d& theDir)
   {
     Flags = VoidMask;
     Gap   = 0.0;
     Add (thePnt, theDir);
   }
 
   //! Enlarges this 2D bounding box, if required, so that it
   //! contains at least:
   //! -   interval [ aXmin,aXmax ] in the "X Direction",
   //! -   interval [ aYmin,aYmax ] in the "Y Direction"
   Standard_EXPORT void Update (const Standard_Real aXmin, const Standard_Real aYmin, const Standard_Real aXmax, const Standard_Real aYmax);
   
   //! Adds a point of coordinates (X,Y) to this bounding box.
   Standard_EXPORT void Update (const Standard_Real X, const Standard_Real Y);
   
   //! Returns the gap of this 2D bounding box.
   Standard_Real GetGap() const { return Gap; }
 
   //! Set the gap of this 2D bounding box to abs(Tol).
   void SetGap (const Standard_Real Tol) { Gap = Tol; }
 
   //! Enlarges     the  box  with    a  tolerance  value.
   //! This means that the minimum values of its X and Y
   //! intervals of definition, when they are finite, are reduced by
   //! the absolute value of Tol, while the maximum values are
   //! increased by the same amount.
   void Enlarge (const Standard_Real theTol)
   {
     Standard_Real aTol = theTol < 0.0 ? -theTol : theTol;
     if (Gap < aTol) Gap = aTol;
   }
 
   //! Returns the bounds of this 2D bounding box.
   //! The gap is included. If this bounding box is infinite (i.e. "open"), returned values
   //! may be equal to +/- Precision::Infinite().
   //! if IsVoid()
   Standard_EXPORT void Get (Standard_Real& aXmin, Standard_Real& aYmin, Standard_Real& aXmax, Standard_Real& aYmax) const;
 
   //! The Box will be infinitely long in the Xmin direction.
   void OpenXmin() { Flags |= XminMask; }
 
   //! The Box will be infinitely long in the Xmax direction.
   void OpenXmax() { Flags |= XmaxMask; }
 
   //! The Box will be infinitely long in the Ymin direction.
   void OpenYmin() { Flags |= YminMask; }
 
   //! The Box will be infinitely long in the Ymax direction.
   void OpenYmax() { Flags |= YmaxMask; }
 
   //! Returns true if this bounding box is open in the Xmin direction.
   Standard_Boolean IsOpenXmin() const { return (Flags & XminMask) != 0; }
 
   //! Returns true if this bounding box is open in the Xmax direction.
   Standard_Boolean IsOpenXmax() const { return (Flags & XmaxMask) != 0; }
 
   //! Returns true if this bounding box is open in the Ymin direction.
   Standard_Boolean IsOpenYmin() const { return (Flags & YminMask) != 0; }
 
   //! Returns true if this bounding box is open in the Ymax direction.
   Standard_Boolean IsOpenYmax() const { return (Flags & YmaxMask) != 0; }
 
   //! Returns true if this bounding box is infinite in all 4
   //! directions (Whole Space flag).
   Standard_Boolean IsWhole() const { return (Flags & WholeMask) == WholeMask; }
 
   //! Returns true if this 2D bounding box is empty (Void flag).
   Standard_Boolean IsVoid() const { return (Flags & VoidMask) != 0; }
 
   //! Returns a bounding box which is the result of applying the
   //! transformation T to this bounding box.
   //! Warning
   //! Applying a geometric transformation (for example, a
   //! rotation) to a bounding box generally increases its
   //! dimensions. This is not optimal for algorithms which use it.
   Standard_NODISCARD Standard_EXPORT Bnd_Box2d Transformed (const gp_Trsf2d& T) const;
   
   //! Adds the 2d box <Other> to <me>.
   Standard_EXPORT void Add (const Bnd_Box2d& Other);
   
   //! Adds the 2d point.
   void Add (const gp_Pnt2d& thePnt) { Update (thePnt.X(), thePnt.Y()); }
 
   //! Extends bounding box from thePnt in the direction theDir.
   void Add (const gp_Pnt2d& thePnt, const gp_Dir2d& theDir)
   {
     Add (thePnt);
     Add (theDir);
   }
   
   //! Extends the Box  in the given Direction, i.e. adds
   //! a half-line. The box may become infinite in 1 or 2
   //! directions.
   Standard_EXPORT void Add (const gp_Dir2d& D);
   
   //! Returns True if the 2d pnt <P> is out <me>.
   Standard_EXPORT Standard_Boolean IsOut (const gp_Pnt2d& P) const;
 
   //! Returns True if the line doesn't intersect the box.
   Standard_EXPORT Standard_Boolean IsOut(const gp_Lin2d& theL) const;
   
   //! Returns True if the segment doesn't intersect the box.
   Standard_EXPORT Standard_Boolean IsOut(const gp_Pnt2d& theP0, const gp_Pnt2d& theP1) const;
 
   //! Returns True if <Box2d> is out <me>.
   Standard_EXPORT Standard_Boolean IsOut (const Bnd_Box2d& Other) const;
   
   //! Returns True if transformed <Box2d> is out <me>.
   Standard_Boolean IsOut (const Bnd_Box2d& theOther, const gp_Trsf2d& theTrsf) const
   {
     return IsOut (theOther.Transformed (theTrsf));
   }
 
   //! Compares  a transformed  bounding with  a    transformed
   //! bounding. The default implementation is  to make a copy
   //! of <me> and <Other>, to transform them and to test.
   Standard_Boolean IsOut (const gp_Trsf2d& T1, const Bnd_Box2d& Other, const gp_Trsf2d& T2) const
   {
     return Transformed(T1).IsOut (Other.Transformed(T2));
   }
 
   Standard_EXPORT void Dump() const;
   
   //! Computes the squared diagonal of me.
   Standard_Real SquareExtent() const
   {
     if (IsVoid()) return 0.0;
     const Standard_Real aDx = Xmax - Xmin + Gap + Gap;
     const Standard_Real aDy = Ymax - Ymin + Gap + Gap;
     return aDx*aDx + aDy*aDy;
   }
 
 protected:
 
   //! Bit flags.
   enum MaskFlags
   {
     VoidMask  = 0x01,
     XminMask  = 0x02,
     XmaxMask  = 0x04,
     YminMask  = 0x08,
     YmaxMask  = 0x10,
     WholeMask = 0x1e
   };
 
 private:
 
   Standard_Real Xmin;
   Standard_Real Xmax;
   Standard_Real Ymin;
   Standard_Real Ymax;
   Standard_Real Gap;
   Standard_Integer Flags;
 
 };
 
 #endif // _Bnd_Box2d_HeaderFile

This page was automatically generated by the 2.3.7 LXR engine. The LXR team