vos/3D/a3dl/texture.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 _TEXTURE_HH_
#define _TEXTURE_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>

namespace A3DL
{
    /** Represents a texture layer in a 3D object's Material.
     *  @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 Texture : public virtual MetaObject
    {
    protected:
        PropertyAccessControl* accesscontrol;
    public:
        Texture(MetaObject* superobject);
        virtual ~Texture();

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

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

        virtual Property* getImage();
        virtual void setImage(Property* p);

        /** Set a file backend for the image for this texture (using
         * FileProperty).
         * @see FileProperty
         * @throw FileAccessError if there is an error opening the file
         */
        virtual void setImageToFile(const string& filename, const string& datatype);
        virtual void setImageData(const string& data, const string& datatype);

        /** 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* p);

        /** Set general transparency of the texture.
            @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 whether this layer should have shading. */
        virtual void setShaded(bool s, PropertyAccessControl* ac = &NoPropertyAccessControl::static_);

        /** Get whether this layer should have shading or not.
            @throws Vobject:NoSuchObjectError if there is no "a3dl:shaded" object.
         */
        virtual bool getShaded();

        /** Get shaded property object 
         *  @throws Vobject::NoSuchObjectError if there is no "a3dl:shaded" object
         */
        virtual Property* getShadedObj();

        /** Set shaded property object */
        virtual void setShadedObj(Property* obj);

        /** Set a color in the texture to be rendered transparent */
        virtual void setTransparentKeycolor(float r, float g, float b);

        /** Get the color in the texture that is rendered as transparent 
         *  If there is no property, sets (r, g, b) to (0, 0, 0)
         *  @todo Throw NoSuchObjectError if there is no object-- need to 
         *     disable keycolor if the texture image has an alpha channel.
         */
        virtual void getTransparentKeycolor(float& r, float& g, float& b);

        virtual void setUVScaleAndShift(float uscale, float vscale, float ushift, float vshift);
        virtual void getUVScaleAndShift(float& uscale, float& vscale, float& ushift, float& vshift);
    };
}

#endif

---