vos/3D/a3dl/billboard.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) 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

    Reed Hedges <reed@zerohour.net>
*/

#ifndef _A3DL_BILLBOARD_HH_
#define _A3DL_BILLBOARD_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
{

    /** Billboard objects are two dimensional images that have a position in 3D space. The first two
        components of the object's scaling property define the X and Y dimensions. The Z scaling is
        ignored. The orientation is also ignored: billboard objects always face the viewer, and are
        always "right side up".  The metaobject type for billboard objects is "object3D.billboard".
        Position and scaling properties are as in the "object3D" type, and a "material" property
        (containing a texture image or solid color) is added.

        You should create new Billboard objects using MetaFactory. After creation, you must call
        setPropertyAccessControl() on the new object, as well as setPosition(), setScaling() (even though
        the Z scaling factory is ignored, you should supply a value), and setOrientation() (even though
        the orientation is irrelevant)  -- Object3D requires values for all of these properties to work.

        @see Object3D for position, scaling methods, etc.
        @see MeshBase for texture (material) related methods.

        @author Reed Hedges <reed@zerohour.net> March, 2002. See source file for Copyright.
    */

    class A3DL_API Billboard : public virtual Object3D
    {
    public:
        Billboard(MetaObject* superobject);
        virtual ~Billboard();
        virtual const string getType();
        static void registerExtenders();
        static MetaObject* new_Billboard(MetaObject* superobject, const string& type);
    };
}

#endif

---