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

/home/tetron/hack/vos/libs/vos/metaobjects/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_

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

#ifndef A3DL_EXPORTS
IMPORT_METAOBJECT_FACTORIES(A3DL_Viewpoint)
#endif


namespace A3DL
{
    /** @class Viewpoint viewpoint.hh vos/metaobjects/a3dl/viewpoint.hh
     *  @ingroup libmetaobject_a3dl
     *  A viewpoint is some position and orientation in space that a user
     *  may wish to assume.  The recommended "starting positoin" in a sector
     *  is represented by a viewpoint object named "default-viewpoint".
     *  Additionaly, viewpoints may suggest an angular "field of view" for
     *  rendering the world.
     */
    class A3DL_API Viewpoint : public VOS::MetaObject
    {
    public:
        Viewpoint(VOS::VobjectBase* superobject);
        virtual ~Viewpoint();

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

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


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


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

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

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

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

        /** Get the viewpoint's title. */
        virtual std::string getTitle();


        /** Initialize subproperties:
         * position=(0,0,0), orientaiont=(0,0,0), viewpoint:fov and viewpoint:title
         * are unset.
         * @warning sets <i>No</i> access control by default!
         */
        virtual void initialize();

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

#endif