vos/3D/a3dl/material.hh

Go to the documentation of this file.

/*
    This file is part of the Virtual Object System of
    the Interreality project (http://interreality.org).

    Copyright (C) 2001, 2002 Peter Amstutz

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library 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
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307  USA

    Peter Amstutz <tetron@interreality.org>
*/
#ifndef _MATERIAL_HH_
#define _MATERIAL_HH_

#if defined(_WIN32) && defined(_MSC_VER)
# ifdef A3DL_EXPORTS
#  define A3DL_API __declspec(dllexport)
# else
#  define A3DL_API __declspec(dllimport)
# endif
#else
# define A3DL_API
#endif

#include <vos/corelibs/vos/vos.hh>
#include <vos/metaobjects/property/property.hh>
#include "texture.hh"

namespace A3DL
{
    /** Contains material (appearence) information for a 3D object.
     *  @todo Need to add functions for setting shading (CS mixmode |= 
     *  CS_FX_GORAUD), keycolor (CS mixmode |= CS_FX_KEYCOLOR), tiling (CS 
     *  mixmode |= CS_FX_TILING)
     */
    class A3DL_API Material : public virtual MetaObject
    {
    protected:
        PropertyAccessControl* accesscontrol;
    public:
        Material(MetaObject* superobject);
        virtual ~Material();

        static MetaObject* new_Material(MetaObject* superobject, const string& type);
        static void registerExtenders();
        virtual const string getType();

        void setPropertyAccessControl(PropertyAccessControl* pac) { accesscontrol = pac; }
        PropertyAccessControl* getPropertyAccessControl(){ return accesscontrol; }

        /** Insert a new texture layer into this material at the given index,
         *  using the given file as the image backend source (using FileProperty)
         *  @see FileProperty
         *  @throw FileAccessError if there is an error opening the file
         */
        virtual Texture* insertTextureLayerFromFile(int idx, const string& filename, const string& datatype);

        /** Add and remove texture layers. */
        //@{
        virtual vector<Texture*> getTextureLayers();
        virtual Texture* getTextureLayer(int idx);  ///< Use a vRef or call release on the returned object. @return 0 if idx is greater than the number of texture layers.
        virtual void insertTextureLayer(int idx, Texture& t);
        virtual void insertTextureLayer(int idx, Texture* t) {
            assert(t);
            insertTextureLayer(idx, *t);
        }
        virtual void replaceTextureLayer(int idx, Texture& t);
        virtual void replaceTextureLayer(int idx, Texture* t) {
            assert(t);
            replaceTextureLayer(idx, *t);
        }
        virtual void removeTextureLayer(int idx);
        //@}

        /** The "base" color of the material: a color to use if there are no
         * texture layers. 
         */
        //@{
        virtual void setColor(float r, float g, float b);
        virtual void getColor(float& r, float& g, float& b);
        //@}

        /** Convert an HTML-style hex triplet ("#RRGGBB") to three normalized
         * (0.0-1.0) floating-point values. 
         * @todo Move this out into just the A3DL namespace?
         * */
        static void hexStringToFloats(const string& str, float& r, float& g, float& b);

        /** Convert three normalized floats (0.0-1.0) to an HTML-style hex
         *  tripplet ("#RRGGBB). If any input parameter is less than 0.0,
         *  it is considered to be 0. If any parameter is greater than 1.0,
         *  it is considered to be 1. 
         * @todo Move this out into just the A3DL namespace?
         */
        static void floatsToHexString(float r, float g, float b, string& str);

        /** Set transparency of the object.
            @param t    A value between 0 (no transparency) and 1 (fully
                        transparent). Some renderers may round to certain
                        values (e.g. 1.0, 0.75, 0.5, 0.25, 0.0)
                        If t is > 1, 1 will be used. If t < 0, 0 will be
                        used.
        */
        virtual void setTransparency(double t, PropertyAccessControl* ac =
            &NoPropertyAccessControl::static_);

        /** Get transparency. Will be between 0 (no transparency) and
            1 (fully transparent).
            @throws Vobject:NoSuchObjectError if there is no "a3dl:transparency" object.
         */
        virtual double getTransparency();

        /** Get transparency property. */
        virtual Property* getTransparencyObj();

        /** Set transparency property object */
        virtual void setTransparencyObj(Property* obj);

        /** Set special blend mode. Must be one of the following:
         *      MeshBase::BLEND_ADD
         *      MeshBase::BLEND_MULTIPLY
         *      MeshBase::BLEND_DOUBLE_MULTIPLY
         *      MeshBase::BLEND_NORMAL
         *  These blend modes determine how the background
         *  affects the object's material.
         */
        virtual void setBlendMode(short mode);

        /** Get special blend mode. Will be one of the following:
         *      MeshBase::BLEND_ADD
         *      MeshBase::BLEND_MULTIPLY
         *      MeshBase::BLEND_DOUBLE_MULTIPLY
         *      MeshBase::BLEND_NORMAL
         *  These blend modes determine how the background affects the
         *  object's material.
         *  @throws Vobject::NoSuchObjectError if there is no "a3dl:blend-mode"
         *  property.
         */
        virtual short getBlendMode();

        /** Get blend mode property object. */
        virtual Property* getBlendModeObj();

        /** Set blend mode property object. */
        virtual void setBlendModeObj(Property* obj);

        /** Special blend modes for setBlendMode() and getBlendMode() */
        //@{
        enum BlendModes {BLEND_ADD, BLEND_MULTIPLY, BLEND_DOUBLE_MULTIPLY, BLEND_NORMAL};
        //@}


        /** Set blend color: this color modifies the blending of this object
         * against its background.
         */
        virtual void setBlendColor(double r, double g, double b);

        /** Get blend color
         * @throws Vobject::NoSuchObjectError if there is no "a3dl:blend-mode"
         * property.
         */
        virtual void getBlendColor(double& r, double& g, double& b);

        virtual void setBlendColorObj(Property* obj);
        virtual Property* getBlendColorObj();
    };
}

#endif

---