src/gce/gce_MakeCirc2d.cdl

   1 -- File:        MakeCirc2d.cdl
   2 -- Created:     Wed Aug 26 14:31:09 1992
   3 -- Author:      Remi GILET
   4 --              <reg@topsn3>
   5 ---Copyright:    Matra Datavision 1992
   6
   7 class MakeCirc2d from gce inherits Root from gce
   8
   9     ---Purpose : This class implements the following algorithms used
  10     --           to create Circ2d from gp.
  11     --
  12     --           * Create a Circ2d concentric with another and passing
  13     --             though a point.
  14     --           * Create a Circ2d concentric with another at the distance
  15     --             Dist.
  16     --           * Create a Circ2d passing through 3 points.
  17     --           * Create a Circ2d with its center and radius.
  18     --           * Create a Circ2d with its center and a point given
  19     --             the radius.
  20     --           * Create a Circ2d with its axis and its radius.
  21
  22
  23 uses Pnt2d     from gp,
  24      Circ2d    from gp,
  25      Real      from Standard,
  26      ErrorType from gce,
  27      Ax2d      from gp,
  28      Ax22d     from gp
  29
  30 raises NotDone from StdFail
  31
  32 is
  33
  34 Create (XAxis  : Ax2d    from gp                      ;
  35         Radius : Real    from Standard                ;
  36         Sense  : Boolean from Standard = Standard_True)   returns MakeCirc2d;
  37     --- Purpose :
  38     --  The location point of XAxis is the center of the circle.
  39     -- Warnings :
  40     --  It is not forbidden to create a circle with Radius = 0.0
  41     --  If Sense is true the local coordinate system of the solution
  42     --  is direct and non direct in the other case.
  43     --  The status is "NegativeRadius" if Radius < 0.0.
  44
  45 Create (Axis   : Ax22d   from gp      ;
  46         Radius : Real    from Standard)   returns MakeCirc2d;
  47     --- Purpose :
  48     --  The location point of Axis is the center of the circle.
  49     --  Warnings :
  50     --  It is not forbidden to create a circle with Radius = 0.0
  51
  52 Create(Circ    :     Circ2d from gp      ;
  53        Dist    :     Real   from Standard)
  54     returns MakeCirc2d;
  55     ---Purpose : Makes a Circ2d from gp <TheCirc> concentric with another
  56     --           circ2d <Circ> with a distance <Dist>.
  57     --           If Dist is greater than zero the result encloses
  58     --           the circle <Circ>, else the result is enclosed by the
  59     --           circle <Circ>.
  60     --           The local coordinate system of the solution is the
  61     --           same as Circ.
  62
  63 Create(Circ    :     Circ2d from gp;
  64        Point   :     Pnt2d  from gp)
  65     returns MakeCirc2d;
  66     ---Purpose : Makes a Circ2d from gp <TheCirc> concentric with another
  67     --           circ2d <Circ> and passing through a Pnt2d <Point>.
  68     --           The local coordinate system of the solution is the
  69     --           same as Circ.
  70
  71 Create(P1      :     Pnt2d  from gp;
  72        P2      :     Pnt2d  from gp;
  73        P3      :     Pnt2d  from gp)
  74     returns MakeCirc2d;
  75     ---Purpose : Makes a Circ2d from gp <TheCirc> passing through 3
  76     --           Pnt2d <P1>,<P2>,<P3>.
  77     --           The local coordinate system of the solution is given
  78     --           by the three points P1, P2, P3.
  79
  80 Create(Center : Pnt2d   from gp                      ;
  81        Radius : Real    from Standard                ;
  82        Sense  : Boolean from Standard = Standard_True)
  83     returns MakeCirc2d;
  84     ---Purpose : Makes a Circ2d from gp <TheCirc> with its center
  85     --           <Center> and its radius <Radius>.
  86     --           If Sense is true the local coordinate system of
  87     --           the solution is direct and non direct in the other case.
  88
  89 Create(Center : Pnt2d   from gp                      ;
  90        Point  : Pnt2d   from gp                      ;
  91        Sense  : Boolean from Standard = Standard_True)
  92     returns MakeCirc2d;
  93     ---Purpose : Makes a Circ2d from gp <TheCirc> with its center
  94     --           <Center> and a point giving the radius.
  95     --           If Sense is true the local coordinate system of
  96     --           the solution is direct and non direct in the other case.
  97
  98 Value(me) returns Circ2d from gp
  99     raises NotDone
 100     is static;
 101     ---C++: return const&
 102     ---Purpose: Returns the constructed circle.
 103     -- Exceptions StdFail_NotDone if no circle is constructed.
 104
 105 Operator(me) returns Circ2d from gp
 106     is static;
 107     ---C++: return const&
 108     ---C++: alias "Standard_EXPORT operator gp_Circ2d() const;"
 109
 110 fields
 111
 112     TheCirc2d : Circ2d from gp;
 113     --The solution from gp.
 114
 115 end MakeCirc2d;