include/opencascade/Prs3d_Text.hxx

0001 // Created on: 1993-09-14
0002 // Created by: Jean-Louis FRENKEL
0003 // Copyright (c) 1993-1999 Matra Datavision
0004 // Copyright (c) 1999-2014 OPEN CASCADE SAS
0005 //
0006 // This file is part of Open CASCADE Technology software library.
0007 //
0008 // This library is free software; you can redistribute it and/or modify it under
0009 // the terms of the GNU Lesser General Public License version 2.1 as published
0010 // by the Free Software Foundation, with special exception defined in the file
0011 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
0012 // distribution for complete text of the license and disclaimer of any warranty.
0013 //
0014 // Alternatively, this file may be used under the terms of Open CASCADE
0015 // commercial license or contractual agreement.
0016
0017 #ifndef _Prs3d_Text_HeaderFile
0018 #define _Prs3d_Text_HeaderFile
0019
0020 #include <Prs3d_Drawer.hxx>
0021 #include <Prs3d_Presentation.hxx>
0022 #include <Prs3d_TextAspect.hxx>
0023
0024 class TCollection_ExtendedString;
0025 class gp_Pnt;
0026
0027 //! A framework to define the display of texts.
0028 class Prs3d_Text
0029 {
0030 public:
0031
0032   DEFINE_STANDARD_ALLOC
0033
0034   //! Defines the display of the text.
0035   //! @param theGroup  group to add primitives
0036   //! @param theAspect presentation attributes
0037   //! @param theText   text to draw
0038   //! @param theAttachmentPoint attachment point
0039   //! @return text to draw
0040   Standard_EXPORT static Handle(Graphic3d_Text) Draw (const Handle(Graphic3d_Group)& theGroup,
0041                                                       const Handle(Prs3d_TextAspect)& theAspect,
0042                                                       const TCollection_ExtendedString& theText,
0043                                                       const gp_Pnt& theAttachmentPoint);
0044
0045   //! Draws the text label.
0046   //! @param theGroup       group to add primitives
0047   //! @param theAspect      presentation attributes
0048   //! @param theText        text to draw
0049   //! @param theOrientation location and orientation specified in the model 3D space
0050   //! @param theHasOwnAnchor
0051   //! @return text to draw
0052   Standard_EXPORT static Handle(Graphic3d_Text) Draw (const Handle(Graphic3d_Group)&    theGroup,
0053                                                       const Handle(Prs3d_TextAspect)&   theAspect,
0054                                                       const TCollection_ExtendedString& theText,
0055                                                       const gp_Ax2&                     theOrientation,
0056                                                       const Standard_Boolean            theHasOwnAnchor = Standard_True);
0057
0058 };
0059
0060 #endif // _Prs3d_Text_HeaderFile