src/IGESDimen/IGESDimen_RadiusDimension.cdl

   1 -- Created on: 1993-01-09
   2 -- Created by: CKY / Contract Toubro-Larsen ( SIVA )
   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 RadiusDimension from IGESDimen  inherits IGESEntity
  18
  19         ---Purpose: Defines IGES Radius Dimension, type <222> Form <0, 1>,
  20         --          in package IGESDimen.
  21         --          A Radius Dimension Entity consists of a General Note, a
  22         --          leader, and an arc center point. A second form of this
  23         --          entity accounts for the occasional need to have two
  24         --          leader entities referenced.
  25
  26 uses
  27
  28         LeaderArrow from IGESDimen,
  29         GeneralNote from IGESDimen,
  30         XY          from gp,
  31         Pnt         from gp,
  32         XYZ         from gp,
  33         Pnt2d       from gp
  34
  35 is
  36
  37         Create returns RadiusDimension;
  38
  39             -- --specific-- --
  40         Init(me           : mutable;
  41              aNote        : GeneralNote;
  42              anArrow      : LeaderArrow;
  43              arcCenter    : XY;
  44              anotherArrow : LeaderArrow);
  45         -- This method is used to set fields of the
  46         -- class RadiusDimension
  47         --       - aNote        : Note for the dimension
  48         --       - anArrow      : Leader arrow used for the dimensioning
  49         --       - arcCenter    : Center point of the arc
  50         --       - anotherArrow : Second leader arrow used for the dimensioning
  51         --                        (will be Null, if Form no. is 0)
  52
  53         InitForm (me : mutable; form : Integer);
  54         ---Purpose : Allows to change Form Number
  55         --           (1 admits null arrow)
  56
  57         Note(me) returns GeneralNote;
  58         ---Purpose : returns the General Note entity
  59
  60         Leader(me) returns LeaderArrow;
  61         ---Purpose : returns the Leader Arrow entity
  62
  63         Center(me) returns Pnt2d;
  64         ---Purpose : returns the coordinates of the Arc Center
  65
  66         TransformedCenter(me) returns Pnt;
  67         ---Purpose : returns the coordinates of the Arc Center after Transformation
  68         -- (Z coord taken from ZDepth of Leader Entity)
  69
  70         HasLeader2(me) returns Boolean;
  71         ---Purpose : returns True if form is 1, False if 0
  72
  73         Leader2(me) returns LeaderArrow;
  74         ---Purpose : returns Null handle if Form is 0
  75
  76 fields
  77
  78 --
  79 -- Class    : IGESDimen_RadiusDimension
  80 --
  81 -- Purpose  : Declaration of variables specific to the definition
  82 --            of the Class RadiusDimension.
  83 --
  84 -- Reminder : A RadiusDimension instance is defined by :
  85 --                     - A General Note
  86 --                - A Leader Arrow
  87 --                - The arc center coordinates
  88 --                - The second Leader Arrow
  89 --
  90
  91         theNote        : GeneralNote;
  92         theLeaderArrow : LeaderArrow;
  93         theCenter      : XY;
  94         theLeader2     : LeaderArrow; -- Null handle if form is 0
  95
  96 end RadiusDimension;