vos/3D/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 <tetron@interreality.org>
*/
#ifndef _LIGHT_HH_
#define _LIGHT_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 
{
    class A3DL_API Light : public virtual MetaObject
    {
    protected:
        PropertyAccessControl* accesscontrol;
    public:
        Light(MetaObject* superobject);
        virtual ~Light();

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

        /** 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) throw(NoSuchObjectError);

        /** 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) throw(NoSuchObjectError);

        /** 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) throw(NoSuchObjectError);

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

        /** 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(double r, double g, double b) throw(NoSuchObjectError);
        /** 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(double& r, double& g, double& b) throw(NoSuchObjectError);

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

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

        /** Initialize subproperties: 
         * position=(0,0,0), radius=1, color=(1,1,1).
         * @param is_static If true, this will be a static light, and the
         * properties cannot be changed. (Allows optimizations by rendering
         * agent). Default is false.
         * @param access    Access control object for subproperties. Default is
         * none.
         * @warning sets <i>No</i> access control by default!
         */
        virtual void initialize(bool is_static, PropertyAccessControl* access =
NULL);

        virtual void initialize() {
            initialize(false, NULL);
        }

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

#endif

---