/*
 * This source file is part of KEOS (Free 3D Engine)
 * For the latest info, see http://www.keosengine.org/
 * E-mails : thierry.vouriot@keosengine.org, yeri@keosengine.org
 * 
 * This program 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 of the License, or (at your option) any later
 * version.
 *
 * This program 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 program; if not, write to the Free Software Foundation, Inc., 59 Temple
 * Place - Suite 330, Boston, MA 02111-1307, USA, or go to
 * http://www.gnu.org/copyleft/lesser.txt.
 *
 */
#ifndef KEOS_GRAPHICSTRING_H
#define KEOS_GRAPHICSTRING_H

#include "KeosPrerequisites.h"
#include "KeosColor.h"

namespace Keos
{
    //-----------------------------------------------------------------------
    /** Graphic string (which is display on the screen).
     *
     */
    class KEOS_EXPORT CGraphicString
    {
    public :

        /** Default constructor.
         *  @param StringPosition Text position.
         *  @param strText Text.
         *  @param StringColor Text color.
         *  @param strFont Font name.
         */
        CGraphicString( const TVector2I& StringPosition, const String& strText, 
                        const CColor& StringColor, const String& strFont);

        /** Display the string on the screen.
         */
        void Draw() const;

        /** Return the size of the text in pixels.
         *  @return Size in pixels.
         */
        TVector2I GetPixelSize() const;

        /** Change the alignement of the text.
         *  @param nMode Alignement options.
         *  @param Rect Rectangle used for alignement.
         */
        void Align(ulong nMode, const CRectangle& Rect);

        
        TVector2I   Position; //! Text position on the screen
        String      Text;     //! String
        CColor      Color;    //! Text color
        String      Font;     //! Font name
    };

} // namespace Keos


#endif // KEOS_GRAPHICSTRING_H
