src/Prs3d/Prs3d_TextAspect.cdl

   1 -- Created on: 1993-09-14
   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 --   GG  : GER61351 17/11/1999 Change SetColor() with a compatible Quantity_Color instead
  22 --                     the restricted NameOfColor.
  23
  24 class TextAspect from Prs3d inherits BasicAspect from Prs3d
  25
  26         ---Purpose: Defines the attributes when displaying a text.
  27
  28
  29 uses
  30     NameOfColor from Quantity,
  31     Color   from Quantity,
  32     AspectText3d from Graphic3d,
  33     PlaneAngle from Quantity,
  34     HorizontalTextAlignment  from  Graphic3d,
  35     VerticalTextAlignment  from  Graphic3d,
  36     TextPath from Graphic3d,
  37     Length from Quantity
  38
  39 is
  40     Create returns mutable TextAspect from Prs3d;
  41         --- Purpose: Constructs an empty framework for defining display attributes of text.
  42
  43     SetColor(me: mutable; aColor:  Color  from  Quantity);
  44
  45     SetColor(me: mutable; aColor:  NameOfColor  from  Quantity);
  46         --- Purpose: Sets the color of the type used in text display.
  47
  48     SetFont(me: mutable; aFont:  CString  from  Standard);
  49         --- Purpose: Sets the font used in text display.
  50
  51     SetHeightWidthRatio(me:  mutable;  aRatio:  Real  from  Standard);
  52         --- Purpose: Returns the height-width ratio, also known as the expansion factor.
  53     SetSpace(me :mutable; aSpace:  Length  from  Quantity);
  54         ---Purpose: Sets the length of the box which text will occupy.
  55
  56     SetHeight(me: mutable;  aHeight:  Real  from  Standard);
  57         --- Purpose: Sets the height of the text.
  58
  59     SetAngle(me: mutable;  anAngle:  PlaneAngle  from  Quantity);
  60         --- Purpose: Sets the angle
  61
  62     Height(me) returns Real  from  Standard;
  63         ---Purpose: Returns the height of the text box.
  64
  65     Angle(me) returns PlaneAngle  from  Quantity;
  66         ---Purpose: Returns the angle
  67
  68     SetHorizontalJustification(me:  mutable;  aJustification:  HorizontalTextAlignment  from  Graphic3d);
  69         --- Purpose: Sets horizontal alignment of text.
  70
  71     SetVerticalJustification(me:  mutable;  aJustification:  VerticalTextAlignment  from  Graphic3d);
  72         --- Purpose: Sets the vertical alignment of text.
  73
  74     SetOrientation(me: mutable;  anOrientation:  TextPath  from  Graphic3d);
  75         ---Purpose: Sets the orientation of text.
  76
  77     HorizontalJustification(me)  returns  HorizontalTextAlignment  from  Graphic3d;
  78         --- Purpose: Returns the horizontal alignment of the text.
  79         -- The range of values includes:
  80         -- -   left
  81         -- -   center
  82         -- -   right, and
  83         -- -   normal (justified).
  84
  85     VerticalJustification(me)  returns  VerticalTextAlignment  from  Graphic3d;
  86         --- Purpose: Returns the vertical alignment of the text.
  87         -- The range of values includes:
  88         -- -   normal
  89         -- -   top
  90         -- -   cap
  91         -- -   half
  92         -- -   base
  93         -- -   bottom
  94
  95     Orientation(me) returns  TextPath  from  Graphic3d;
  96         --- Purpose: Returns the orientation of the text.
  97         -- Text can be displayed in the following directions:
  98         -- -   up
  99         -- -   down
 100         -- -   left, or
 101         -- -   right
 102
 103     Aspect(me) returns AspectText3d  from  Graphic3d;
 104         ---Purpose: Returns the purely textual attributes used in the display of text.
 105         -- These include:
 106         -- -   color
 107         -- -   font
 108         -- -   height/width ratio, that is, the expansion factor, and
 109         -- -   space between characters.
 110
 111 fields
 112     myTextAspect: AspectText3d  from  Graphic3d;
 113     myAngle: PlaneAngle from  Quantity;
 114     myHeight: Real from Standard;
 115     myHorizontalJustification:  HorizontalTextAlignment  from  Graphic3d;
 116     myVerticalJustification:  VerticalTextAlignment  from  Graphic3d;
 117     myOrientation: TextPath  from  Graphic3d;
 118
 119 end TextAspect from Prs3d;
 120
 121
 122
 123
 124
 125