VRS - The Virtual Rendering System

version 3.3

text.h

Go to the documentation of this file.

/******************************************************************************
 * VRS - The Virtual Rendering System
 * Copyright (C) 2003 Computer Graphics Systems Group at the 
 * Hasso-Plattner-Institute (HPI), Potsdam, Germany.
 *
 * This  library  is  free  software; you can redistribute it and/or  modify it
 * under the terms of the GNU Lesser General Public  License  as  published  by
 * the  Free  Software  Foundation;  either  version 2.1 of the License, or (at
 * your option) any later version. 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 Lesser General Public License for more details. You should have received
 * a copy of the GNU Lesser+ General Public License along with this library; if
 * not, write to the FreeSoftware Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA, 02111-1307, USA.
 ******************************************************************************/

// $Id: text.h 6014 2007-08-09 07:51:16Z Konstantin_Baumann $
// $Date: 2007-08-09 09:51:16 +0200 (Thu, 09 Aug 2007) $
// $Revision: 6014 $
// $State$
// $Author: Konstantin_Baumann $
//
// $Log$
// Revision 1.27  2005/06/21 15:40:46  baumann
// changed color definition
//
// Revision 1.26  2005/01/03 01:43:08  klimetschek
// - modified win32 project layout, splitted vrs.vcproj into vrs_container, vrs_core, vrs_sg, vrs_image, vrs_opengl and vrs_io
// - removed vrs.vcproj
// minor things:
// - added all glutexamples to vrs4glut.sln
// - fixed some problems in glutexamples
// - removed all project references from all VS projects (using solution wide project dependencies instead)
//
// Revision 1.25  2004/11/25 09:45:54  baumann
// ctor for wstring was ambiguous
//
// Revision 1.24  2004/11/05 13:58:10  basch
// Class comment changed (Doxygen style)
//
// Revision 1.23  2004/09/30 07:31:16  baumann
// added flag "useModulateForTexturing"
//
// Revision 1.22  2004/03/12 16:28:39  baumann
// macros VRS_NAMESPACE_BEGIN/_END expanded and removed
//
// Revision 1.21  2004/01/19 11:43:57  baumann
// serialization mechanism improved
//
// Revision 1.20  2004/01/19 07:28:03  baumann
// serialization mechanism improved
//
// Revision 1.19  2003/11/26 10:50:08  skirsch
// added fixed size functionality
//
// Revision 1.18  2003/11/07 14:19:24  kirsch
// removed leading underscore from include guards
//
// Revision 1.17  2003/09/15 10:26:03  skirsch
// added pixel bounding box query
//
// Revision 1.16  2003/06/23 11:55:22  baumann
// signatures corrected for getText()/getUnicodeText()
//
// Revision 1.15  2003/06/23 09:47:42  baumann
// - new compile time switch VRS_HAS_WSTRING added
// - renamed macros VRS_HAVE_* to VRS_HAS_*
// - removed "typedef std::string String;"
// - Font uses ImageTexture2D instead of ImageTexture2DGL
//
// Revision 1.14  2002/11/05 13:23:39  kirsch
// added endline at the end of file
//
// Revision 1.13  2002/11/05 09:43:15  kersting
// changes due to VC6
//
// Revision 1.12  2002/11/05 08:28:58  skirsch
// merged UnicodeText and Text
//
// Revision 1.11  2002/11/04 10:23:26  baumann
// explicit copy constructor removed
//
// Revision 1.10  2002/10/30 12:23:04  kirsch
// gcc warnings fixed
//
// Revision 1.9  2002/10/29 23:57:24  skirsch
// introduced unicode support
//
// Revision 1.8  2002/10/29 10:32:52  baumann
// macros VRS_CLASSNAME_* and VRS_IMPL_TYPEINFO_* removed
//
// Revision 1.7  2002/10/06 17:01:08  skirsch
// added copy constructor
//
// Revision 1.6  2002/09/01 10:43:03  skirsch
// improved the haloe for the extruded font
//
// Revision 1.5  2002/07/18 15:13:23  skirsch
// added a method to query the height and corrected some bugs in the boundingBox and the getLength methods
//
// Revision 1.4  2002/07/15 19:42:59  skirsch
// changed the way of painting haloe with texture fonts
//
// Revision 1.3  2002/06/12 10:33:43  skirsch
// changed the way the haloe is painted when using polygon fonts
//
// Revision 1.2  2002/06/05 10:47:48  kirsch
// removed warnings (gcc)
//
// Revision 1.1  2002/06/04 08:43:39  skirsch
// removed ftgl
//
// Revision 1.7  2002/03/28 08:48:21  skirsch
// added the ability to align the text horizontal and vertical to the text shape (and fixed a bug in the boundingBox-method)
//
// Revision 1.6  2002/03/26 15:19:55  kersting
// removed "" in String Ctor
//
// Revision 1.5  2002/03/07 08:49:49  kosta
// replaced "class VRS::String" by "typedef std::string String"
//
// Revision 1.4  2002/03/04 12:00:20  kersting
// directory structure changes
//
// Revision 1.11  2002/03/03 21:44:25  kosta
// VRS_TYPEINFO-macro rewritten
//
// Revision 1.10  2002/02/19 10:34:13  kosta
// undone all changes since 2002-02-15
//
// Revision 1.7  2002/02/12 14:58:00  kosta
// copyright and logging header added
//

