src/BRepToIGES/BRepToIGES_BRWire.cdl

   1 -- Created on: 1995-01-27
   2 -- Created by: Marie Jose MARTZ
   3 -- Copyright (c) 1995-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 class BRWire from BRepToIGES inherits BREntity from BRepToIGES
  23
  24     ---Purpose: This class implements the transfer of Shape Entities
  25     --          from Geom To IGES. These can be :
  26     --            . Vertex
  27     --            . Edge
  28     --            . Wire
  29
  30
  31 uses
  32
  33     Shape                from TopoDS,
  34     Vertex               from TopoDS,
  35     Edge                 from TopoDS,
  36     Wire                 from TopoDS,
  37     Face                 from TopoDS,
  38     Surface              from Geom,
  39     Curve                from Geom2d,
  40     Location             from TopLoc,
  41     Pnt2d                from gp,
  42     IGESEntity           from IGESData,
  43     BREntity             from BRepToIGES
  44
  45
  46 is
  47
  48     Create returns BRWire from BRepToIGES;
  49
  50
  51     Create (BR : BREntity from BRepToIGES)
  52         returns BRWire from BRepToIGES;
  53
  54
  55     TransferWire   (me        : in out;
  56                     start     :        Shape from TopoDS)
  57          returns mutable IGESEntity from IGESData;
  58     ---Purpose :  Transfert a Shape entity from TopoDS to IGES
  59     --            this entity must be a Vertex or an Edge or a Wire.
  60     --            If this Entity could not be converted,
  61     --            this member returns a NullEntity.
  62
  63
  64     TransferVertex (me        : in out;
  65                     myvertex  :        Vertex from TopoDS)
  66          returns mutable IGESEntity from IGESData;
  67     ---Purpose :  Transfert a Vertex entity from TopoDS to IGES
  68     --            If this Entity could not be converted,
  69     --            this member returns a NullEntity.
  70
  71
  72     TransferVertex (me        : in out;
  73                     myvertex  :        Vertex from TopoDS;
  74                     myedge    :        Edge   from TopoDS;
  75                     parameter : out    Real   from Standard)
  76          returns mutable IGESEntity from IGESData;
  77     ---Purpose :  Transfert a Vertex entity on an Edge from TopoDS to IGES
  78     --            Returns the parameter of myvertex on myedge.
  79     --            If this Entity could not be converted,
  80     --            this member returns a NullEntity.
  81
  82
  83     TransferVertex (me        : in out;
  84                     myvertex  :        Vertex from TopoDS;
  85                     myedge    :        Edge   from TopoDS;
  86                     myface    :        Face   from TopoDS;
  87                     parameter : out    Real   from Standard)
  88          returns mutable IGESEntity from IGESData;
  89     ---Purpose :  Transfert a Vertex entity of an edge on a Face
  90     --            from TopoDS to IGES
  91     --            Returns the parameter of myvertex on the pcurve
  92     --            of myedge on myface
  93     --            If this Entity could not be converted,
  94     --            this member returns a NullEntity.
  95
  96
  97     TransferVertex (me        : in out;
  98                     myvertex  :        Vertex   from TopoDS;
  99                     myedge    :        Edge     from TopoDS;
 100                     mysurface :        Surface  from Geom;
 101                     myloc     :        Location from TopLoc;
 102                     parameter : out    Real     from Standard)
 103          returns mutable IGESEntity from IGESData;
 104     ---Purpose :  Transfert a Vertex entity of an edge on a Surface
 105     --            from TopoDS to IGES
 106     --            Returns the parameter of myvertex on the pcurve
 107     --            of myedge on mysurface
 108     --            If this Entity could not be converted,
 109     --            this member returns a NullEntity.
 110
 111
 112     TransferVertex (me        : in out;
 113                     myvertex  :        Vertex from TopoDS;
 114                     myface    :        Face   from TopoDS;
 115                     mypoint   : out    Pnt2d  from gp)
 116          returns mutable IGESEntity from IGESData;
 117     ---Purpose :  Transfert a Vertex entity on a Face from TopoDS to IGES
 118     --            Returns the parameters of myvertex on myface
 119     --            If this Entity could not be converted,
 120     --            this member returns a NullEntity.
 121
 122
 123     TransferEdge   (me        : in out;
 124                     myedge    :        Edge    from TopoDS;
 125     --              IsRevol   : in     Boolean from Standard
 126                     isBRepMode: in     Boolean from Standard)
 127          returns mutable IGESEntity from IGESData;
 128     ---Purpose :  Transfert an Edge entity from TopoDS to IGES
 129     --            If this Entity could not be converted,
 130     --            this member returns a NullEntity.
 131     --            isBRepMode indicates if write mode is BRep
 132     --            (True when called from BRepToIGESBRep and False when from BRepToIGES)
 133     --            If edge is REVERSED and isBRepMode is False 3D edge curve is reversed,
 134     --            otherwise, not.
 135
 136
 137     TransferEdge   (me        : in out;
 138                     myedge    :           Edge from TopoDS;
 139                     myface    :           Face from TopoDS;
 140                     length    : in        Real from Standard;
 141                     isBRepMode: in     Boolean from Standard)
 142          returns mutable IGESEntity from IGESData;
 143     ---Purpose :  Transfert an Edge entity on a Face from TopoDS to IGES
 144     --            If this Entity could not be converted,
 145     --            this member returns a NullEntity.
 146     --            isBRepMode indicates if write mode is BRep
 147     --            (True when called from BRepToIGESBRep and False when from BRepToIGES)
 148     --            passing into Transform2dCurve()
 149
 150     TransferWire   (me        : in out;
 151                     mywire    :        Wire from TopoDS)
 152          returns mutable IGESEntity from IGESData;
 153     ---Purpose :  Transfert a Wire entity from TopoDS to IGES
 154     --            If this Entity could not be converted,
 155     --            this member returns a NullEntity.
 156
 157
 158     TransferWire   (me        : in out;
 159                     mywire    :        Wire       from TopoDS;
 160                     myface    :        Face       from TopoDS;
 161                     mycurve2d : out    IGESEntity from IGESData;
 162                     length    : in     Real       from Standard)
 163     --              IsRevol   : in     Boolean    from Standard
 164          returns mutable IGESEntity from IGESData;
 165     ---Purpose :  Transfert a Wire entity from TopoDS to IGES.
 166     --            Returns the curve associated to mywire in
 167     --            the parametric space of myface.
 168     --            If this Entity could not be converted,
 169     --            this member returns a NullEntity.
 170     --            Parameter IsRevol is not used anymore
 171
 172 end BRWire;