-- Created on: 1993-10-14
-- Created by: Remi LEQUETTE
-- Copyright (c) 1993-1999 Matra Datavision
-- 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.

deferred class BooleanOperation from BRepAlgoAPI
    inherits BuilderAlgo from BRepAlgoAPI

     ---Purpose: The abstract class BooleanOperation is the root
     -- class of Boolean Operations (see Overview).
     -- Boolean Operations algorithm is divided onto two parts.
     -- -      The first one is computing interference between arguments.
     -- -      The second one is building the result of operation.
     -- The BooleanOperation class provides execution of both parts
     -- of the Boolean Operations algorithm. The second part
     -- (building the result) depends on given type of the Boolean
     -- Operation (see Constructor).
  
uses

    Shape from TopoDS, 
    DataMapOfShapeShape from TopTools, 
    ListOfShape from TopTools,
    Operation   from BOPAlgo,
    PaveFiller from BOPAlgo
    
is 
    Initialize
        returns BooleanOperation from BRepAlgoAPI; 

    Initialize (S1 :Shape from TopoDS;  
                S2 :Shape from TopoDS; 
                anOperation:Operation from BOPAlgo); 
    
    ---Purpose: Prepares the operations for S1 and S2.
     
    Initialize (S1   :Shape from TopoDS; 
                S2   :Shape from TopoDS; 
                aPF  :PaveFiller from BOPAlgo;               
                anOperation:Operation from BOPAlgo); 
     ---Purpose: Prepares the operations for S1 and S2.

   
    
    SetShape1(me:out; 
            S:Shape from TopoDS); 

    SetShape2(me:out; 
            S:Shape from TopoDS);  
 
    Shape1(me)   
        returns Shape from TopoDS 
        is static; 
    ---Purpose: Returns the first shape involved in this Boolean operation.
    ---C++: return const &
    ---C++: alias "Standard_EXPORT virtual ~BRepAlgoAPI_BooleanOperation();" 

    Shape2(me)  
        returns Shape from TopoDS 
        is static;
    ---Purpose: Returns the second shape involved in this Boolean operation.
    ---C++: return const &
       
    SetOperation (me:out; 
            anOp:  Operation from BOPAlgo); 
    ---Purpose:  Sets the type of Boolean operation to perform      
    ---          It can be BOPAlgo_SECTION 
    ---                    BOPAlgo_COMMON 
    ---                    BOPAlgo_FUSE 
    ---                    BOPAlgo_CUT 
    ---                    BOPAlgo_CUT21 
    ---  
     
    Operation  (me) 
        returns Operation from BOPAlgo;
    ---Purpose: Returns the type of Boolean Operation that has been performed.  
   
    Build  (me:out) 
        is redefined virtual; 
    ---Purpose: Provides the algorithm of Boolean Operations
    -- -      Filling interference Data Structure (if it is necessary)
    -- -      Building the result of the operation. 
     
    BuilderCanWork(me)  
        returns Boolean from Standard;  
 
    FuseEdges(me)   
        returns Boolean from Standard;
    ---Purpose: Returns the flag of edge refining  
     
    RefineEdges(me:out);
    ---Purpose: Fuse C1 edges
     
     SectionEdges (me:  in  out)  
        returns ListOfShape from TopTools;    
    --- Purpose: Returns a list of section edges.
    -- The edges represent the result of intersection between arguments of
    -- Boolean Operation. They are computed during operation execution.
    ---C++:  return const &  
         
    Modified (me: in out;  
            aS : Shape from TopoDS) 
        returns ListOfShape from TopTools
        is redefined virtual;
    ---Purpose: Returns the list  of shapes modified from the shape <S>. 
    ---C++: return const & 

    IsDeleted (me: in out;  
            aS : Shape from TopoDS)
        returns Boolean
        is redefined virtual;
    ---Purpose: Returns true if the shape S has been deleted. The
    -- result shape of the operation does not contain the shape S.
        
    Generated (me: in out;  
            S : Shape from TopoDS)
        returns ListOfShape from TopTools
        is redefined virtual;
    ---Purpose: Returns the list  of shapes generated from the shape <S>.
    ---         For use in BRepNaming.
    ---C++:  return const &
    
    HasModified (me) 
        returns Boolean from Standard
        is virtual;
    ---Purpose: Returns true if there is at least one modified shape.
    ---         For use in BRepNaming.

    HasGenerated (me)
        returns Boolean from Standard
        is virtual;
    ---Purpose: Returns true if there is at least one generated shape.
    ---         For use in BRepNaming.

    HasDeleted (me)
        returns Boolean from Standard
        is virtual;
    ---Purpose: Returns true if there is at least one deleted shape.
    ---         For use in BRepNaming.
 
    --  
    -- protected 
    --    
    PrepareFiller(me:out) 
        returns Boolean from Standard 
        is protected;      
       
    RefinedList (me:  in  out;  
            theL : ListOfShape from TopTools)  
        returns ListOfShape from TopTools
        is protected;
    ---Purpose: Returns the list  of shapes generated from the shape <S>.
    ---         For use in BRepNaming.
    ---C++:  return const &
    
fields
    myS1       : Shape from TopoDS        is protected;
    myS2       : Shape from TopoDS        is protected;
    myOperation: Operation from BOPAlgo   is protected;   
    --
    myEntryType: Integer from Standard is protected;    
    myBuilderCanWork : Boolean from Standard is protected;  
     
    --    for  edge  refiner
    myFuseEdges      : Boolean from Standard ; 
    myModifFaces     : DataMapOfShapeShape from TopTools;   
    myEdgeMap        : DataMapOfShapeShape from TopTools; 
    
end BooleanOperation;