vos/3D/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 <tetron@interreality.org>
*/

#ifndef _MODEL_HH_
#define _MODEL_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 "object3d.hh"

namespace 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(MetaObject* 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 string& m, const 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 string& filename, const string& datatype = "?");

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

        virtual Property* getModelObj();
        virtual void setModelObj(Property* obj);
    };
}

#endif

---