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

/home/tetron/hack/vos/libs/vos/metaobjects/a3dl/sector.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 <http://www.interreality.org>
*/

#ifndef _SECTOR_HH_
#define _SECTOR_HH_

#include "a3dldefs.hh"
#include <vos/vos/vos.hh>

#ifndef A3DL_EXPORTS
IMPORT_METAOBJECT_FACTORIES(A3DL_Sector)
#endif


namespace A3DL
{
    /** @class Sector sector.hh vos/metaobjects/a3dl/sector.hh
     *  @ingroup libmetaobject_a3dl
     *  A sector is a grouping of 3D objects that can be considered a seperate,
     *  mostly self-contained entity from other sectors. Sectors may be linked
     *  through Portal objects, though.  Child objects are considered to be "in"
     *  this sector. (Sectors have not fixed bounds)
     */
    class A3DL_API Sector : public VOS::MetaObject
    {
    public:
        Sector(VOS::VobjectBase* superobject);
        ~Sector();

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

        /// A general "fog" or "haze" that fills the whole sector obscuring distant objects.
        //@{
        void setFogColor(float r, float g, float b);
        void getFogColor(float& r, float& g, float& b) ;
        void setFogDensity(double d) ;
        double getFogDensity() ;
        VUtil::vRef<VOS::Property> getFogColorObj() ;
        VUtil::vRef<VOS::Property> getFogDensityObj() ;
        //@}

        /// Gravity acceleration
        //@{
        virtual void setGravity(double unitsPerSecond);
        virtual double getGravity();
        virtual VUtil::vRef<VOS::Property> getGravityObj() ;
        //@}

        /// Whether clients ought to perform collision detection for objects within this sector.
        //@{
        virtual void setCollisionDetection(bool enabled);
        virtual bool getCollisionDetection();
        virtual VUtil::vRef<VOS::Property> getCollisionDetectionObj() ;
        //@}

        /// A general ambient light to apply to all objects in the sector.
        //@{
        void setAmbientLightColor(float r, float g, float b);
        void getAmbientLightColor(float& r, float& g, float& b);
        VUtil::vRef<VOS::Property> getAmbientLightColorObj() ;
        //@}

        /// A message for clients to display upon initially joining the sector.
        //@{
        void setWelcomeMessage(const std::string& msg, const std::string& type = "text/plain");
        std::string getWelcomeMessage();
        std::string getWelcomeMessageDataType();
        VUtil::vRef<VOS::Property> getWelcomeMessageObj();
        //@}
    };
}

#endif