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

/home/tetron/hack/vos/libs/vos/metaobjects/a3dl/light.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 _LIGHT_HH_
#define _LIGHT_HH_


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

#ifndef A3DL_EXPORTS
IMPORT_METAOBJECT_FACTORIES(A3DL_Light)
#endif

    /** @class Light light.hh vos/metaobjects/a3dl/light.hh
     *  @ingroup libmetaobject_a3dl
     *  An omnidirectional point light.
     */
namespace A3DL
{
    class A3DL_API Light : public VOS::MetaObject
    {
    public:
        Light(VOS::VobjectBase* superobject);
        virtual ~Light();

        /** Set position of this light.
            @param x X translation, relative to origin of parent object
            @param y Y translation, relative to origin of parent object
            @param z Z translation, relative to origin of parent object
            @throws NoSuchObjectError if "position" subobject does not exist, or is not a property.
        */
        virtual void setPosition(double x, double y, double z);

        /** Get position of this light.
            @param x X translation, relative to origin of parent object
            @param y Y translation, relative to origin of parent object
            @param z Z translation, relative to origin of parent object
            @throws NoSuchObjectError if "position" subobject does not exist, or is not a property.
        */
        virtual void getPosition(double& x, double& y, double& z);

        /** Set light radius.  Light falls off as a function of of the
            proportional distance between the center and radius
            distance.  You could also think of this (along with the
            intensity or saturation of the light's color) it as a
            brightness factor.
            @param r
            @throws NoSuchObjectError if "position" subobject does not exist, or is not a property.
        */
        virtual void setRadius(double r);

        /** Get light radius.  See setRadius() to see what this value means.
            @return the light radius
        */
        virtual double getRadius();

        /** Set the light's color.  Components are specified between 0
            (black) and 1 (full saturation).
            @param r the red component
            @param g the green component
            @param b the blue component
        */
        virtual void setColor(float r, float g, float b);

        /** Get the light's color.  See setColor() for details.
            @param r the red component
            @param g the green component
            @param b the blue component
         */
        virtual void getColor(float& r, float& g, float& b);

        /** Set light's "static" property. Should only be set once, at creation.  */
        virtual void setStatic(bool is_static);

        /** Get light's "static" property. */
        virtual bool getStatic();

        virtual VUtil::vRef<VOS::Property> getPositionObj();
        virtual VUtil::vRef<VOS::Property> getRadiusObj();
        virtual VUtil::vRef<VOS::Property> getColorObj();

        /** Initialize subproperties:
         * position=(0,0,0), radius=1, color=(1,1,1).
         */
        virtual void doInitialize();

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

#endif