0024002: Overall code and build procedure refactoring -- automatic
[occt.git] / src / ChFiDS / ChFiDS_Spine.cdl
diff --git a/src/ChFiDS/ChFiDS_Spine.cdl b/src/ChFiDS/ChFiDS_Spine.cdl
deleted file mode 100644 (file)
index f9deaf3..0000000
+++ /dev/null
@@ -1,366 +0,0 @@
--- Created on: 1993-11-09
--- Created by: Laurent BOURESCHE
--- 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.
-
-class Spine from ChFiDS inherits TShared from MMgt
-
-       ---Purpose: Contains information necessary for construction of
-       --          a 3D fillet or chamfer:
-       --          
-       --          
-       --          - guideline composed of edges of the solid, tangents
-       --          between them, and borders by faces tangents
-       --          between them. 
-       --          
-       --          Tools for construction of the Sp
-       --          by propagation from an edge of solid 
-       --          are provided in the Builder of Fil3d.
-       --          
-       --          The Spine contains among others the 
-       --          information about the nature of extremities
-       --          of the fillet ( on free border , on section or closed ).
-       --          
-       --          IMPORTANT NOTE  :    the guideline 
-       --          represented in this way is not C2, although the path
-       --          claims it. Several palliative workarounds 
-       --          (see the methods at the end) are planned,
-       --          but they are not enough. It is necessary to change
-       --          the approach and double the Spine of line C2 with
-       --          the known consequences for management of
-       --          interactions between KPart Blend in Fil3d.
-
-
-
-uses  
-
-    HArray1OfReal    from TColStd,
-    HArray1OfBoolean from TColStd,
-    Pnt              from gp,
-    Vec              from gp,
-    Lin              from gp,
-    Circ             from gp,
-    CurveType        from GeomAbs,
-    Vertex           from TopoDS,
-    Edge             from TopoDS,
-    SequenceOfShape  from TopTools,
-    Curve            from BRepAdaptor,
-    SurfData         from ChFiDS,
-    State            from ChFiDS,
-    HElSpine         from ChFiDS,
-    ListOfHElSpine   from ChFiDS,
-    ErrorStatus      from ChFiDS 
-is
-
-----------------------------
--- methodes de construction.
-----------------------------
-
-    Create  returns Spine from ChFiDS;
-
-    Create(Tol : Real from Standard) returns Spine from ChFiDS;
-
-    SetEdges(me : mutable; E : Edge from TopoDS) is static;
-    ---Purpose: store edges composing the guideline
-    ---C++: inline
-
-    PutInFirst(me : mutable; E : Edge from TopoDS) is static;
-    ---Purpose: store the edge at the first position before all others
-    ---C++: inline
-
-    NbEdges(me) returns Integer is static;
-    ---C++: inline
-
-
-    Edges(me; I : Integer) returns Edge from TopoDS is static;
-    ---C++: return const &
-    ---C++: inline
-
-    
-    SetFirstStatus(me : mutable; S : State from ChFiDS) is static;
-    ---Purpose: stores if the start of a set of edges starts on a
-    -- section of free border or forms  a closed contour
-    ---C++: inline
-
-
-    SetLastStatus(me : mutable; S : State from ChFiDS) is static;
-   ---Purpose: stores if the end of a set of edges starts on a
-    -- section of free border or forms  a closed contour
-    ---C++: inline
-
-    AppendElSpine(me : mutable; Els : HElSpine from ChFiDS) 
-    is virtual;
-    
-    ElSpine(me; IE : Integer from Standard) 
-    returns HElSpine from  ChFiDS
-    is static;
-
-    ElSpine(me; E : Edge from TopoDS) 
-    returns HElSpine from  ChFiDS
-    is static;
-
-    ElSpine(me; W : Real from Standard) 
-    returns HElSpine from  ChFiDS
-    is static;
-
-    ChangeElSpines(me : mutable) 
-    ---C++: return &
-    returns ListOfHElSpine from ChFiDS
-    is static;
-
-    Reset(me : mutable; AllData : Boolean from Standard = Standard_False)
-    is virtual;
-
-    SplitDone(me) returns Boolean from Standard is static;
-    SplitDone(me : mutable; B : Boolean from Standard) is static;
-
-----------------------
--- methodes de calcul.
-----------------------
-
-    Load(me : mutable) is static;
-    ---Purpose: prepare the guideline depending on the edges that 
-    --          are elementary arks (take parameters from
-    --          a single curvilinear abscissa); to be able to call 
-    --          methods on the geometry (first,last,value,d1,d2)
-    --          it is necessary to start with preparation otherwise an
-    --          exception will be raised
-
-    Resolution(me; R3d : Real) returns Real
-    is static;
-    
-    IsClosed(me) returns Boolean
-    is static;
-
-    FirstParameter(me) returns Real
-    is static;
-
-    LastParameter(me) returns Real 
-    is static;
-
-    SetFirstParameter(me : mutable; Par : Real from Standard)
-    is static;
-
-    SetLastParameter(me : mutable; Par : Real from Standard)
-    is static;
-    
-    FirstParameter(me; IndexSpine : Integer ) returns Real 
-    ---Purpose: gives the total length of all arcs before the 
-    --          number IndexSp
-    is static;
-    
-    LastParameter(me; IndexSpine : Integer ) returns Real 
-    ---Purpose: gives the total length till the ark with number
-    --          IndexSpine (inclus)
-    is static;
-    
-    Length(me;IndexSpine : Integer ) returns Real 
-    ---Purpose: gives the length of ark with number IndexSp
-    is static;
-    
-    IsPeriodic(me) returns Boolean
-    is static;    
-
-    Period(me) returns Real
-    is static;
-
-    Absc(me :mutable; U : Real) returns Real from Standard  
-    is static;
-
-    Absc(me :mutable; U : Real; I : Integer from Standard) 
-    returns Real from Standard  
-    is static;
-
-    Parameter(me :mutable;
-             AbsC     : Real; 
-              U        : out Real; 
-              Oriented : Boolean  from  Standard = Standard_True)  
-    is static;
-
-    Parameter(me :mutable; 
-              Index    : Integer; 
-              AbsC     : Real; 
-             U        : out Real;  
-              Oriented : Boolean  from  Standard = Standard_True)  
-    is static;
-
-    Prepare(me; 
-            L     : in out Real from Standard; 
-            Index : in out  Integer  from  Standard ) 
-    is static private;
-
-    Value(me :mutable; AbsC : Real ) returns Pnt from gp 
-    is static;
-    
-    D0(me :mutable; AbsC : Real ; P : out Pnt from gp) 
-    is static;
-
-    D1(me :mutable; AbsC : Real ; P : out Pnt from gp; V1 : out Vec from gp) 
-    is static;
-    
-    D2(me :mutable; AbsC : Real ; P : out Pnt from gp; 
-       V1,V2 : out Vec from gp)  
-    is static;
-
-    SetCurrent (me : mutable; Index : Integer ) 
-    is static;
-    
-    CurrentElementarySpine (me : mutable; Index : Integer ) 
-    ---Purpose: sets the current curve and returns it 
-    returns Curve from BRepAdaptor is static; 
-    ---C++: return const &
-
-    CurrentIndexOfElementarySpine(me) returns Integer from Standard
-    ---C++: inline    
-    is static;
-
-    GetType(me) returns CurveType from GeomAbs
-    is static;
-
-    Line(me) returns Lin from gp
-    is static;
-     
-    Circle(me) returns Circ from gp
-    is static;
-     
-    FirstStatus(me) returns State from ChFiDS is static;
-    ---Purpose: returns if the set of edges starts on a free boundary
-    --          or if the first vertex is a breakpoint or if the set is
-    --          closed
-    ---C++: inline
-
-    LastStatus(me) returns State from ChFiDS is static;
-    ---Purpose: returns the state at the end of the set
-    ---C++: inline
-
-
-    Status(me; IsFirst : Boolean from Standard) 
-    returns State from ChFiDS is static;
-    ---C++: inline
-
-
-    SetStatus(me : mutable; 
-              S : State from ChFiDS; 
-              IsFirst : Boolean from Standard) is static;
-    ---C++: inline
-
-    IsTangencyExtremity(me; IsFirst : Boolean from Standard) 
-    returns Boolean is static; 
-    ---Purpose:  returns   if the  set  of  edges starts (or   end) on
-    --          Tangency point.
-    ---C++: inline
-
-
-    SetTangencyExtremity(me : mutable; 
-              IsTangency : Boolean from Standard; 
-              IsFirst    : Boolean from Standard) is static;
-    ---C++: inline
------------------------------------------------------------
---  Methodes d acces aux vertex  et a leurs parametres     
------------------------------------------------------------
-
-    Absc(me ; V : Vertex from TopoDS) returns Real from Standard  
-    is static;
-    FirstVertex(me) returns Vertex from TopoDS;
-    LastVertex(me) returns Vertex from TopoDS;
-
------------------------------------------------------------
---  Methodes de controle des prolongements aux extremites :
---  - prolongement par parmetrage etendu,
---  - prolongement par la tangente.
------------------------------------------------------------
-
-    SetFirstTgt(me : mutable; W : Real from Standard) is static;
-
-    SetLastTgt(me : mutable; W : Real from Standard) is static;
-
-    HasFirstTgt(me) returns Boolean from Standard is static;
-
-    HasLastTgt(me) returns Boolean from Standard is static;
-
-
----------------------------------------------------------------------
---  Methodes d implementation permettant de positionner un flag pour
---  le calcul de D2 aux points singuliers de la ligne guide.
----------------------------------------------------------------------
-
-    SetReference(me : mutable; W : Real from Standard) is static;
-    ---Purpose: set a parameter reference for the approx.
-
-    SetReference(me : mutable; I : Integer from Standard) is static;
-    ---Purpose: set  a  parameter  reference  for  the approx,  at the
-    --          middle  of edge I.
-
-    Index(me; 
-         W       : Real from Standard; 
-         Forward : Boolean from Standard =  Standard_True) 
-    returns Integer from Standard
-    is static;
-
-    Index(me; E : Edge from TopoDS)
-    returns Integer from Standard
-    is static;
-
-    UnsetReference(me : mutable) is static;
-
------------------------------------------------------------------------
--- methodes concernant le statut d'erreur 
------------------------------------------------------------------------
- SetErrorStatus(me : mutable; state : ErrorStatus from ChFiDS) is static;
- ErrorStatus(me) returns ErrorStatus from ChFiDS is static; 
-
-fields
--- donnees generales.
-
-myCurve      : Curve from BRepAdaptor;
-indexofcurve : Integer from Standard;
-firstState   : State from ChFiDS;
-lastState    : State from ChFiDS;
-spine        : SequenceOfShape from TopTools;
-abscissa     : HArray1OfReal from TColStd;
---isconstant   : HArray1OfBoolean from TColStd is protected;
-splitdone    : Boolean from Standard is protected;
-elspines     : ListOfHElSpine from ChFiDS is protected;
-tolesp       : Real from Standard;
-
--- donnees caraterisant les extremites.
-
-firstparam   : Real from Standard;
-lastparam    : Real from Standard;
-firstprolon  : Boolean from Standard;
-lastprolon   : Boolean from Standard; 
-firstistgt   : Boolean from Standard; 
-lastistgt    : Boolean from Standard;
-
-firsttgtpar  : Real from Standard;
-lasttgtpar   : Real from Standard;
-hasfirsttgt  : Boolean from Standard;
-haslasttgt   : Boolean from Standard;
-firstori     : Pnt from gp;
-lastori      : Pnt from gp;
-firsttgt     : Vec from gp;
-lasttgt      : Vec from gp;
-
--- detrompeurs de calcul.
-
-valref       : Real from Standard;
-hasref       : Boolean from Standard;
-
--- statut d'erreur
-errorstate   : ErrorStatus from ChFiDS; 
-
-end Spine;