src/PGeom/PGeom_ToroidalSurface.cdl

   1 -- Created on: 1993-03-02
   2 -- Created by: Philippe DAUTRY
   3 -- Copyright (c) 1993-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 class ToroidalSurface from PGeom inherits ElementarySurface from PGeom
  18
  19         ---Purpose : This class defines the complete toroidal surface.
  20         --
  21         ---See Also : ToroidalSurface from Geom.
  22
  23
  24 uses Ax3          from gp
  25
  26 is
  27
  28
  29
  30   Create returns ToroidalSurface from PGeom;
  31         ---Purpose: Creates a ToroidalSurface with default values.
  32         ---Level: Internal
  33
  34
  35   Create (aPosition : Ax3 from gp;
  36           aMajorRadius: Real from Standard;
  37           aMinorRadius: Real from Standard)
  38      returns ToroidalSurface from PGeom;
  39         ---Purpose: Creates a ToroidalSurface with these values.
  40         ---Level: Internal
  41
  42
  43   MajorRadius (me: mutable; aMajorRadius: Real from Standard);
  44         ---Purpose : Set the field majorRadius with <aMajorRadius>.
  45         ---Level: Internal
  46
  47
  48   MajorRadius (me) returns Real from Standard;
  49         ---Purpose : Returns the value of the field majorRadius.
  50         ---Level: Internal
  51
  52
  53   MinorRadius (me: mutable; aMinorRadius: Real from Standard);
  54         ---Purpose : Set the field minorRadius with <aMinorRadius>.
  55         ---Level: Internal
  56
  57
  58   MinorRadius (me) returns Real from Standard;
  59         ---Purpose : Returns the value of the field minorRadius.
  60         ---Level: Internal
  61
  62
  63 fields
  64
  65   majorRadius : Real from Standard;
  66   minorRadius : Real from Standard;
  67
  68 end;