[Home]	[About]
[Screenshots]	[Download]
[News]	[Community]
[Documentation]	[Manual]
[Bugs & Requests]	[Wiki]

/home/tetron/hack/vos/libs/vos/metaobjects/a3dl/portal.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) 2003 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 <http://www.interreality.org>
*/
#ifndef _PORTAL_HH_
#define _PORTAL_HH_

#ifndef A3DL_EXPORTS
IMPORT_METAOBJECT_FACTORIES(A3DL_Portal)
#endif

#include "a3dldefs.hh"
#include <vos/vos/vos.hh>
#include <vos/metaobjects/a3dl/texture.hh>
#include <vos/metaobjects/a3dl/sector.hh>


namespace A3DL
{
    /** @class Portal portal.hh vos/metaobjects/a3dl/portal.hh
     *  @ingroup libmetaobject_a3dl
     *  A portal connects different sectors by presenting a polygonal region in
     *  space which is rendered
     *  as a "hole" through which the destination sector can be seen and
     *  entered.  The dimensions of the visible portal and the
     *  corresponding shape through which the destination sector is rendered
     *  is represented by a "warping" transformation matrix.
     */
    class A3DL_API Portal : public VOS::MetaObject
    {
    public:
        Portal(VOS::VobjectBase* superobject);
        virtual ~Portal();

        static VOS::MetaObject* new_Portal(VOS::VobjectBase* superobject, const std::string& type);
        virtual const std::string getVOSType();

        virtual void setTargetSector(Sector* sector);
        virtual VUtil::vRef<Sector> getTargetSector();

        virtual void setWarpingTransform(float m11, float m12, float m13,
                                         float m21, float m22, float m23,
                                         float m31, float m32, float m33,
                                         float tx,  float ty,  float tz);

        virtual void getWarpingTransform(float& m11, float& m12, float& m13,
                                         float& m21, float& m22, float& m23,
                                         float& m31, float& m32, float& m33,
                                         float& tx,  float& ty,  float& tz);

        /** Get material vobject. */
        virtual VUtil::vRef<Material> getMaterial(bool createIfNone = true);

        /** Set material vobject. */
        virtual void setMaterialObj(Material* material);
    };
}

namespace VUtil {
    template<> inline void iteratorReleaseItem(A3DL::Portal** v)
    {
        (*v)->release();
    }
}

namespace A3DL {
    class PortalIterator : public VUtil::Iterator<Portal*>
    {
    public:
        PortalIterator() : VUtil::Iterator<Portal*>() { }
        PortalIterator(const PortalIterator& i) : VUtil::Iterator<Portal*>(i) { }
        PortalIterator(std::vector<Portal*>& vec) {
            items->resize(vec.size());
            int c = 0;
            for(std::vector<Portal*>::const_iterator i = vec.begin();
                i != vec.end();
                i++)
            {
                (*i)->acquire();
                (*items)[c] = (*i);
                c++;
            }
        }
        VUtil::vRef<Portal> operator*() {
            if(pos < items->size()) return VUtil::vRef<Portal>((*items)[pos], true);
            else return VUtil::vRef<Portal>();
        }
    };
}

#endif