src/Prs3d/Prs3d_Text.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
  22 class Text from Prs3d inherits Root from Prs3d
  23
  24         --- Purpose: A framework to define the display of texts.
  25 uses
  26     Presentation from Prs3d,
  27     Pnt from gp,
  28     Drawer from Prs3d,
  29     TextAspect from Prs3d,
  30     ExtendedString from TCollection
  31
  32 is
  33     Draw(myclass; aPresentation: Presentation from Prs3d;
  34                   aDrawer: Drawer from Prs3d;
  35                   aText: ExtendedString from TCollection;
  36                   AttachmentPoint: Pnt from gp);
  37         ---Purpose: Defines the display of the text aText at the point AttachmentPoint.
  38         -- The drawer aDrawer specifies the display attributes which texts will have.
  39         -- The presentation object aPresentation stores the
  40         -- information defined in this framework.
  41         -- static void Draw (const Handle(Prs3d_Presentation)&
  42         -- aPresentation, const Handle(Prs3d_TextAspect)&
  43         -- anAspect, const TCollection_ExtendedString& aText,
  44         -- const gp_Pnt& AttachmentPoint);
  45
  46     Draw(myclass; aPresentation: Presentation from Prs3d;
  47                   anAspect: TextAspect from Prs3d;
  48                   aText: ExtendedString from TCollection;
  49                   AttachmentPoint: Pnt from gp);
  50
  51         ---Purpose: Defines the display of the text aText at the point
  52         -- AttachmentPoint.
  53         -- The text aspect object anAspect specifies the display
  54         -- attributes which texts will have.
  55         -- The presentation object aPresentation stores the
  56         -- information defined in this framework.
  57         -- This syntax could be used if you had not already
  58         -- defined text display attributes in a drawer or if you
  59         -- wanted to exceptionally overide the definition
  60         -- provided in your drawer.
  61
  62 end Text from Prs3d;