Open CASCADE Technology
7.3.0
|
Creates and updates a group of attributes for text primitives. This group contains the color, font, expansion factor (height/width ratio), and inter-character space. More...
#include <Graphic3d_AspectText3d.hxx>
Public Member Functions | |
Graphic3d_AspectText3d () | |
Creates a context table for text primitives defined with the following default values: More... | |
Graphic3d_AspectText3d (const Quantity_Color &theColor, const Standard_CString theFont, const Standard_Real theExpansionFactor, const Standard_Real theSpace, const Aspect_TypeOfStyleText theStyle=Aspect_TOST_NORMAL, const Aspect_TypeOfDisplayText theDisplayType=Aspect_TODT_NORMAL) | |
Creates a context table for text primitives defined with the specified values. AFont may be to take means from User(example "Courier New") or Font name defined in Font_NameOfFont(example Font_NOF_ASCII_MONO) or use default font("Courier") More... | |
const Quantity_Color & | Color () const |
Return the text color. More... | |
const Quantity_ColorRGBA & | ColorRGBA () const |
Return the text color. More... | |
void | SetColor (const Quantity_Color &theColor) |
Modifies the color. More... | |
void | SetColor (const Quantity_ColorRGBA &theColor) |
Modifies the color. More... | |
void | SetExpansionFactor (const Standard_Real theFactor) |
Modifies the expansion factor (height/width ratio) If the factor is less than 1, the characters will be higher than they are wide. More... | |
const TCollection_AsciiString & | Font () const |
Return the font. More... | |
void | SetFont (const TCollection_AsciiString &theFont) |
Modifies the font. More... | |
void | SetFont (const Standard_CString theFont) |
Modifies the font. More... | |
Standard_Real | Space () const |
Return the space between characters. More... | |
void | SetSpace (const Standard_Real theSpace) |
Modifies the space between the characters. More... | |
Aspect_TypeOfStyleText | Style () const |
Return the text style. More... | |
void | SetStyle (const Aspect_TypeOfStyleText theStyle) |
Modifies the style of the text. More... | |
Aspect_TypeOfDisplayText | DisplayType () const |
Return display type. More... | |
void | SetDisplayType (const Aspect_TypeOfDisplayText theDisplayType) |
Define the display type of the text. More... | |
const Quantity_ColorRGBA & | ColorSubTitleRGBA () const |
Return subtitle color. More... | |
const Quantity_Color & | ColorSubTitle () const |
Return subtitle color. More... | |
void | SetColorSubTitle (const Quantity_Color &theColor) |
Modifies the color of the subtitle for the TODT_SUBTITLE TextDisplayType and the color of background for the TODT_DEKALE TextDisplayType. More... | |
void | SetColorSubTitle (const Quantity_ColorRGBA &theColor) |
Modifies the color of the subtitle for the TODT_SUBTITLE TextDisplayType and the color of background for the TODT_DEKALE TextDisplayType. More... | |
bool | GetTextZoomable () const |
Returns TRUE when the Text Zoomable is on. More... | |
void | SetTextZoomable (const bool theFlag) |
Turns usage of text zoomable on/off. More... | |
Standard_Real | GetTextAngle () const |
Returns Angle of degree. More... | |
void | SetTextAngle (const Standard_Real theAngle) |
Turns usage of text rotated. More... | |
Font_FontAspect | GetTextFontAspect () const |
Returns text FontAspect. More... | |
void | SetTextFontAspect (const Font_FontAspect theFontAspect) |
Turns usage of Aspect text. More... | |
const Handle< Graphic3d_ShaderProgram > & | ShaderProgram () const |
Return the shader program. More... | |
void | SetShaderProgram (const Handle< Graphic3d_ShaderProgram > &theProgram) |
Sets up OpenGL/GLSL shader program. More... | |
Standard_DEPRECATED ("Deprecated method Values() should be replaced by individual property getters") void Values(Quantity_Color &theColor | |
Returns the current values of the group. More... | |
Standard_DEPRECATED ("Deprecated method Values() should be replaced by individual property getters") void Values(Quantity_Color &theColor | |
Returns the current values of the group. More... | |
Standard_DEPRECATED ("Deprecated method Values() should be replaced by individual property getters") void Values(Quantity_Color &theColor | |
Returns the current values of the group. More... | |
Standard_DEPRECATED ("Deprecated method Values() should be replaced by individual property getters") void Values(Quantity_Color &theColor | |
Returns the current values of the group. More... | |
Public Member Functions inherited from Standard_Transient | |
Standard_Transient () | |
Empty constructor. More... | |
Standard_Transient (const Standard_Transient &) | |
Copy constructor – does nothing. More... | |
Standard_Transient & | operator= (const Standard_Transient &) |
Assignment operator, needed to avoid copying reference counter. More... | |
virtual | ~Standard_Transient () |
Destructor must be virtual. More... | |
virtual void | Delete () const |
Memory deallocator for transient classes. More... | |
virtual const opencascade::handle< Standard_Type > & | DynamicType () const |
Returns a type descriptor about this object. More... | |
Standard_Boolean | IsInstance (const opencascade::handle< Standard_Type > &theType) const |
Returns a true value if this is an instance of Type. More... | |
Standard_Boolean | IsInstance (const Standard_CString theTypeName) const |
Returns a true value if this is an instance of TypeName. More... | |
Standard_Boolean | IsKind (const opencascade::handle< Standard_Type > &theType) const |
Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More... | |
Standard_Boolean | IsKind (const Standard_CString theTypeName) const |
Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism. More... | |
Standard_Transient * | This () const |
Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero. More... | |
Standard_Integer | GetRefCount () const |
Get the reference counter of this object. More... | |
void | IncrementRefCounter () const |
Increments the reference counter of this object. More... | |
Standard_Integer | DecrementRefCounter () const |
Decrements the reference counter of this object; returns the decremented value. More... | |
Additional Inherited Members | |
Public Types inherited from Standard_Transient | |
typedef void | base_type |
Returns a type descriptor about this object. More... | |
Static Public Member Functions inherited from Standard_Transient | |
static const char * | get_type_name () |
Returns a type descriptor about this object. More... | |
static const opencascade::handle< Standard_Type > & | get_type_descriptor () |
Returns type descriptor of Standard_Transient class. More... | |
Creates and updates a group of attributes for text primitives. This group contains the color, font, expansion factor (height/width ratio), and inter-character space.
NOTE: The font name is stored in the aspect instance so it is safe to pass it as const char* to OpenGl package without copying the string. However, the aspect should not be deleted until the text drawn using this aspect is no longer visible. The best practice is to keep the aspect in the object's drawer.
Graphic3d_AspectText3d::Graphic3d_AspectText3d | ( | ) |
Creates a context table for text primitives defined with the following default values:
Color : NOC_YELLOW Font : NOF_ASCII_MONO Expansion factor : 1. Space between characters : 0. The style : TOST_NORMAL The display type : TODT_NORMAL
Graphic3d_AspectText3d::Graphic3d_AspectText3d | ( | const Quantity_Color & | theColor, |
const Standard_CString | theFont, | ||
const Standard_Real | theExpansionFactor, | ||
const Standard_Real | theSpace, | ||
const Aspect_TypeOfStyleText | theStyle = Aspect_TOST_NORMAL , |
||
const Aspect_TypeOfDisplayText | theDisplayType = Aspect_TODT_NORMAL |
||
) |
Creates a context table for text primitives defined with the specified values. AFont may be to take means from User(example "Courier New") or Font name defined in Font_NameOfFont(example Font_NOF_ASCII_MONO) or use default font("Courier")
|
inline |
Return the text color.
|
inline |
Return the text color.
|
inline |
Return subtitle color.
|
inline |
Return subtitle color.
|
inline |
Return display type.
|
inline |
Return the font.
|
inline |
Returns Angle of degree.
|
inline |
Returns text FontAspect.
|
inline |
Returns TRUE when the Text Zoomable is on.
|
inline |
Modifies the color.
|
inline |
Modifies the color.
|
inline |
Modifies the color of the subtitle for the TODT_SUBTITLE TextDisplayType and the color of background for the TODT_DEKALE TextDisplayType.
|
inline |
Modifies the color of the subtitle for the TODT_SUBTITLE TextDisplayType and the color of background for the TODT_DEKALE TextDisplayType.
|
inline |
Define the display type of the text.
TODT_NORMAL Default display. Text only. TODT_SUBTITLE There is a subtitle under the text. TODT_DEKALE The text is displayed with a 3D style. TODT_BLEND The text is displayed in XOR. TODT_DIMENSION Dimension line under text will be invisible.
|
inline |
Modifies the expansion factor (height/width ratio) If the factor is less than 1, the characters will be higher than they are wide.
|
inline |
Modifies the font.
|
inline |
Modifies the font.
|
inline |
Sets up OpenGL/GLSL shader program.
|
inline |
Modifies the space between the characters.
|
inline |
Modifies the style of the text.
|
inline |
Turns usage of text rotated.
|
inline |
Turns usage of Aspect text.
|
inline |
Turns usage of text zoomable on/off.
|
inline |
Return the shader program.
|
inline |
Return the space between characters.
Graphic3d_AspectText3d::Standard_DEPRECATED | ( | "Deprecated method Values() should be replaced by individual property getters" | ) | & |
Returns the current values of the group.
Graphic3d_AspectText3d::Standard_DEPRECATED | ( | "Deprecated method Values() should be replaced by individual property getters" | ) | & |
Returns the current values of the group.
Graphic3d_AspectText3d::Standard_DEPRECATED | ( | "Deprecated method Values() should be replaced by individual property getters" | ) | & |
Returns the current values of the group.
Graphic3d_AspectText3d::Standard_DEPRECATED | ( | "Deprecated method Values() should be replaced by individual property getters" | ) | & |
Returns the current values of the group.
|
inline |
Return the text style.
Standard_CString Standard_Real Standard_Real& theSpace Graphic3d_AspectText3d::const |
Standard_CString Standard_Real Standard_Real Aspect_TypeOfStyleText Aspect_TypeOfDisplayText Quantity_Color& theColorSubTitle Graphic3d_AspectText3d::const |
Standard_CString Standard_Real Standard_Real Aspect_TypeOfStyleText Aspect_TypeOfDisplayText Quantity_Color Standard_Boolean Standard_Real& theTextAngle Graphic3d_AspectText3d::const |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
Standard_CString Standard_Real Standard_Real Aspect_TypeOfStyleText Aspect_TypeOfDisplayText Quantity_Color & Graphic3d_AspectText3d::theColorSubTitle = myColorSubTitle.GetRGB() |
Standard_CString Standard_Real Standard_Real Aspect_TypeOfStyleText Aspect_TypeOfDisplayText Quantity_Color& Graphic3d_AspectText3d::theColorSubTitle |
Standard_CString Standard_Real Standard_Real Aspect_TypeOfStyleText Aspect_TypeOfDisplayText & Graphic3d_AspectText3d::theDisplayType |
Graphic3d_AspectText3d::theDisplayType = myDisplayType |
Standard_CString Standard_Real & Graphic3d_AspectText3d::theExpansionFactor |
Graphic3d_AspectText3d::theExpansionFactor = myFactor |
Standard_CString & Graphic3d_AspectText3d::theFont |
Graphic3d_AspectText3d::theFont = myFont.ToCString() |
Standard_CString Standard_Real Standard_Real & Graphic3d_AspectText3d::theSpace = mySpace |
Standard_CString Standard_Real Standard_Real& Graphic3d_AspectText3d::theSpace |
Standard_CString Standard_Real Standard_Real Aspect_TypeOfStyleText & Graphic3d_AspectText3d::theStyle |
Graphic3d_AspectText3d::theStyle = myStyle |
Graphic3d_AspectText3d::theTextAngle = myTextAngle |
Standard_CString Standard_Real Standard_Real Aspect_TypeOfStyleText Aspect_TypeOfDisplayText Quantity_Color Standard_Boolean Standard_Real& Graphic3d_AspectText3d::theTextAngle |
Graphic3d_AspectText3d::theTextFontAspect = myTextFontAspect |
Standard_CString Standard_Real Standard_Real Aspect_TypeOfStyleText Aspect_TypeOfDisplayText Quantity_Color Standard_Boolean & Graphic3d_AspectText3d::theTextZoomable |
Graphic3d_AspectText3d::theTextZoomable = myTextZoomable |