VRS - The Virtual Rendering System

version 3.3

basetext.h

Go to the documentation of this file.

 /**********************************************************************
 VRS - The Virtual Rendering System
 Copyright (C) 2001 Computer Graphics Systems Group at the 
 Hasso-Plattner-Institute, 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.
 **********************************************************************/


#ifndef __BASETEXT_H__
#define __BASETEXT_H__

#include <string>

#include <vrs/text/vrs_textprerequisites.h>
#include <vrs/text/fontdefinition.h>
#include <vrs/text/abstracttext.h>

namespace VRS
{
namespace TEXT
{
    typedef std::vector< std::pair< float, float > > GlyphPositions;

    class VRS_CORE_API BaseText : public AbstractText
    {
        public:    
#ifdef VRS_HAS_WSTRING     // Has Unicode support               
            BaseText( SO<FontDefinition> fd, const std::wstring& text);
#endif 
            BaseText( SO<FontDefinition> fd, const std::string& text);
            
            // Kind of Copy constructor
            BaseText( SO<FontDefinition> fd, BaseText* bt );
            // D-tor
            virtual ~BaseText();

//------- The text-contents

#ifdef VRS_HAS_WSTRING     // Has Unicode support

                        virtual const std::wstring& getText() const;
                        virtual void setText(const std::wstring& str);
            virtual const std::wstring& getCachedText() const;
#else                      // Has no Unicode support

                        virtual const std::string& getText() const;
            virtual const std::string& getCachedText() const;
#endif
                        virtual void setText(const std::string& str);



//------- FontDefinition

                        virtual SO<FontDefinition> getFontDefinition( ) const;
                        virtual void setFontDefinition( SO<FontDefinition> );

//------- Alignment and AbstractText::Direction

                        virtual AbstractText::HorizontalAlignment getHorizontalAlignment() const;
            virtual void setHorizontalAlignment(AbstractText::HorizontalAlignment tva);
                        virtual AbstractText::VerticalAlignment getVerticalAlignment() const;
                        virtual void setVerticalAlignment(AbstractText::VerticalAlignment tva);
            virtual AbstractText::HorizontalDirection getHorizontalDirection() const;
                virtual void setHorizontalDirection(AbstractText::HorizontalDirection thd);
            virtual AbstractText::VerticalDirection getVerticalDirection() const;
                virtual void setVerticalDirection(AbstractText::VerticalDirection thd);
            virtual AbstractText::Direction getDirection() const;
                virtual void setDirection(AbstractText::Direction td);

                        virtual void setAlignmentBounds( float rightBorder, float bottomBorder );
                        virtual void setRightAlignmentBound(float rightBorder);
                        virtual void setBottomAlignmentBound(float bottomBorder);
            virtual float getRightAlignmentBound() const;
            virtual float getBottomAlignmentBound() const;


//------- Line Spacing

                        virtual float getLineSpacing() const;
                        virtual void setLineSpacing(float LineSpacing);


//------- Text Color

                        virtual void setColor( const Color& color, bool use = true );
                        virtual Color getColor() const;
            virtual bool useColor() const;

//------- Text Offset, Scaling and Axis

                        virtual Matrix getMatrix() const;
                        virtual void setMatrix( const Matrix& m );
            virtual void setMatrix( AbstractText::TextPlane tp, 
                                const Vector& offset=Vector(0,0,0), const Vector& scale=Vector(1,1,1) )
                        {
                                setMatrix( AbstractText::buildMatrix(tp,offset,scale) );
                        };
           

            virtual Bounds boundingBox() const;
            virtual Bounds getLocalBounds() const;
            
            const GlyphPositions getCachedGlyphPositions() const;
            
            bool isDirty() const;

            virtual void rebuildAllCaches();
            virtual void rebuildTextCache();
            virtual void rebuildGlyphCache();

                        VRS_TYPEINFO(BaseText, Shape);
            VRS_SERIALIZABLE(BaseText);
                protected:
            BaseText(  );
                        virtual void computeLineLengthAndWidth( std::vector<float> *lineWidths, 
                                float *totalWidth, float* totalHeight ) const;

                        SO<FontDefinition> m_FontDefinition;

#ifdef VRS_HAS_WSTRING     // Has Unicode support

            std::wstring m_Text;
            std::wstring m_CachedText;
#else                      // Has no Unicode support

            std::string m_Text;
            std::string m_CachedText;
#endif
            float m_LineSpacing;
            float m_RightBorder;
            float m_BottomBorder;

            Color m_Color;
            bool m_UseColor;

            AbstractText::HorizontalAlignment m_HorizontalAlignment;
            AbstractText::VerticalAlignment m_VerticalAlignment;
            AbstractText::HorizontalDirection m_HorizontalDirection;
            AbstractText::VerticalDirection m_VerticalDirection;
            AbstractText::Direction m_Direction;

            Matrix m_Matrix;

            Bounds m_CachedBounds;
            GlyphPositions m_CachedGlyphPositions;

            bool m_IsDirty;
        private:
            void initializeDefaults();

    };
}
}

#endif

---

Generated on Fri May 18 06:00:13 2012 by Doxygen 1.5.6

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