Open CASCADE Technology  7.3.0
Public Member Functions
Vrml_AsciiText Class Reference

defines a AsciiText node of VRML specifying geometry shapes. This node represents strings of text characters from ASCII coded character set. All subsequent strings advance y by -( size * spacing). The justification field determines the placement of the strings in the x dimension. LEFT (the default) places the left edge of each string at x=0. CENTER places the center of each string at x=0. RIGHT places the right edge of each string at x=0. Text is rendered from left to right, top to bottom in the font set by FontStyle. The default value for the wigth field indicates the natural width should be used for that string. More...

#include <Vrml_AsciiText.hxx>

Inheritance diagram for Vrml_AsciiText:
Inheritance graph
[legend]

Public Member Functions

 Vrml_AsciiText ()
 
 Vrml_AsciiText (const Handle< TColStd_HArray1OfAsciiString > &aString, const Standard_Real aSpacing, const Vrml_AsciiTextJustification aJustification, const Standard_Real aWidth)
 
void SetString (const Handle< TColStd_HArray1OfAsciiString > &aString)
 
Handle< TColStd_HArray1OfAsciiString > String () const
 
void SetSpacing (const Standard_Real aSpacing)
 
Standard_Real Spacing () const
 
void SetJustification (const Vrml_AsciiTextJustification aJustification)
 
Vrml_AsciiTextJustification Justification () const
 
void SetWidth (const Standard_Real aWidth)
 
Standard_Real Width () const
 
Standard_OStreamPrint (Standard_OStream &anOStream) const
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (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_TransientThis () 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...
 

Detailed Description

defines a AsciiText node of VRML specifying geometry shapes. This node represents strings of text characters from ASCII coded character set. All subsequent strings advance y by -( size * spacing). The justification field determines the placement of the strings in the x dimension. LEFT (the default) places the left edge of each string at x=0. CENTER places the center of each string at x=0. RIGHT places the right edge of each string at x=0. Text is rendered from left to right, top to bottom in the font set by FontStyle. The default value for the wigth field indicates the natural width should be used for that string.

Constructor & Destructor Documentation

◆ Vrml_AsciiText() [1/2]

Vrml_AsciiText::Vrml_AsciiText ( )

◆ Vrml_AsciiText() [2/2]

Vrml_AsciiText::Vrml_AsciiText ( const Handle< TColStd_HArray1OfAsciiString > &  aString,
const Standard_Real  aSpacing,
const Vrml_AsciiTextJustification  aJustification,
const Standard_Real  aWidth 
)

Member Function Documentation

◆ Justification()

Vrml_AsciiTextJustification Vrml_AsciiText::Justification ( ) const

◆ Print()

Standard_OStream& Vrml_AsciiText::Print ( Standard_OStream anOStream) const

◆ SetJustification()

void Vrml_AsciiText::SetJustification ( const Vrml_AsciiTextJustification  aJustification)

◆ SetSpacing()

void Vrml_AsciiText::SetSpacing ( const Standard_Real  aSpacing)

◆ SetString()

void Vrml_AsciiText::SetString ( const Handle< TColStd_HArray1OfAsciiString > &  aString)

◆ SetWidth()

void Vrml_AsciiText::SetWidth ( const Standard_Real  aWidth)

◆ Spacing()

Standard_Real Vrml_AsciiText::Spacing ( ) const

◆ String()

Handle< TColStd_HArray1OfAsciiString > Vrml_AsciiText::String ( ) const

◆ Width()

Standard_Real Vrml_AsciiText::Width ( ) const

The documentation for this class was generated from the following file: