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 <Prs3d_Drawer.hxx>
  21 #include <Prs3d_Presentation.hxx>
  22 #include <Prs3d_TextAspect.hxx>
  23
  24 class TCollection_ExtendedString;
  25 class gp_Pnt;
  26
  27 //! A framework to define the display of texts.
  28 class Prs3d_Text
  29 {
  30 public:
  31
  32   DEFINE_STANDARD_ALLOC
  33
  34   //! Defines the display of the text.
  35   //! @param theGroup  group to add primitives
  36   //! @param theAspect presentation attributes
  37   //! @param theText   text to draw
  38   //! @param theAttachmentPoint attachment point
  39   //! @return text to draw
  40   Standard_EXPORT static Handle(Graphic3d_Text) Draw (const Handle(Graphic3d_Group)& theGroup,
  41                                                       const Handle(Prs3d_TextAspect)& theAspect,
  42                                                       const TCollection_ExtendedString& theText,
  43                                                       const gp_Pnt& theAttachmentPoint);
  44
  45   //! Draws the text label.
  46   //! @param theGroup       group to add primitives
  47   //! @param theAspect      presentation attributes
  48   //! @param theText        text to draw
  49   //! @param theOrientation location and orientation specified in the model 3D space
  50   //! @param theHasOwnAnchor
  51   //! @return text to draw
  52   Standard_EXPORT static Handle(Graphic3d_Text) Draw (const Handle(Graphic3d_Group)&    theGroup,
  53                                                       const Handle(Prs3d_TextAspect)&   theAspect,
  54                                                       const TCollection_ExtendedString& theText,
  55                                                       const gp_Ax2&                     theOrientation,
  56                                                       const Standard_Boolean            theHasOwnAnchor = Standard_True);
  57
  58 };
  59
  60 #endif // _Prs3d_Text_HeaderFile