src/Prs3d/Prs3d_Text.hxx

   1 // Created on: 1993-09-14
   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 #ifndef _Prs3d_Text_HeaderFile
  18 #define _Prs3d_Text_HeaderFile
  19
  20 #include <Standard.hxx>
  21 #include <Standard_DefineAlloc.hxx>
  22 #include <Standard_Handle.hxx>
  23
  24 #include <Prs3d_Root.hxx>
  25 #include <Prs3d_Drawer.hxx>
  26 #include <Prs3d_TextAspect.hxx>
  27
  28 #include <gp_Ax2.hxx>
  29
  30 class Prs3d_Presentation;
  31 class TCollection_ExtendedString;
  32 class gp_Pnt;
  33
  34 //! A framework to define the display of texts.
  35 class Prs3d_Text  : public Prs3d_Root
  36 {
  37 public:
  38
  39   DEFINE_STANDARD_ALLOC
  40
  41
  42   //! Defines the display of the text aText at the point AttachmentPoint.
  43   //! The drawer aDrawer specifies the display attributes which texts will have.
  44   //! The presentation object aPresentation stores the
  45   //! information defined in this framework.
  46   //! static void Draw (const Handle(Prs3d_Presentation)&
  47   //! aPresentation, const Handle(Prs3d_TextAspect)&
  48   //! anAspect, const TCollection_ExtendedString& aText,
  49   //! const gp_Pnt& AttachmentPoint);
  50   Standard_EXPORT static void Draw (const Handle(Prs3d_Presentation)& aPresentation, const Handle(Prs3d_Drawer)& aDrawer, const TCollection_ExtendedString& aText, const gp_Pnt& AttachmentPoint);
  51
  52   //! Draws theText label with the location and the orientation
  53   //! specified in the model 3D space through theOrientation argument.
  54   Standard_EXPORT static void Draw (const Handle(Prs3d_Presentation)& thePresentation,
  55                                     const Handle(Prs3d_TextAspect)&   theAspect,
  56                                     const TCollection_ExtendedString& theText,
  57                                     const gp_Ax2&                     theOrientation);
  58
  59   //! Defines the display of the text aText at the point
  60   //! AttachmentPoint.
  61   //! The text aspect object anAspect specifies the display
  62   //! attributes which texts will have.
  63   //! The presentation object aPresentation stores the
  64   //! information defined in this framework.
  65   //! This syntax could be used if you had not already
  66   //! defined text display attributes in a drawer or if you
  67   //! wanted to exceptionally overide the definition
  68   //! provided in your drawer.
  69   Standard_EXPORT static void Draw (const Handle(Prs3d_Presentation)& aPresentation, const Handle(Prs3d_TextAspect)& anAspect, const TCollection_ExtendedString& aText, const gp_Pnt& AttachmentPoint);
  70
  71
  72
  73
  74 protected:
  75
  76
  77
  78
  79
  80 private:
  81
  82
  83
  84
  85
  86 };
  87
  88
  89
  90
  91
  92
  93
  94 #endif // _Prs3d_Text_HeaderFile