material.h

Go to the documentation of this file.

/*
 * material.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.
 *
 *
 * Interfaces to deal with materials generally.
 */

#ifndef WAVE_GLUT_GLUT_MATERIAL_H__
#define WAVE_GLUT_GLUT_MATERIAL_H__

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


namespace glut {

/// \ingroup glut
/*@{*/


/// A Material is anything that needs to be set up prior to drawing, and 
///  possibly requiring some cleanup afterwards.  This includes setup such
///  as texture binding etc.  This is a non functional base class for others
///  to inherit from.
class Material {
public:
        // virtual destructor --------------------------------------------------
        virtual ~Material(void) throw();

        // glut::Material class interface methods ------------------------------

        /// does this material include a texture?
        virtual bool hasTexture(void) const throw();

        /// this is called right before polygons needing the material are drawn
        virtual void prepare(void);

        /// this is called after polygons have been drawn.  Not all material
        ///  objects need cleanup, but this hook is here for those that do.
        ///  Note that any cleanup is not allowed to throw.
        virtual void cleanup(void) throw();
};



/// helper class: put one of these on the stack, and it will make sure that
///  prepare() and cleanup() are called.
class MaterialContext {
public:
        // constructor, destructor ---------------------------------------------
        MaterialContext(IN smart_ptr<Material>& material) {
                        ASSERT(material, "null");
                        m_material = material;
                        m_material->prepare();
                }

        ~MaterialContext(void) throw() {
                        if (m_material) {
                                m_material->cleanup();
                        }
                }

protected:
        // protected data members ----------------------------------------------
        smart_ptr<Material>             m_material;
};



};      // glut namespace

#endif  // WAVE_GLUT_GLUT_MATERIAL_H__