properties.h

Go to the documentation of this file.

/*
 *  OGF/Graphite: Geometry and Graphics Programming Library + Utilities
 *  Copyright (C) 2000 Bruno Levy
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this program; if not, write to the Free Software
 *  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 *  If you modify this software, you should include a notice giving the
 *  name of the person performing the modification, the date of modification,
 *  and the reason for such modification.
 *
 *  Contact: Bruno Levy
 *
 *     levy@loria.fr
 *
 *     ISA Project
 *     LORIA, INRIA Lorraine, 
 *     Campus Scientifique, BP 239
 *     54506 VANDOEUVRE LES NANCY CEDEX 
 *     FRANCE
 *
 *  Note that the GNU General Public License does not permit incorporating
 *  the Software into proprietary programs. 
 */
 
 
#ifndef H_OGF_SCENE_GRAPH_TYPES_SHADER_PROPERTIES_H
#define H_OGF_SCENE_GRAPH_TYPES_SHADER_PROPERTIES_H
 
#include <OGF/scene_graph/common/common.h>
#include <OGF/gom/types/arg_list.h>
#include <geogram/image/color.h>
 
#include <iostream>
#include <string>
 
namespace GEO {
    class Image;
}
 
namespace OGF {
 
    //________________________________________________________
 
    struct PointStyle {
        PointStyle() :
            visible(false),
            color(0.0,0.0,0.0,1.0),
            size(4) {
        }
        bool visible;
 
        Color color;
 
        index_t size;
    };
 
    SCENE_GRAPH_API std::ostream& operator<<(
        std::ostream& out, const PointStyle& ps
    );
 
    SCENE_GRAPH_API std::istream& operator>>(
        std::istream& in, PointStyle& ps
    );
 
    //________________________________________________________
 
    struct EdgeStyle {
        EdgeStyle() :
            visible(false),
            color(0.0,0.0,0.0,1.0),
            width(1) {
        }
        
        bool visible;
        
        Color color;
        
        index_t width;
    };
 
    SCENE_GRAPH_API std::ostream& operator<<(
        std::ostream& out, const EdgeStyle& es
    );
 
    SCENE_GRAPH_API std::istream& operator>>(
        std::istream& in, EdgeStyle& es
    );
 
    //________________________________________________________
 
    struct SurfaceStyle {
        SurfaceStyle() :
            visible(false),
            color(0.0,0.0,0.0,1.0) {
        }
        bool visible;
        
        Color color;
    };
 
    SCENE_GRAPH_API std::ostream& operator<<(
        std::ostream& out, const SurfaceStyle& ss
    );
 
    SCENE_GRAPH_API std::istream& operator>>(
        std::istream& in, SurfaceStyle& ss
    );
    
    /***********************************************************************/
 
    template <class T, bool create=false> class Name : public NameBase {
    public:
        typedef Name<T> thisclass;
 
        Name() {
        }
 
        Name(const thisclass& rhs) : val_(rhs.val_) {
        }
 
        Name(const std::string& rhs) : val_(rhs) {
        }
 
        Name(const char* rhs) : val_(rhs) {
        }
 
        thisclass& operator=(const thisclass& rhs) {
            val_ = rhs.val_;
            return *this;
        }
 
        thisclass& operator=(const std::string& rhs) {
            val_ = rhs;
            return *this;
        }
 
        thisclass& operator=(const char* rhs) {
            val_ = std::string(rhs);
            return *this;
        }
 
        operator const std::string&() const {
            return val_;
        }
 
        operator std::string&() {
            return val_;
        }
 
        bool operator==(const std::string& rhs) const {
            return val_ == rhs;
        }
 
        bool operator!=(const std::string& rhs) const {
            return val_ != rhs;
        }
 
    private:
        std::string val_;
    };
 
    //________________________________________________________
    
    template <class T, bool B> inline std::ostream& operator<< (
        std::ostream& out, const Name<T,B>& name
    ) {
        return (out << (const std::string&)(name)) ;
    }
 
    template <class T, bool B> std::istream& operator>> (
        std::istream& in, Name<T,B>& name
    ) {
        // Note: we use "std::getline(in, name)" instead of "in >> name" since
        // "in >> name" would truncate the string if it contains whitespace
        // (and under Windows, "My documents" directory contains a
        // whitespace !)
         
        std::getline(in, (std::string&)name) ;
        return in ;
    }
    
    //________________________________________________________
 
    template <class T> class File {
    public:
    };
 
    typedef Name<File<Memory::byte> > FileName;
 
    typedef Name<File<Memory::byte>,true> NewFileName;
    
    //________________________________________________________
 
    typedef Name<File<Image*> > ImageFileName;
 
    typedef Name<File<Image*>,true> NewImageFileName;
    
    //________________________________________________________
 
    class Grob;
 
    typedef Name<Grob*> GrobName;
 
    typedef Name<Grob*,true> NewGrobName;
 
    //________________________________________________________
 
    typedef Name<File<Grob*> > GrobFileName;
 
    typedef Name<File<Grob*>,true> NewGrobFileName;    
    
    //________________________________________________________
 
    class GrobClass;
 
    typedef Name<GrobClass*> GrobClassName;
 
    //_______________________________________________________
 
    class Colormap;
 
    typedef Name<Colormap*> ColormapName;
    
    //________________________________________________________
 
    struct ColormapStyle {
 
        ColormapStyle() :
           colormap_name("rainbow"),
           smooth(true),
           repeat(0),
           show(false),
           flip(false) {
        }
        
        ColormapName colormap_name;
        
        bool smooth;
        
        index_t repeat;
 
        bool show;
 
        bool flip;
    };
 
 
    SCENE_GRAPH_API std::ostream& operator<<(
        std::ostream& out, const ColormapStyle& cms
    );
 
    SCENE_GRAPH_API std::istream& operator>>(
        std::istream& in, ColormapStyle& cms
    );
    
    //________________________________________________________
 
    class FullScreenEffect;
 
    typedef Name<FullScreenEffect*> FullScreenEffectName;
    
}
 
#endif