#ifndef VRS_TEXT_H_
#define VRS_TEXT_H_

#include <vrs/text/vrs_textprerequisites.h>
#include <vrs/shape.h>
#include <vrs/vector.h>
#include <vrs/color.h>
#include <vrs/text/deprecated/font.h>

#include <string>

namespace VRS {

class VRS_CORE_API Text : public Shape {

public:
    enum TextPlane { XY_PLANE, XZ_PLANE, YZ_PLANE };
    VRS_SERIALIZABLE_CLASS_ENUM(TextPlane);

    enum AlignmentH { LEFT, CENTER_H, RIGHT };
    enum AlignmentV { BOTTOM, CENTER_V, TOP };
    VRS_SERIALIZABLE_CLASS_ENUM(AlignmentH);
    VRS_SERIALIZABLE_CLASS_ENUM(AlignmentV);

    Text(
        Font* font,
        const std::string& text = std::string(),        
        const Vector& position = Vector(0,0,0),
        const Vector& scaling = Vector (1,1,1),
        TextPlane textplane = Text::XY_PLANE,
        AlignmentH alignmentH = Text::LEFT,
        AlignmentV alignmentV = Text::BOTTOM,
        double haloedSize = 0.0,
        const Color& haloedColor = Color::white,
        bool useModulateForTexturing = false
    );

#ifdef VRS_HAS_WSTRING
    Text(
        Font* font,
        const std::wstring& text,
        const Vector& position = Vector(0,0,0),
        const Vector& scaling = Vector (1,1,1),
        TextPlane textplane = Text::XY_PLANE,
        AlignmentH alignmentH = Text::LEFT,
        AlignmentV alignmentV = Text::BOTTOM,
        double haloeSize = 0.0,
        const Color& haloeColor = Color::white,
        bool useModulateForTexturing = false
    );
#endif // VRS_HAS_WSTRING

    Text(const Text& text);

    void setFont(Font* newFont);
    Font* getFont() const;  

#ifdef VRS_HAS_WSTRING
    void setUnicodeText(const std::wstring& newText);
    std::wstring getUnicodeText() const;
#else // VRS_HAS_WSTRING
    void setUnicodeText(const std::string& newText);
    std::string getUnicodeText() const;
#endif // VRS_HAS_WSTRING

    void setText(const std::string& newText);
    std::string getText() const;

    double getLength() const;

    double getHeight() const;

    Bounds getPixelBoundingBox() const;

    void setPosition(const Vector& newPosition);
    const Vector& getPosition() const;

    void setScaling(const Vector& newScaling);
    const Vector& getScaling() const;

    void setFixedSize(double inches);

    void disableFixedSize();

    double getHaloeSize() const;
    void setHaloeSize( double haloedSize);

    const Color& getHaloeColor() const;
    void setHaloeColor(const Color& color);
    

    TextPlane getTextPlane() const;
    void setTextPlane(TextPlane textplane);

    AlignmentH getAlignmentH() const;

    void setAlignmentH(AlignmentH newAlignment);

    AlignmentV getAlignmentV() const;

    void setAlignmentV(AlignmentV newAlignment);

    bool useModulateForTexturing() const;
    void setUseModulateForTexturing(bool useModulateForTexturing);
    virtual Bounds boundingBox() const;
    virtual void modified();

    VRS_TYPEINFO(Text, Shape);
    VRS_SERIALIZABLE(Text);

protected:
    Text();

private:
    SO<Font> font_;

#ifdef VRS_HAS_WSTRING
    std::wstring text_;
#else // VRS_HAS_WSTRING
    std::string text_;
#endif // VRS_HAS_WSTRING

    Vector position_;

    Vector scaling_;

    double inches_;
    bool fixedSize_;

    int horizontal_;
    int vertical_;

    double haloeSize_;
    Color haloeColor_;
    int textplane_;

    double length_;
    double leftBound_;
    double rightBound_;
    bool updateLength_;
    double height_;
    double lowerBound_;
    double upperBound_;
    bool updateHeight_;
    Bounds bbox_;
    bool updateBBox_;

    bool useModulateForTexturing_;

    friend class TextPainterGL;
};

} // namespace VRS

#endif // VRS_TEXT_H_

---

Generated on Sat May 25 06:00:19 2013 by Doxygen 1.5.6

© 2001-2010 Hasso-Plattner-Institut | Impressum | Contact