src/Prs3d/Prs3d_ArrowAspect.cdl

   1 -- Created on: 1993-06-11
   2 -- Created by: Jean-Louis FRENKEL
   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 -- Modified     GG : GER61351 01/02/00 Add SetColor() & Aspect() methods
  18
  19
  20 class ArrowAspect from Prs3d inherits BasicAspect from Prs3d
  21         ---Purpose: A framework for displaying arrows in representations
  22         -- of dimensions and relations.
  23 uses
  24     Length from Quantity,
  25     PlaneAngle from Quantity,
  26     NameOfColor from Quantity,
  27     Color       from Quantity,
  28     AspectLine3d from Graphic3d
  29
  30 raises
  31     InvalidAngle from Prs3d
  32
  33 is
  34     Create returns ArrowAspect from Prs3d;
  35         ---Purpose: Constructs an empty framework for displaying arrows
  36         -- in representations of lengths. The lengths displayed
  37         -- are either on their own or in chamfers, fillets,
  38         -- diameters and radii.
  39     Create (anAngle: PlaneAngle from Quantity; aLength: Length from Quantity)
  40     returns ArrowAspect from Prs3d;
  41         --- Purpose: Constructs a framework to display an arrow with a
  42         -- shaft of the length aLength and having a head with
  43         -- sides at the angle anAngle from each other.
  44
  45     SetAngle(me: mutable; anAngle: PlaneAngle from Quantity)
  46         ---Purpose: defines the angle of the arrows.
  47     raises InvalidAngle from Prs3d
  48     is static;
  49
  50     Angle(me) returns PlaneAngle from Quantity
  51         ---Purpose: returns the current value of the angle used when drawing an arrow.
  52     is static;
  53
  54     SetLength(me: mutable; aLength: Length from Quantity)
  55         ---Purpose: defines the length of the arrows.
  56     is static;
  57
  58     Length(me) returns Length from Quantity
  59         ---Purpose: returns the current value of the length used when drawing an arrow.
  60     is static;
  61
  62     SetColor(me: mutable; aColor:  Color  from  Quantity);
  63
  64     SetColor(me: mutable; aColor:  NameOfColor  from  Quantity);
  65
  66     Aspect(me) returns AspectLine3d  from  Graphic3d;
  67
  68 fields
  69             myArrowAspect: AspectLine3d  from  Graphic3d;
  70             myAngle: PlaneAngle from Quantity;
  71             myLength: Length from Quantity;
  72
  73 end ArrowAspect from Prs3d;