0031313: Foundation Classes - Dump improvement for classes
[occt.git] / src / Prs3d / Prs3d_Text.hxx
CommitLineData
42cf5bc1 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
42cf5bc1 20#include <Prs3d_Root.hxx>
21#include <Prs3d_Drawer.hxx>
5b111128 22#include <Prs3d_TextAspect.hxx>
23
ce01ec26 24#include <gp_Ax2.hxx>
25
42cf5bc1 26class TCollection_ExtendedString;
27class gp_Pnt;
42cf5bc1 28
29//! A framework to define the display of texts.
4ad142d9 30class Prs3d_Text : public Prs3d_Root
42cf5bc1 31{
32public:
33
34 DEFINE_STANDARD_ALLOC
35
4ad142d9 36 //! Defines the display of the text.
37 //! @param theGroup group to add primitives
38 //! @param theAspect presentation attributes
39 //! @param theText text to draw
40 //! @param theAttachmentPoint attachment point
41 Standard_EXPORT static void Draw (const Handle(Graphic3d_Group)& theGroup,
42 const Handle(Prs3d_TextAspect)& theAspect,
43 const TCollection_ExtendedString& theText,
44 const gp_Pnt& theAttachmentPoint);
45
46 //! Draws the text label.
47 //! @param theGroup group to add primitives
48 //! @param theAspect presentation attributes
49 //! @param theText text to draw
50 //! @param theOrientation location and orientation specified in the model 3D space
51 //! @param theHasOwnAnchor
52 Standard_EXPORT static void Draw (const Handle(Graphic3d_Group)& theGroup,
ce01ec26 53 const Handle(Prs3d_TextAspect)& theAspect,
54 const TCollection_ExtendedString& theText,
3f1eb0ab 55 const gp_Ax2& theOrientation,
56 const Standard_Boolean theHasOwnAnchor = Standard_True);
42cf5bc1 57
4ad142d9 58public:
42cf5bc1 59
4ad142d9 60 //! Alias to another method Draw() for backward compatibility.
61 Standard_DEPRECATED("Prs3d_Text::Draw() taking Graphic3d_Group should be used instead")
62 static void Draw (const Handle(Prs3d_Presentation)& thePrs,
63 const Handle(Prs3d_Drawer)& theDrawer,
64 const TCollection_ExtendedString& theText,
65 const gp_Pnt& theAttachmentPoint)
66 {
67 Draw (Prs3d_Root::CurrentGroup (thePrs), theDrawer->TextAspect(), theText, theAttachmentPoint);
68 }
69
70 //! Alias to another method Draw() for backward compatibility.
71 Standard_DEPRECATED("Prs3d_Text::Draw() taking Graphic3d_Group should be used instead")
72 static void Draw (const Handle(Prs3d_Presentation)& thePrs,
73 const Handle(Prs3d_TextAspect)& theAspect,
74 const TCollection_ExtendedString& theText,
75 const gp_Ax2& theOrientation,
76 const Standard_Boolean theHasOwnAnchor = Standard_True)
77 {
78 Draw (Prs3d_Root::CurrentGroup (thePrs), theAspect, theText, theOrientation, theHasOwnAnchor);
79 }
80
81 //! Alias to another method Draw() for backward compatibility.
82 Standard_DEPRECATED("Prs3d_Text::Draw() taking Graphic3d_Group should be used instead")
83 static void Draw (const Handle(Prs3d_Presentation)& thePrs,
84 const Handle(Prs3d_TextAspect)& theAspect,
85 const TCollection_ExtendedString& theText,
86 const gp_Pnt& theAttachmentPoint)
87 {
88 Draw (Prs3d_Root::CurrentGroup (thePrs), theAspect, theText, theAttachmentPoint);
89 }
42cf5bc1 90
91};
92
42cf5bc1 93#endif // _Prs3d_Text_HeaderFile