OCCT3D OCCT 8.0.1
OCCT documentation

Search guides and API reference

Enter at least two characters.

    Open CASCADE Technology Reference Manual 8.0.1
    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:

    Public Member Functions

     Vrml_AsciiText ()
     Vrml_AsciiText (const occ::handle< NCollection_HArray1< TCollection_AsciiString > > &aString, const double aSpacing, const Vrml_AsciiTextJustification aJustification, const double aWidth)
    void SetString (const occ::handle< NCollection_HArray1< TCollection_AsciiString > > &aString)
    occ::handle< NCollection_HArray1< TCollection_AsciiString > > String () const
    void SetSpacing (const double aSpacing)
    double Spacing () const
    void SetJustification (const Vrml_AsciiTextJustification aJustification)
    Vrml_AsciiTextJustification Justification () const
    void SetWidth (const double aWidth)
    double Width () const
    Standard_OStreamPrint (Standard_OStream &anOStream) const
    Public Member Functions inherited from Standard_Transient
     Standard_Transient ()
     Empty constructor.
     Standard_Transient (const Standard_Transient &)
     Copy constructor – does nothing.
    Standard_Transientoperator= (const Standard_Transient &)
     Assignment operator, needed to avoid copying reference counter.
    virtual ~Standard_Transient ()=default
     Destructor must be virtual.
    virtual const opencascade::handle< Standard_Type > & DynamicType () const
     Returns a type descriptor about this object.
    bool IsInstance (const opencascade::handle< Standard_Type > &theType) const
     Returns a true value if this is an instance of Type.
    bool IsInstance (const char *const theTypeName) const
     Returns a true value if this is an instance of TypeName.
    bool 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.
    bool IsKind (const char *const 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.
    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.
    int GetRefCount () const noexcept
     Get the reference counter of this object.
    void IncrementRefCounter () noexcept
     Increments the reference counter of this object. Uses relaxed memory ordering since incrementing only requires atomicity, not synchronization with other memory operations.
    int DecrementRefCounter () noexcept
     Decrements the reference counter of this object; returns the decremented value. Uses release ordering for the decrement to ensure all writes to the object are visible before the count reaches zero. An acquire fence is added only when the count reaches zero, ensuring proper synchronization before deletion. This is more efficient than using acq_rel for every decrement.
    virtual void Delete () const
     Memory deallocator for transient classes.

    Additional Inherited Members

    typedef void base_type
     Returns a type descriptor about this object.
    static constexpr const char * get_type_name ()
     Returns a type descriptor about this object.
    static const opencascade::handle< Standard_Type > & get_type_descriptor ()
     Returns type descriptor of Standard_Transient class.

    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 occ::handle< NCollection_HArray1< TCollection_AsciiString > > & aString,
    const double aSpacing,
    const Vrml_AsciiTextJustification aJustification,
    const double 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 double aSpacing)

    ◆ SetString()

    void Vrml_AsciiText::SetString ( const occ::handle< NCollection_HArray1< TCollection_AsciiString > > & aString)

    ◆ SetWidth()

    void Vrml_AsciiText::SetWidth ( const double aWidth)

    ◆ Spacing()

    double Vrml_AsciiText::Spacing ( ) const

    ◆ String()

    occ::handle< NCollection_HArray1< TCollection_AsciiString > > Vrml_AsciiText::String ( ) const

    ◆ Width()

    double Vrml_AsciiText::Width ( ) const

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