Cinder

  • Main Page
  • Related Pages
  • Namespaces
  • Classes
  • Files
  • File List
  • File Members

include/cinder/Text.h

Go to the documentation of this file.
00001 /*
00002  Copyright (c) 2010, The Barbarian Group
00003  All rights reserved.
00004 
00005  Redistribution and use in source and binary forms, with or without modification, are permitted provided that
00006  the following conditions are met:
00007 
00008     * Redistributions of source code must retain the above copyright notice, this list of conditions and
00009     the following disclaimer.
00010     * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and
00011     the following disclaimer in the documentation and/or other materials provided with the distribution.
00012 
00013  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
00014  WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
00015  PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
00016  ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
00017  TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00018  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
00019  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00020  POSSIBILITY OF SUCH DAMAGE.
00021 */
00022 
00023 #pragma once
00024 
00025 #include "cinder/Cinder.h"
00026 
00027 #include "cinder/Surface.h"
00028 #include "cinder/Font.h"
00029 
00030 #include <vector>
00031 #include <deque>
00032 #include <string>
00033 
00034 namespace cinder {
00035 
00036 class TextLayout {
00037  public:
00043     TextLayout();
00044 
00046     void    clear( const Color &color );
00048     void    clear( const ColorA &color );   
00049     
00051     void    addLine( const std::string &line );
00053     void    addCenteredLine( const std::string &line );
00055     void    addRightLine( const std::string &line );
00057     void    append( const std::string &str );
00058 
00059     void    setFont( const Font &font );
00061     void    setColor( const Color &color );
00063     void    setColor( const ColorA &color );
00065     void    setLeadingOffset( float leadingOffset );
00066 
00068     void    setBorder( int horizontal, int vertical );
00069 
00071     Surface     render( bool useAlpha = false, bool premultiplied = false );
00072     
00073  private:
00074     ColorA  mBackgroundColor;
00075     Font    mCurrentFont;
00076     ColorA  mCurrentColor;
00077     float   mCurrentLeadingOffset;
00078     int     mHorizontalBorder, mVerticalBorder;
00079   
00080     std::deque<shared_ptr<class Line> >     mLines;
00081 };
00082 
00087 Surface renderString( const std::string &str, const Font &font, const ColorA &color, float *baselineOffset = 0 );
00088 
00089 } // namespace cinder