src/DsgPrs/DsgPrs_LengthPresentation.cdl

   1 -- Created on: 1993-06-03
   2 -- Created by: Jean-Louis FRENKEL
   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
  23
  24 class LengthPresentation from DsgPrs
  25         ---Purpose: Framework for displaying lengths.
  26         -- The length displayed is indicated by line segments
  27         -- and text alone or by a combination of line segment,
  28         -- text and   arrows at either or both of its ends.
  29 uses
  30     Presentation from Prs3d,
  31     Pnt from gp,
  32     Dir from gp,
  33     Drawer from Prs3d,
  34     ExtendedString from TCollection,
  35     ArrowSide from DsgPrs,
  36
  37     Pln from gp,
  38     Surface from Geom
  39 is
  40     Add( myclass; aPresentation: Presentation from Prs3d;
  41                   aDrawer: Drawer from Prs3d;
  42                   aText: ExtendedString from TCollection;
  43                   AttachmentPoint1: Pnt from gp;
  44                   AttachmentPoint2: Pnt from gp;
  45                   aDirection: Dir from gp;
  46                   OffsetPoint: Pnt from gp);
  47         ---Purpose: Draws a line segment representing a length in the
  48         -- display aPresentation.
  49         -- This segment joins the points AttachmentPoint1 and
  50         -- AttachmentPoint2, along the direction aDirection.
  51         -- The text aText will be displayed at the offset point OffsetPoint.
  52         -- The line and text attributes are specified by the
  53         -- attribute manager aDrawer.
  54
  55     Add( myclass; aPresentation    : Presentation   from Prs3d;
  56                   aDrawer          : Drawer         from Prs3d;
  57                   aText            : ExtendedString from TCollection;
  58                   AttachmentPoint1 : Pnt            from gp;
  59                   AttachmentPoint2 : Pnt            from gp;
  60                   aDirection       : Dir            from gp;
  61                   OffsetPoint      : Pnt            from gp;
  62                   ArrowSide        : ArrowSide      from DsgPrs );
  63         ---Purpose: Draws a line segment representing a length in the
  64         -- display aPresentation.
  65         -- This segment joins the points AttachmentPoint1 and
  66         -- AttachmentPoint2, along the direction aDirection.
  67         -- The text aText will be displayed at the offset point
  68         -- OffsetPoint. The value of the enumeration ArrowSide
  69         -- controls whether arrows will be displayed at either or
  70         -- both ends of the length.
  71         -- The line, text and arrow attributes are specified by the
  72         -- attribute manager aDrawer.
  73
  74     Add( myclass; aPresentation    : Presentation   from Prs3d;
  75                   aDrawer          : Drawer         from Prs3d;
  76                   aText            : ExtendedString from TCollection;
  77                   AttachmentPoint1 : Pnt            from gp;
  78                   AttachmentPoint2 : Pnt            from gp;
  79                   PlaneOfFaces     : Pln            from gp;
  80                   aDirection       : Dir            from gp;
  81                   OffsetPoint      : Pnt            from gp;
  82                   ArrowSide        : ArrowSide      from DsgPrs );
  83         ---Purpose: Draws a line segment representing a length in the
  84         -- display aPresentation.
  85         -- This segment joins the points AttachmentPoint1 and
  86         -- AttachmentPoint2, along the direction aDirection.
  87         -- The text aText will be displayed at the offset point
  88         -- OffsetPoint. The value of the enumeration ArrowSide
  89         -- controls whether arrows will be displayed at either or
  90         -- both ends of the length.
  91         -- The plane PlaneOfFaces is used if length is null.
  92         -- The line, text and arrow attributes are specified by the
  93         -- attribute manager aDrawer.
  94
  95     Add( myclass; aPresentation    : Presentation   from Prs3d;
  96                   aDrawer          : Drawer         from Prs3d;
  97                   aText            : ExtendedString from TCollection;
  98                   SecondSurf       : Surface        from Geom;
  99                   AttachmentPoint1 : Pnt            from gp;
 100                   AttachmentPoint2 : Pnt            from gp;
 101                   aDirection       : Dir            from gp;
 102                   OffsetPoint      : Pnt            from gp;
 103                   ArrowSide        : ArrowSide      from DsgPrs );
 104         ---Purpose: Draws a line segment representing a length in the
 105         -- display aPresentation.
 106         -- This segment joins the points AttachmentPoint1 and
 107         -- AttachmentPoint2, along the direction
 108         -- aDirection.   AttachmentPoint2 lies on the curvilinear
 109         -- faces SecondSurf. The text aText will be displayed at
 110         -- the offset point OffsetPoint. The value of the
 111         -- enumeration ArrowSide controls whether arrows will
 112         -- be displayed at either or both ends of the length.
 113         -- The line, text and arrow attributes are specified by the
 114         -- attribute manager aDrawer.
 115
 116
 117     Add(myclass;
 118         aPresentation: Presentation from Prs3d;
 119         aDrawer      : Drawer from Prs3d;
 120         Pt1          : Pnt from gp;
 121         Pt2          : Pnt from gp;
 122         ArrowSide    : ArrowSide from DsgPrs);
 123         ---Purpose: Draws a line segment representing a length in the
 124         -- display aPresentation.
 125         -- This segment joins the points AttachmentPoint1 and
 126         -- AttachmentPoint2, along the direction aDirection.
 127         -- The value of the enumeration ArrowSide controls
 128         -- whether arrows will be displayed at either or both ends of the length.
 129         -- The line and arrow attributes are specified by the attribute manager aDrawer.
 130
 131 end LengthPresentation;