OSGTextFace.h

Go to the documentation of this file.

/*---------------------------------------------------------------------------*\
 *                                OpenSG                                     *
 *                                                                           *
 *                                                                           *
 *             Copyright (C) 2000-2002 by the OpenSG Forum                   *
 *                                                                           *
 *                            www.opensg.org                                 *
 *                                                                           *
 *   contact: dirk@opensg.org, gerrit.voss@vossg.org, jbehr@zgdv.de          *
 *                                                                           *
\*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*\
 *                                License                                    *
 *                                                                           *
 * This library is free software; you can redistribute it and/or modify it   *
 * under the terms of the GNU Library General Public License as published    *
 * by the Free Software Foundation, version 2.                               *
 *                                                                           *
 * This library is distributed in the hope that it will be useful, but       *
 * WITHOUT ANY WARRANTY; without even the implied warranty of                *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU         *
 * Library General Public License for more details.                          *
 *                                                                           *
 * You should have received a copy of the GNU Library General Public         *
 * License along with this library; if not, write to the Free Software       *
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.                 *
 *                                                                           *
\*---------------------------------------------------------------------------*/
/*---------------------------------------------------------------------------*\
 *                                Changes                                    *
 *                                                                           *
 *                                                                           *
 *                                                                           *
 *                                                                           *
 *                                                                           *
 *                                                                           *
\*---------------------------------------------------------------------------*/

#ifndef _OSGTEXTFACE_H_
#define _OSGTEXTFACE_H_

#ifdef _MSC_VER
# pragma once
#endif

#include <OSGConfig.h>
#include <OSGSystemDef.h>
#include <OSGBaseTypes.h>
#include <OSGVector.h>
#include <OSGMemoryObject.h>

#include "OSGTextGlyph.h"

#include <string>
#include <vector>


OSG_BEGIN_NAMESPACE


class TextLayoutParam;
class TextLayoutResult;


class OSG_SYSTEMLIB_DLLMAPPING TextFace: public MemoryObject
{
    /*==========================  PUBLIC  =================================*/
  public:

    enum Style
    {
        STYLE_PLAIN,
        STYLE_BOLD,
        STYLE_ITALIC,
        STYLE_BOLDITALIC
    };

    inline const std::string getFamily() const;

    inline Style getStyle() const;

    inline Real32 getHoriAscent() const;

    inline Real32 getVertAscent() const;
    
    inline Real32 getHoriDescent() const;

    inline Real32 getVertDescent() const;

    virtual const TextGlyph &getGlyph(TextGlyph::Index glyphIndex) = 0;

    virtual void layout(const std::string &utf8Text, 
                        const TextLayoutParam &param,
                        TextLayoutResult &result);

    virtual void layout(const std::wstring &text, 
                        const TextLayoutParam &param,
                        TextLayoutResult &result) = 0;

    virtual void layout(const std::vector<std::string> &lines, 
                        const TextLayoutParam &param,
                        TextLayoutResult &result);

    virtual void layout(const std::vector<std::wstring> &lines,
                        const TextLayoutParam &param,
                        TextLayoutResult &result);

    void calculateBoundingBox(const TextLayoutResult &layoutResult, Vec2f &lowerLeft, Vec2f &upperRight);

    static void convertUTF8ToUnicode(const std::string &utf8Text, std::wstring &text);

    /*=========================  PROTECTED  ===============================*/
  protected:

    inline TextFace();

    virtual ~TextFace();
    
    std::string _family;

    Style _style;

    Real32 _horiAscent;

    Real32 _vertAscent;
    
    Real32 _horiDescent;
    
    Real32 _vertDescent;

    void justifyLine(const TextLayoutParam &param,
                     const std::vector<UInt32> &spaceIndices,
                     Vec2f &currPos, TextLayoutResult &layoutResult) const;

    void adjustLineOrigin(const TextLayoutParam &param,
                          const Vec2f &currPos,
                          TextLayoutResult &layoutResult) const;

    /*==========================  PRIVATE  ================================*/
  private:

    TextFace(const TextFace &);

    const TextFace &operator=(const TextFace &);
};


OSG_END_NAMESPACE


#include <OSGTextFace.inl>

#define OSGTEXTFACE_HEADER_CVSID "@(#)$Id: OSGTextFace.h,v 1.1 2005/03/03 13:43:06 a-m-z Exp $"

#endif /* _OSGTEXTFACE_H_ */

---