src/TopOpeBRepBuild/TopOpeBRepBuild_CompositeClassifier.hxx

   1 // Created on: 1996-01-05
   2 // Created by: Jean Yves LEBEY
   3 // Copyright (c) 1996-1999 Matra Datavision
   4 // Copyright (c) 1999-2014 OPEN CASCADE SAS
   5 //
   6 // This file is part of Open CASCADE Technology software library.
   7 //
   8 // This library is free software; you can redistribute it and/or modify it under
   9 // the terms of the GNU Lesser General Public License version 2.1 as published
  10 // by the Free Software Foundation, with special exception defined in the file
  11 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
  12 // distribution for complete text of the license and disclaimer of any warranty.
  13 //
  14 // Alternatively, this file may be used under the terms of Open CASCADE
  15 // commercial license or contractual agreement.
  16
  17 #ifndef _TopOpeBRepBuild_CompositeClassifier_HeaderFile
  18 #define _TopOpeBRepBuild_CompositeClassifier_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <Standard_Address.hxx>
  25 #include <TopOpeBRepBuild_LoopClassifier.hxx>
  26 #include <TopAbs_State.hxx>
  27 #include <Standard_Boolean.hxx>
  28 class TopOpeBRepBuild_BlockBuilder;
  29 class TopOpeBRepBuild_Loop;
  30 class TopoDS_Shape;
  31
  32
  33
  34 //! classify composite Loops, i.e, loops that can be either a Shape, or
  35 //! a block of Elements.
  36 class TopOpeBRepBuild_CompositeClassifier  : public TopOpeBRepBuild_LoopClassifier
  37 {
  38 public:
  39
  40   DEFINE_STANDARD_ALLOC
  41
  42
  43   Standard_EXPORT virtual TopAbs_State Compare (const Handle(TopOpeBRepBuild_Loop)& L1, const Handle(TopOpeBRepBuild_Loop)& L2) Standard_OVERRIDE;
  44
  45   //! classify shape <B1> with shape <B2>
  46   Standard_EXPORT virtual TopAbs_State CompareShapes (const TopoDS_Shape& B1, const TopoDS_Shape& B2) = 0;
  47
  48   //! classify element <E> with shape <B>
  49   Standard_EXPORT virtual TopAbs_State CompareElementToShape (const TopoDS_Shape& E, const TopoDS_Shape& B) = 0;
  50
  51   //! prepare classification involving shape <B>
  52   //! calls ResetElement on first element of <B>
  53   Standard_EXPORT virtual void ResetShape (const TopoDS_Shape& B) = 0;
  54
  55   //! prepare classification involving element <E>.
  56   Standard_EXPORT virtual void ResetElement (const TopoDS_Shape& E) = 0;
  57
  58   //! Add element <E> in the set of elements used in classification.
  59   //! Returns FALSE if the element <E> has been already added to the set of elements,
  60   //! otherwise returns TRUE.
  61   Standard_EXPORT virtual Standard_Boolean CompareElement (const TopoDS_Shape& E) = 0;
  62
  63   //! Returns state of classification of 2D point, defined by
  64   //! ResetElement, with the current set of elements, defined by Compare.
  65   Standard_EXPORT virtual TopAbs_State State() = 0;
  66
  67
  68
  69
  70 protected:
  71
  72
  73   Standard_EXPORT TopOpeBRepBuild_CompositeClassifier(const TopOpeBRepBuild_BlockBuilder& BB);
  74
  75
  76   Standard_Address myBlockBuilder;
  77
  78
  79 private:
  80
  81
  82
  83
  84
  85 };
  86
  87
  88
  89
  90
  91
  92
  93 #endif // _TopOpeBRepBuild_CompositeClassifier_HeaderFile