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

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

 // Created by: Peter KURNEV
 // 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 _BOPDS_CommonBlock_HeaderFile
 #define _BOPDS_CommonBlock_HeaderFile
 
 #include <Standard.hxx>
 #include <Standard_Type.hxx>
 
 #include <BOPDS_ListOfPaveBlock.hxx>
 #include <NCollection_BaseAllocator.hxx>
 #include <Standard_Integer.hxx>
 #include <Standard_Transient.hxx>
 #include <TColStd_ListOfInteger.hxx>
 class BOPDS_PaveBlock;
 
 
 class BOPDS_CommonBlock;
 DEFINE_STANDARD_HANDLE(BOPDS_CommonBlock, Standard_Transient)
 
 
 //! The class BOPDS_CommonBlock is to store the information
 //! about pave blocks that have geometrical coincidence
 //! (in terms of a tolerance) with:<br>
 //! a) other pave block(s);<br>
 //! b) face(s).<br>
 //! First pave block in the common block (real pave block)
 //! is always a pave block with the minimal index of the original edge.
 class BOPDS_CommonBlock : public Standard_Transient
 {
 
 public:
 
   
 
   //! Empty constructor
   Standard_EXPORT BOPDS_CommonBlock();
   
 
   //! Constructor
   //! @param theAllocator the allocator to manage the memory
   Standard_EXPORT BOPDS_CommonBlock(const Handle(NCollection_BaseAllocator)& theAllocator);
   
 
   //! Modifier
   //! Adds the pave block <aPB> to the list of pave blocks
   //! of the common block
   Standard_EXPORT void AddPaveBlock (const Handle(BOPDS_PaveBlock)& aPB);
   
 
   //! Modifier
   //! Sets the list of pave blocks for the common block
   Standard_EXPORT void SetPaveBlocks (const BOPDS_ListOfPaveBlock& aLPB);
   
 
   //! Modifier
   //! Adds the index of the face <aF>
   //! to the list of indices of faces
   //! of the common block
   Standard_EXPORT void AddFace (const Standard_Integer aF);
   
 
   //! Modifier
   //! Sets the list of indices of faces <aLF>
   //! of the common block
   Standard_EXPORT void SetFaces (const TColStd_ListOfInteger& aLF);
 
   //! Modifier
   //! Appends the list of indices of faces <aLF>
   //! to the list of indices of faces
   //! of the common block (the input list is emptied)
   Standard_EXPORT void AppendFaces(TColStd_ListOfInteger& aLF);
 
 
   //! Selector
   //! Returns the list of pave blocks
   //! of the common block
   Standard_EXPORT const BOPDS_ListOfPaveBlock& PaveBlocks() const;
   
 
   //! Selector
   //! Returns the list of indices of faces
   //! of the common block
   Standard_EXPORT const TColStd_ListOfInteger& Faces() const;
   
 
   //! Selector
   //! Returns the first pave block
   //! of the common block
   Standard_EXPORT const Handle(BOPDS_PaveBlock)& PaveBlock1() const;
   
 
   //! Selector
   //! Returns the pave block that belongs
   //! to the edge with index <theIx>
   Standard_EXPORT Handle(BOPDS_PaveBlock)& PaveBlockOnEdge (const Standard_Integer theIndex);
   
 
   //! Query
   //! Returns true if the common block contains
   //! a pave block that belongs
   //! to the face with index <theIx>
   Standard_EXPORT Standard_Boolean IsPaveBlockOnFace (const Standard_Integer theIndex) const;
   
 
   //! Query
   //! Returns true if the common block contains
   //! a pave block that belongs
   //! to the edge with index <theIx>
   Standard_EXPORT Standard_Boolean IsPaveBlockOnEdge (const Standard_Integer theIndex) const;
   
 
   //! Query
   //! Returns true if the common block contains
   //! a pave block that is equal  to <thePB>
   Standard_EXPORT Standard_Boolean Contains (const Handle(BOPDS_PaveBlock)& thePB) const;
   
 
   //! Query
   //! Returns true if the common block contains
   //! the face with index equal  to <theF>
   Standard_EXPORT Standard_Boolean Contains (const Standard_Integer theF) const;
   
 
   //! Modifier
   //! Assign the index <theEdge> as the edge index
   //! to all pave blocks of the common block
   Standard_EXPORT void SetEdge (const Standard_Integer theEdge);
   
 
   //! Selector
   //! Returns the index of the edge
   //! of  all pave blocks of the common block
   Standard_EXPORT Standard_Integer Edge() const;
   
   Standard_EXPORT void Dump() const;
 
   //! Moves the pave blocks in the list to make the given
   //! pave block to be the first.
   //! It will be representative for the whole group.
   Standard_EXPORT void SetRealPaveBlock(const Handle(BOPDS_PaveBlock)& thePB);
 
   //! Sets the tolerance for the common block
   void SetTolerance(const Standard_Real theTol)
   {
     myTolerance = theTol;
   }
 
   //! Return the tolerance of common block
   Standard_Real Tolerance() const
   {
     return myTolerance;
   }
 
   DEFINE_STANDARD_RTTIEXT(BOPDS_CommonBlock,Standard_Transient)
 
 protected:
 
   BOPDS_ListOfPaveBlock myPaveBlocks; //!< Pave blocks of the common block
   TColStd_ListOfInteger myFaces;      //!< Faces on which the pave blocks are lying
   Standard_Real myTolerance;          //!< Tolerance of the common block
 
 private:
 
 };
 
 #endif // _BOPDS_CommonBlock_HeaderFile

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