VRS - The Virtual Rendering System

version 3.3

combinedtext.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 __COMBINEDTEXT_H__
#define __COMBINEDTEXT_H__

#include <vrs/container/dictionary.h>
#include <vrs/container/array.h>
#include <vrs/shape.h>

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

namespace VRS
{
namespace TEXT
{
    typedef Dictionary< int, SO<AbstractText> > TextLayerMap;
    typedef NonPersistentArray< SO<AbstractText> > TextArray;
    typedef Iterator< SO<AbstractText> > TextIter;

    class VRS_CORE_API CombinedText : public AbstractText
    {
        public: 
            CombinedText( unsigned int estimatedElements = 0  );
            virtual ~CombinedText();

//------- Helper methods

            static SO<CombinedText> createOutlinedText( const Color& normalcol, const Color& outlinecol, 
                const std::string& text, SO<FontDefinition> fdNormal, float outlineSize );
            static SO<CombinedText> createSoftOutlinedText( const Color& normalcol, const Color& outlinecol, 
                const std::string& text, SO<FontDefinition> fdNormal, float outlineSize, float softSize );
            static SO<CombinedText> createShadowedText( const Color& normalcol, const Color& shadowcol, 
                const std::string& text, SO<FontDefinition> fdNormal, const Vector& shadowOffset );
#ifdef VRS_HAS_WSTRING     // Has Unicode support

            static SO<CombinedText> createOutlinedText( const Color& normalcol, const Color& outlinecol, 
                const std::wstring& text, SO<FontDefinition> fdNormal, float outlineSize );
            static SO<CombinedText> createSoftOutlinedText( const Color& normalcol, const Color& outlinecol, 
                const std::wstring& text, SO<FontDefinition> fdNormal, float outlineSize, float softSize );
            static SO<CombinedText> createShadowedText( const Color& normalcol, const Color& shadowcol, 
                const std::wstring& text, SO<FontDefinition> fdNormal, const Vector& shadowOffset );
#endif

            enum TextHint {
                EMPTY, 
                SPECIAL,
                SHADOWED,
                OUTLINED_SOFT,
                OUTLINED_HARD
            };
            VRS_SERIALIZABLE_CLASS_ENUM(TextHint);

            virtual TextHint getTextHint() const;


//------- Adding new Texts

            virtual void addText( SO<AbstractText> at, int layer );
            virtual void removeText( SO<AbstractText> at);


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

#ifdef VRS_HAS_WSTRING     // Has Unicode support

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

                        virtual const std::string& getText() 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 );


//------- Shape rendering

            virtual Bounds boundingBox() const;
            virtual Bounds getLocalBounds() const;

            const SO<TextIter> _getTexts() const;

            VRS_TYPEINFO(CombinedText, Shape);
            VRS_SERIALIZABLE(CombinedText);
        private:
            SO<AbstractText> getFirstText() const;

            TextHint m_TextHint;
            SO<TextLayerMap> m_LayerMap;
            mutable SO<TextArray> m_TextArray;
    };
}
}

#endif

---

Generated on Wed May 23 06:00:12 2012 by Doxygen 1.5.6

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