glut-demo.h

Go to the documentation of this file.

/*
 * glut-demo.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_DEMO_H__
#define WAVE_GLUT_GLUT_DEMO_H__

// includes --------------------------------------------------------------------
#include "wave-glut/renderable.h"


namespace glut {


////////////////////////////////////////////////////////////////////////////////
///
/// \ingroup wave_glut
/// \defgroup glut_demo Demo application base class
///
/// Simple base class to support demos and test programs.
///
////////////////////////////////////////////////////////////////////////////////
/*@{*/


/// represents a single (small) status line to overlay in the demo
class DisplayLine {
public:
        // public enums --------------------------------------------------------
        enum ePosition {
                eTopLeft        = 1,
                eTopRight       = 2,
                eBottomLeft     = 3,
                eBottomRight    = 4,

                // keep this last!
                eInvalid        = 0
        };

        // virtual destructor --------------------------------------------------
        virtual ~DisplayLine(void) throw();

        // glut::DisplayLine class interface methods ---------------------------
        virtual ePosition getPosition(void) = 0;
        virtual const char * getText(void) = 0;
};

typedef std::vector<smart_ptr<DisplayLine> > vec_display_lines_t;



/// You'll need to provide a class that inherits from DemoHost.  Override any
///     glut::DemoHost interface method to receive the specified callback.
/// This base class will provide default implementation for all callbacks.
class DemoHost {
public:
        // public enum ---------------------------------------------------------
        enum eConstants {
                eDefaultWidth           = 800,
                eDefaultHeight          = 600,

                // keep this last
                eInvalid                = -1
        };

        // virtual destructor --------------------------------------------------
        virtual ~DemoHost(void) throw();

        // glut::DemoHost class interface methods ------------------------------
        virtual int getWidth(void) { return eDefaultWidth; }
        virtual int getHeight(void) { return eDefaultHeight; }
        virtual float getDelta(void) { return 0.25; }

        /// host can perform any pre-rendering work here
        virtual void onInit(void) { }

        /// want to display the tricolor xyz axes?
        virtual bool displayAxes(void) { return true; }

        /// want to draw queued (transparent) polygons?
        virtual bool displayQueuedPolys(void) { return true; }

        /// host can provide additional display lines
        virtual void getDisplayLines(OUT vec_display_lines_t& lines)
                                { lines.clear(); }

        /// host is notified just before shutdown
        virtual void onShutdown(void) { }

        /// host is notified that mouse has moved
        virtual void onCursor(IN int x, IN int y) { }

        /// host is notified that mouse button has been pressed/released
        virtual void onButton(IN int button, IN int state, IN int x, IN int y) { }

        /// host is notified that a key has been pressed
        virtual void onKey(IN int key, IN int mods) { }

        /// host is notified per frame, and is told the time delta in seconds
        virtual void onIdle(IN float dt) { }

        /// host is notified that GL is set up for 3D drawing (called per frame)
        virtual void display3D(IN const render_context_t& rc,
                                IN RenderQueue * rq) { } 

        /// host is notified that GL is set up for 2D drawing (called per frame)
        virtual void display2D(IN int width, IN int height) { }
};



/// use this method to kick off a quick demo (provide an instance of your own
///     host, inherited from glut::DemoHost ).
/// this routine does not return.  It is fine to leak
///     your DemoHost object, although better to wrap it with a smart_ptr<T>.
void startDemo(IN int argc,
                        IN const char * argv[],
                        IN const char * title,
                        IN DemoHost * host);



};      // glut namespace

#endif  // WAVE_GLUT_GLUT_DEMO_H__