glut-font-effects.h

Go to the documentation of this file.

/*
 * glut-font-effects.h
 *
 * Copyright (C) 2010  Thomas A. Vaughan
 * All rights reserved.
 *
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the <organization> nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THOMAS A. VAUGHAN BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

#ifndef WAVE_GLUT_GLUT_FONT_EFFECTS_H__
#define WAVE_GLUT_GLUT_FONT_EFFECTS_H__

// includes --------------------------------------------------------------------
#include "glut-font.h"

#include "color/color.h"


namespace glut {

////////////////////////////////////////////////////////////////////////////////
///
/// \ingroup glut_font
/// \defgroup glut_font_effects Glut Font Effects
///
/// Font effects based on the \ref glut_font library.
///
////////////////////////////////////////////////////////////////////////////////

/*@{*/


////////////////////////////////////////////////////////////////////////////////
//
//      public API
//
////////////////////////////////////////////////////////////////////////////////

/// general base class for font effect objects.  Usually these exist to provide
/// effects for a given set (multiple lines) of text.
class FontEffect {
public:
        // virtual destructor --------------------------------------------------
        virtual ~FontEffect(void) throw();

        // glut::FontEffect class interface methods ----------------------------

        /// tick the effect.  Caller provides time in seconds since the previous
        ///     call.  Implementors should ignore zero or negative time deltas
        ///     (these can happen if system clocks reset etc.).  Usually this is
        ///     called per frame of animation, with deltaSeconds on the order
        ///     of a few milliseconds.
        virtual void tick(IN float deltaSeconds) = 0;

        /// draw.  Usually called each frame.
        virtual void render(void) = 0;

        /// reset (restart) the effect
        virtual void reset(void) = 0;

        /// advance the effect.  Effects usually advance on their own.  Clients
        ///     can call this method if they need to move the effect on faster
        ///     (for instance, user is pushing the "next" button).  Often this
        ///     will fast-forward to the next line, for instance.  In some
        ///     cases this is equivalent to calling complete() below.
        virtual void advance(void) = 0;

        /// complete the effect.  Client can use this to fast-forward the effect
        ///     to get to the end.  Again, this is often used so that users can
        ///     skip any animations so they can move ahead quicker.
        virtual void complete(void) = 0;
};


/// this font effect will write out lines of text one character at a time.
///     The lines parameter can contain multiple lines of text, separated by
///     newline characters.  
smart_ptr<FontEffect> getCharacterAdvanceEffect(IN smart_ptr<Font>& font,
                        IN const char * lines,
                        IN int millisecondsPerCharacter,
                        IN const glut_color_t& color);


/// given a long sequence of words in a given font, this routine returns the
///     same words, only with line breaks inserted so that a single line is
///     never longer than the specified width.  Note that really long words
///     won't be broken up (you'll have a single line with a word that is
///     too long).
void breakLongString(IN const char * text,
                        IN Font * font,
                        IN int maxPixelWidth,
                        OUT std::string& output);


};      // glut namespace


#endif  // WAVE_GLUT_GLUT_FONT_EFFECTS_H__