dialog-draw.h

Go to the documentation of this file.

/*
 * dialog-draw.h
 *
 * Copyright (C) 2009  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_DIALOG_DRAW_H__
#define WAVE_GLUT_DIALOG_DRAW_H__

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


namespace dialog {

////////////////////////////////////////////////////////////////////////////////
///
/// \ingroup wave_glut
/// \defgroup dialog_draw Dialog Drawing Library
///
/// OpenGL-based drawer for the dialog library.
///
////////////////////////////////////////////////////////////////////////////////
/*@{*/


/// input data and state for the dialog drawer
struct ogl_dialog_draw_t {
        // constructor, manipulators
        ogl_dialog_draw_t(void) throw() { this->clear(); }
        void clear(void) throw() {
                        font = NULL;
                }
        bool isValid(void) const throw() {
                        return !!font;
                }

        // data fields
        smart_ptr<glut::Font>           font;
};


/// create an OpenGL-based dialog drawer (see dialog::Drawer)
smart_ptr<Drawer> createOpenGLDrawer(IN ogl_dialog_draw_t& odd);


};      // dialog namespace

#endif  // WAVE_GLUT_DIALOG_DRAW_H__