src/IGESGeom/IGESGeom_CircularArc.cdl

   1 -- Created on: 1993-01-09
   2 -- Created by: CKY / Contract Toubro-Larsen ( Kiran )
   3 -- Copyright (c) 1993-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 CircularArc from IGESGeom  inherits IGESEntity
  23
  24         ---Purpose: defines IGESCircularArc, Type <100> Form <0>
  25         --          in package IGESGeom
  26         --          A circular arc is a connected portion of a parent circle
  27         --          which consists of more than one point. The definition space
  28         --          coordinate system is always chosen so that the circular arc
  29         --          remains in a plane either coincident with or parallel to
  30         --          the XT, YT plane.
  31
  32 uses
  33
  34         XY          from gp,
  35         Dir2d       from gp,
  36         Dir         from gp,
  37         Pnt         from gp,
  38         Pnt2d       from gp
  39
  40 is
  41
  42         Create returns mutable CircularArc;
  43
  44         -- Specific Methods pertaining to the class
  45
  46         Init (me : mutable; aZT : Real; aCenter, aStart, anEnd : XY);
  47         ---Purpose : This method is used to set the fields of the class
  48         --           CircularArc
  49         --       - aZT     : Shift above the Z plane
  50         --       - aCenter : Center of the circle of which the arc forms a part
  51         --       - aStart  : Starting point of the circular arc
  52         --       - anEnd   : Ending point of the circular arc
  53
  54         Center(me) returns Pnt2d;
  55         ---Purpose : returns the center of the circle of which arc forms a part
  56
  57         TransformedCenter(me) returns Pnt;
  58         ---Purpose : returns the center of the circle of which arc forms a part
  59         -- after applying Transf. Matrix
  60
  61         StartPoint(me) returns Pnt2d;
  62         ---Purpose : returns the start point of the arc
  63
  64         TransformedStartPoint(me) returns Pnt;
  65         ---Purpose : returns the start point of the arc after applying Transf. Matrix
  66
  67         ZPlane(me) returns Real;
  68         ---Purpose : returns the parallel displacement of the plane containing the
  69         -- arc from the XT, YT plane
  70
  71         EndPoint(me) returns Pnt2d;
  72         ---Purpose : returns the end point of the arc
  73
  74         TransformedEndPoint(me) returns Pnt;
  75         ---Purpose : returns the end point of the arc after applying Transf. Matrix
  76
  77         Radius(me) returns Real;
  78         ---Purpose : returns the radius of the circle of which arc forms a part
  79
  80         Angle(me) returns Real;
  81         ---Purpose : returns the angle subtended by the arc at the center in radians
  82
  83         Axis(me) returns Dir;
  84         ---Purpose : Z-Axis of circle (i.e. [0,0,1])
  85
  86         TransformedAxis (me) returns Dir;
  87         ---Purpose : Z-Axis after applying Trans. Matrix
  88
  89         IsClosed(me) returns Boolean;
  90         ---Purpose : True if StartPoint = EndPoint
  91
  92 fields
  93
  94 --
  95 -- Class    : IGESGeom_CircularArc
  96 --
  97 -- Purpose  : Declaration of variables specific to the definition
  98 --            of the Class CircularArc.
  99 --
 100 -- Reminder : A CircularArc instance is defined by :
 101 --            The center of a circle of which it forms a part
 102 --            the plane in which it lies, the starting point
 103 --            and ending point coordinates
 104
 105         theZT     : Real;
 106         theCenter : XY;
 107         theStart  : XY;
 108         theEnd    : XY;
 109
 110 end CircularArc;