1 // Created on: 2014-11-10
2 // Copyright (c) 2014 OPEN CASCADE SAS
4 // This file is part of Open CASCADE Technology software library.
6 // This library is free software; you can redistribute it and/or modify it under
7 // the terms of the GNU Lesser General Public License version 2.1 as published
8 // by the Free Software Foundation, with special exception defined in the file
9 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
10 // distribution for complete text of the license and disclaimer of any warranty.
12 // Alternatively, this file may be used under the terms of Open CASCADE
13 // commercial license or contractual agreement.
15 #ifndef _AIS_TextLabel_HeaderFile
16 #define _AIS_TextLabel_HeaderFile
18 #include <AIS_InteractiveObject.hxx>
22 #include <Graphic3d_VerticalTextAlignment.hxx>
23 #include <Graphic3d_HorizontalTextAlignment.hxx>
24 #include <Font_FontAspect.hxx>
25 #include <TCollection_ExtendedString.hxx>
27 //! Presentation of the text.
28 class AIS_TextLabel : public AIS_InteractiveObject
32 //! Default constructor
33 Standard_EXPORT AIS_TextLabel();
35 //! Setup color of entire text.
36 Standard_EXPORT virtual void SetColor (const Quantity_Color& theColor) Standard_OVERRIDE;
38 //! Setup color of entire text.
39 virtual void SetColor (const Quantity_NameOfColor theColor) Standard_OVERRIDE { SetColor (Quantity_Color (theColor)); }
41 //! Setup transparency within [0, 1] range.
42 Standard_EXPORT virtual void SetTransparency (const Standard_Real theValue) Standard_OVERRIDE;
44 //! Removes the transparency setting.
45 virtual void UnsetTransparency() Standard_OVERRIDE { SetTransparency (0.0); }
47 //! Material has no effect for text label.
48 virtual void SetMaterial (const Graphic3d_NameOfMaterial ) Standard_OVERRIDE {}
50 //! Material has no effect for text label.
51 virtual void SetMaterial (const Graphic3d_MaterialAspect& ) Standard_OVERRIDE {}
54 Standard_EXPORT void SetText (const TCollection_ExtendedString& theText);
57 Standard_EXPORT void SetPosition (const gp_Pnt& thePosition);
59 //! Setup horizontal justification.
60 Standard_EXPORT void SetHJustification (const Graphic3d_HorizontalTextAlignment theHJust);
62 //! Setup vertical justification.
63 Standard_EXPORT void SetVJustification (const Graphic3d_VerticalTextAlignment theVJust);
66 Standard_EXPORT void SetAngle (const Standard_Real theAngle);
68 //! Setup zoomable property.
69 Standard_EXPORT void SetZoomable (const Standard_Boolean theIsZoomable);
72 Standard_EXPORT void SetHeight (const Standard_Real theHeight);
74 //! Setup font aspect.
75 Standard_EXPORT void SetFontAspect (const Font_FontAspect theFontAspect);
78 Standard_EXPORT void SetFont (Standard_CString theFont);
80 //! Setup label orientation in the model 3D space.
81 Standard_EXPORT void SetOrientation3D (const gp_Ax2& theOrientation);
83 //! Reset label orientation in the model 3D space.
84 Standard_EXPORT void UnsetOrientation3D ();
87 Standard_EXPORT const gp_Pnt& Position() const;
89 //! Returns label orientation in the model 3D space.
90 Standard_EXPORT const gp_Ax2& Orientation3D() const;
92 //! Returns true if the current text placement mode uses text orientation in the model 3D space.
93 Standard_EXPORT Standard_Boolean HasOrientation3D() const;
95 Standard_EXPORT void SetFlipping (const Standard_Boolean theIsFlipping);
97 Standard_EXPORT Standard_Boolean HasFlipping() const;
99 //! Define the display type of the text.
101 //! TODT_NORMAL Default display. Text only.
102 //! TODT_SUBTITLE There is a subtitle under the text.
103 //! TODT_DEKALE The text is displayed with a 3D style.
104 //! TODT_BLEND The text is displayed in XOR.
105 //! TODT_DIMENSION Dimension line under text will be invisible.
106 Standard_EXPORT void SetDisplayType (const Aspect_TypeOfDisplayText theDisplayType);
108 //! Modifies the colour of the subtitle for the TODT_SUBTITLE TextDisplayType
109 //! and the colour of backgroubd for the TODT_DEKALE TextDisplayType.
110 Standard_EXPORT void SetColorSubTitle (const Quantity_Color& theColor);
115 Standard_EXPORT virtual void Compute (const Handle(PrsMgr_PresentationManager3d)& thePresentationManager,
116 const Handle(Prs3d_Presentation)& thePresentation,
117 const Standard_Integer theMode) Standard_OVERRIDE;
119 //! Compute selection
120 Standard_EXPORT virtual void ComputeSelection (const Handle(SelectMgr_Selection)& theSelection,
121 const Standard_Integer theMode) Standard_OVERRIDE;
125 TCollection_ExtendedString myText;
126 TCollection_AsciiString myFont;
127 Font_FontAspect myFontAspect;
128 gp_Ax2 myOrientation3D;
129 Standard_Boolean myHasOrientation3D;
130 Standard_Boolean myHasFlipping;
135 DEFINE_STANDARD_RTTIEXT(AIS_TextLabel,AIS_InteractiveObject)
139 DEFINE_STANDARD_HANDLE(AIS_TextLabel, AIS_InteractiveObject)
141 #endif // _AIS_TextLabel_HeaderFile