vos/3D/a3dl/viewpoint.hh

Go to the documentation of this file.

/*
    Copyright (C) 2001, 2002 Peter Amstutz
    Copyright (C) 2002 Reed Hedges

    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

*/

#ifndef _VIEWPOINT_HH_
#define _VIEWPOINT_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 Viewpoint : public virtual MetaObject
    {
    protected:
        PropertyAccessControl* propac;
    public:
        Viewpoint(MetaObject* superobject);
        virtual ~Viewpoint();

        void setPropertyAccessControl(PropertyAccessControl* pac);

        PropertyAccessControl* getPropertyAccessControl();

        /** Set position of this viewpoint.
            @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 viewpoint.
            @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);


        /** The orientation of this viewpoint in angle-axis
            representation.  See A3DL::Object3D::setOrientation() for
            details */
        virtual void setOrientation(double x, double y, double z, double r) throw(NoSuchObjectError);


        /** The orientation of this viewpoint in angle-axis
            representation.  See A3DL::Object3D::getOrientation() for
            details */
        virtual void getOrientation(double& x, double& y, double& z, double& r) throw(NoSuchObjectError);

        /** Set viewpoint field of view.
            @param angle    View angle in radians. PI > angle > 0
            @throws NoSuchObjectError if "viewpoint:fov" subobject does not exist, or is not a property.
        */
        virtual void setFOV(double angle) throw(NoSuchObjectError);

        /** Get viewpoint field of view.
            @return the viewpoint field of view
            @throws NoSuchObjectError if "viewpoint:fov" subobject does not exist, or is not a property.
        */
        virtual double getFOV() throw(NoSuchObjectError);

        /** Set the viewpoint's title.
            @param text Title in plain text.
        */
        virtual void setTitle(const string& text) throw(NoSuchObjectError);

        /** Get the viewpoint's title. */
        virtual string getTitle() throw(NoSuchObjectError);


        /** Initialize subproperties:
         * position=(0,0,0), orientaiont=(0,0,0), viewpoint:fov and viewpoint:title
         * are unset.
         * @param access    Access control object for subproperties. Default is
         * none.
         * @warning sets <i>No</i> access control by default!
         */
        virtual void initialize(PropertyAccessControl* access) throw(NoSuchObjectError);

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

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

#endif

---