opengl-effects.h

Go to the documentation of this file.

/*
 * opengl-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.
 *
 * Random OpenGL effects.
 */

#ifndef WAVE_GLUT_OPENGL_EFFECTS_H__
#define WAVE_GLUT_OPENGL_EFFECTS_H__

// includes --------------------------------------------------------------------
#include "density-map.h"
#include "light-path.h"

namespace glut {


////////////////////////////////////////////////////////////////////////////////
///
/// \ingroup glut
/// \defgroup opengl_effects OpenGL Effects Library
///
/// Several useful OpenGL effects.
///
////////////////////////////////////////////////////////////////////////////////
/*@{*/


/// data needed for cool spheres
struct sphere_init_t {
        // public enums
        enum eConstants {
                eMaxRings               = 8
        };

        // constructor, manipulators
        sphere_init_t(void) throw() { this->clear(); }
        void clear(void) throw() {
                        radius = -1;
                        nRings = -1;
                        color.clear();
                }
        bool isValid(void) const throw() {
                        return (radius > 0 && nRings > 0 &&
                                nRings <= eMaxRings);
                }

        // data fields
        float           radius;         ///< radius of sphere (meters)
        int             nRings;         ///< number of electricity rings
        img_color_t     color;          ///< color of sphere
};



/// create a really cool-looking sphere.  Yeah.
smart_ptr<Renderable> createCoolSphere(IN const sphere_init_t& si);



};      // glut namespace


#endif  //WAVE_GLUT_OPENGL_EFFECTS_H__