src/DrawTrSurf/DrawTrSurf_Curve2d.cdl

   1 -- Created on: 1992-05-22
   2 -- Created by: Jean Claude VAUTHIER
   3 -- Copyright (c) 1992-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 -- Modified     PMN CurvatureRadius added
  18
  19
  20
  21 class Curve2d  from DrawTrSurf
  22
  23 inherits Drawable
  24
  25         --- Purpose : This class defines a drawable curve in 2d space.
  26         --  The curve is drawned in the plane XOY.
  27
  28 uses Curve       from Geom2d,
  29      Color       from Draw,
  30      Display     from Draw,
  31      Drawable3D  from Draw,
  32      Interpretor from Draw,
  33      OStream
  34
  35
  36 is
  37
  38
  39
  40
  41
  42   Create (C : Curve from Geom2d;
  43           DispOrigin : Boolean from Standard = Standard_True)
  44         --- Purpose :
  45         --  creates a drawable curve from a curve of package Geom2d.
  46      returns mutable Curve2d from DrawTrSurf;
  47
  48
  49   Create (C : Curve from Geom2d; aColor : Color from Draw; Discret :Integer;
  50           DispOrigin : Boolean from Standard = Standard_True;
  51           DispCurvRadius : Boolean  = Standard_False;
  52           RadiusMax : Real = 1.0e3;
  53           RatioOfRadius : Real = 0.1)
  54      returns mutable Curve2d from DrawTrSurf;
  55
  56
  57   DrawOn (me; dis : in out Display from Draw);
  58
  59
  60   GetCurve (me) returns any Curve from Geom2d
  61         ---C++: inline
  62      is static;
  63
  64
  65   SetColor(me : mutable; aColor : Color from Draw)
  66         ---C++: inline
  67      is static;
  68
  69   ShowCurvature(me : mutable)
  70         ---C++: inline
  71      is static;
  72
  73   ClearCurvature(me : mutable)
  74         ---C++: inline
  75      is static;
  76
  77   SetRadiusMax(me : mutable; Radius : Real)
  78         ---C++: inline
  79      is static;
  80
  81   SetRadiusRatio(me : mutable;  Ratio : Real)
  82         ---C++: inline
  83      is static;
  84
  85   Color (me)  returns Color from Draw
  86         ---C++: inline
  87      is static;
  88
  89   RadiusMax(me)  returns Real
  90         ---C++: inline
  91      is static;
  92
  93   RadiusRatio(me)  returns Real
  94         ---C++: inline
  95      is static;
  96
  97
  98   Copy(me) returns mutable Drawable3D from Draw
  99         ---Purpose: For variable copy.
 100   is redefined;
 101
 102   Dump(me; S : in out OStream)
 103         ---Purpose: For variable dump.
 104   is redefined;
 105
 106   Is3D(me) returns Boolean
 107         ---Purpose: Returns False.
 108   is redefined;
 109
 110   Whatis(me; I : in out Interpretor from Draw)
 111   is redefined;
 112         ---Purpose: For variable whatis command. Set  as a result  the
 113         --          type of the variable.
 114
 115 fields
 116   curv       : Curve   from Geom2d   is protected ;
 117   look       : Color   from Draw     is protected ;
 118   disporigin : Boolean from Standard is protected ;
 119   dispcurvradius : Boolean from Standard is protected ;
 120   radiusmax      : Real from  Standard is protected ;
 121   radiusratio    : Real from  Standard is protected ;
 122 end Curve2d;