include/opencascade/TopOpeBRepBuild_CompositeClassifier.hxx

0001 // Created on: 1996-01-05
0002 // Created by: Jean Yves LEBEY
0003 // Copyright (c) 1996-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _TopOpeBRepBuild_CompositeClassifier_HeaderFile
0018 #define _TopOpeBRepBuild_CompositeClassifier_HeaderFile
0019
0020 #include <Standard.hxx>
0021 #include <Standard_DefineAlloc.hxx>
0022 #include <Standard_Handle.hxx>
0023
0024 #include <TopOpeBRepBuild_LoopClassifier.hxx>
0025 #include <TopAbs_State.hxx>
0026 class TopOpeBRepBuild_BlockBuilder;
0027 class TopOpeBRepBuild_Loop;
0028 class TopoDS_Shape;
0029
0030 //! classify composite Loops, i.e, loops that can be either a Shape, or
0031 //! a block of Elements.
0032 class TopOpeBRepBuild_CompositeClassifier : public TopOpeBRepBuild_LoopClassifier
0033 {
0034 public:
0035   DEFINE_STANDARD_ALLOC
0036
0037   Standard_EXPORT TopAbs_State Compare(const occ::handle<TopOpeBRepBuild_Loop>& L1,
0038                                        const occ::handle<TopOpeBRepBuild_Loop>& L2) override;
0039
0040   //! classify shape <B1> with shape <B2>
0041   Standard_EXPORT virtual TopAbs_State CompareShapes(const TopoDS_Shape& B1,
0042                                                      const TopoDS_Shape& B2) = 0;
0043
0044   //! classify element <E> with shape <B>
0045   Standard_EXPORT virtual TopAbs_State CompareElementToShape(const TopoDS_Shape& E,
0046                                                              const TopoDS_Shape& B) = 0;
0047
0048   //! prepare classification involving shape <B>
0049   //! calls ResetElement on first element of <B>
0050   Standard_EXPORT virtual void ResetShape(const TopoDS_Shape& B) = 0;
0051
0052   //! prepare classification involving element <E>.
0053   Standard_EXPORT virtual void ResetElement(const TopoDS_Shape& E) = 0;
0054
0055   //! Add element <E> in the set of elements used in classification.
0056   //! Returns FALSE if the element <E> has been already added to the set of elements,
0057   //! otherwise returns TRUE.
0058   Standard_EXPORT virtual bool CompareElement(const TopoDS_Shape& E) = 0;
0059
0060   //! Returns state of classification of 2D point, defined by
0061   //! ResetElement, with the current set of elements, defined by Compare.
0062   Standard_EXPORT virtual TopAbs_State State() = 0;
0063
0064 protected:
0065   Standard_EXPORT TopOpeBRepBuild_CompositeClassifier(const TopOpeBRepBuild_BlockBuilder& BB);
0066
0067   void* myBlockBuilder;
0068 };
0069
0070 #endif // _TopOpeBRepBuild_CompositeClassifier_HeaderFile