src/BRepFeat/BRepFeat_MakePipe.cdl

   1 -- Created on: 1996-09-03
   2 -- Created by: Jacques GOUSSARD
   3 -- Copyright (c) 1996-1999 Matra Datavision
   4 -- Copyright (c) 1999-2012 OPEN CASCADE SAS
   5 --
   6 -- The content of this file is subject to the Open CASCADE Technology Public
   7 -- License Version 6.5 (the "License"). You may not use the content of this file
   8 -- except in compliance with the License. Please obtain a copy of the License
   9 -- at http://www.opencascade.org and read it completely before using this file.
  10 --
  11 -- The Initial Developer of the Original Code is Open CASCADE S.A.S., having its
  12 -- main offices at: 1, place des Freres Montgolfier, 78280 Guyancourt, France.
  13 --
  14 -- The Original Code and all software distributed under the License is
  15 -- distributed on an "AS IS" basis, without warranty of any kind, and the
  16 -- Initial Developer hereby disclaims all such warranties, including without
  17 -- limitation, any warranties of merchantability, fitness for a particular
  18 -- purpose or non-infringement. Please see the License for the specific terms
  19 -- and conditions governing the rights and limitations under the License.
  20
  21
  22
  23
  24
  25 class MakePipe from BRepFeat inherits Form from BRepFeat
  26
  27         ---Purpose: Constructs compound shapes with pipe
  28         -- features. These can be depressions or protrusions.
  29         -- The semantics of pipe feature creation is based on the construction of shapes:
  30         -- -   along a length
  31         -- -   up to a limiting face
  32         -- -   from a limiting face to a height.
  33         -- The shape defining construction of the pipe feature can be either the supporting edge or
  34         -- the concerned area of a face.
  35         -- In case of the supporting edge, this contour
  36         -- can be attached to a face of the basis shape
  37         -- by binding. When the contour is bound to this
  38         -- face, the information that the contour will
  39         -- slide on the face becomes available to the relevant class methods.
  40         -- In case of the concerned area of a face, you
  41         -- could, for example, cut it out and move it to a
  42         -- different height which will define the limiting
  43         -- face of a protrusion or depression.
  44
  45 uses Shape                     from TopoDS,
  46      Face                      from TopoDS,
  47      Wire                      from TopoDS,
  48      Edge                      from TopoDS,
  49      DataMapOfShapeListOfShape from TopTools,
  50      DataMapOfShapeShape       from TopTools,
  51      SequenceOfCurve           from TColGeom,
  52      Curve                     from Geom,
  53      StatusError               from BRepFeat
  54
  55 raises ConstructionError from Standard
  56
  57 is
  58
  59
  60     Create
  61         returns MakePipe from BRepFeat;
  62         ---Purpose: initializes the pipe class.
  63         ---C++: inline
  64
  65
  66     Create(Sbase     : Shape   from TopoDS;
  67            Pbase     : Shape   from TopoDS;
  68            Skface    : Face    from TopoDS;
  69            Spine     : Wire    from TopoDS;
  70            Fuse      : Integer from Standard;
  71            Modify    : Boolean from Standard)
  72
  73         ---Purpose : A face Pbase is selected in the
  74         -- shape Sbase to serve as the basis for the
  75         -- pipe. It will be defined by the wire Spine.
  76         -- Fuse offers a choice between:
  77         -- -   removing matter with a Boolean cut using the setting 0
  78         -- -   adding matter with Boolean fusion using the setting 1.
  79         --   The sketch face Skface serves to determine
  80         -- the type of operation. If it is inside the basis
  81         -- shape, a local operation such as glueing can be performed.
  82                 ---C++: inline
  83                 returns MakePipe from BRepFeat;
  84
  85
  86     Init(me: in out; Sbase     : Shape   from TopoDS;
  87                      Pbase     : Shape   from TopoDS;
  88                      Skface    : Face    from TopoDS;
  89                      Spine     : Wire    from TopoDS;
  90                      Fuse      : Integer from Standard;
  91                      Modify    : Boolean from Standard)
  92
  93         is static;
  94         ---Purpose: Initializes this algorithm for adding pipes to shapes.
  95         -- A face Pbase is selected in the shape Sbase to
  96         -- serve as the basis for the pipe. It will be defined by the wire Spine.
  97         -- Fuse offers a choice between:
  98         -- -   removing matter with a Boolean cut using the setting 0
  99         -- -   adding matter with Boolean fusion using the setting 1.
 100         --  The sketch face Skface serves to determine
 101         -- the type of operation. If it is inside the basis
 102         -- shape, a local operation such as glueing can be performed.
 103
 104     Add(me: in out; E: Edge from TopoDS; OnFace: Face from TopoDS)
 105
 106         ---Purpose: Indicates that the edge <E> will slide on the face
 107         --          <OnFace>. Raises ConstructionError  if the  face does not belong to the
 108         -- basis shape, or the edge to the prismed shape.
 109         raises ConstructionError from Standard
 110
 111         is static;
 112
 113
 114     Perform(me: in out)
 115
 116         is static;
 117
 118
 119     Perform(me: in out; Until: Shape from TopoDS)
 120
 121         is static;
 122
 123
 124     Perform(me: in out; From : Shape from TopoDS;
 125                         Until: Shape from TopoDS)
 126
 127         is static;
 128
 129         ---Purpose: Assigns one of the following semantics
 130         -- -   to a face Until
 131         -- -   from a face From to a height Until.
 132         -- Reconstructs the feature topologically according to the semantic option chosen.
 133
 134     Curves(me: in out; S : in out SequenceOfCurve from TColGeom);
 135
 136
 137     BarycCurve(me: in out)
 138         returns Curve from Geom;
 139
 140
 141 fields
 142
 143 --    mySbase  : Shape                     from TopoDS;
 144     myPbase  : Shape                     from TopoDS;
 145     mySkface : Face                      from TopoDS;
 146     mySlface : DataMapOfShapeListOfShape from TopTools;
 147     mySpine  : Wire                      from TopoDS;
 148     myCurves : SequenceOfCurve           from TColGeom;
 149     myBCurve : Curve                     from Geom;
 150     myStatusError : StatusError          from BRepFeat;
 151
 152 end MakePipe;