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

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

#ifndef A3DL_EXPORTS
IMPORT_METAOBJECT_FACTORIES(A3DL_Model)
#endif

#include "a3dldefs.hh"
#include <vos/metaobjects/a3dl/object3d.hh>


namespace A3DL
{
    /** @class Model model.hh vos/metabojects/a3dl/model.hh
     *  @ingroup libmetaobject_a3dl
     * This object's geometry is defined by model data in a
     * format such as 3DS, VRML, POV, etc. contained in a subproperty named
     * "model".
     * @note: if you use Object3D::initialize() on a Model object, make sure
     * that you also call setModel() or setModelToFile() to complete the object.
     */
    class A3DL_API Model : public virtual Object3D
    {
    public:
        Model(VOS::VobjectBase* superobject);
        virtual ~Model();

        /** Set the value of "model" property  to m.
         * @param m Model data
         * @param datatype Data type identifier (MIME type or typechain).
         * Default is "?". */
        virtual void setModel(const std::string& m, const std::string& datatype = "?");

        /** Make the "model" property use a file as storage, rather than memory.
         * @param filename Name of the file on disk.
         * @param datatype Data type identifier. (MIME type or typechain). Default is "?".
         * @see FileProperty
         * @throw FileAccessError if the file cannot be opened.
         */
        virtual void setModelToFile(const std::string& filename, const std::string& datatype = "?");

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

        virtual VUtil::vRef<VOS::Property> getModelObj();
        virtual void setModelObj(VOS::Property* obj);
    };
}

#endif