OgreBillboard.h

Go to the documentation of this file.

/*
-----------------------------------------------------------------------------
This source file is part of OGRE
    (Object-oriented Graphics Rendering Engine)
For the latest info, see http://www.ogre3d.org/

Copyright (c) 2000-2005 The OGRE Team
Also see acknowledgements in Readme.html

This program 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 program 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 program; if not, write to the Free Software Foundation, Inc., 59 Temple
Place - Suite 330, Boston, MA 02111-1307, USA, or go to
http://www.gnu.org/copyleft/lesser.txt.
-----------------------------------------------------------------------------
*/

#ifndef __Billboard_H__
#define __Billboard_H__

#include "OgrePrerequisites.h"

#include "OgreVector3.h"
#include "OgreColourValue.h"
#include "OgreCommon.h"

namespace Ogre {

    class _OgreExport Billboard
    {
        friend class BillboardSet;
        friend class BillboardParticleRenderer;
    protected:
        bool mOwnDimensions;
        bool mUseTexcoordRect;
        uint16 mTexcoordIndex;      // index into the BillboardSet array of texture coordinates
        FloatRect mTexcoordRect;    // individual texture coordinates
        Real mWidth;
        Real mHeight;
    public:
        // Note the intentional public access to main internal variables used at runtime
        // Forcing access via get/set would be too costly for 000's of billboards
        Vector3 mPosition;
        // Normalised direction vector
        Vector3 mDirection;
        BillboardSet* mParentSet;
        ColourValue mColour;
        Radian mRotation;

        Billboard();

        ~Billboard();

        Billboard(const Vector3& position, BillboardSet* owner, const ColourValue& colour = ColourValue::White);

        const Radian& getRotation(void) const { return mRotation; }

        void setRotation(const Radian& rotation);

        void setPosition(const Vector3& position);

        void setPosition(Real x, Real y, Real z);

        const Vector3& getPosition(void) const;

        void setDimensions(Real width, Real height);

        void resetDimensions(void) { mOwnDimensions = false; }
        void setColour(const ColourValue& colour);

        const ColourValue& getColour(void) const;

        bool hasOwnDimensions(void) const;

        Real getOwnWidth(void) const;

        Real getOwnHeight(void) const;

        void _notifyOwner(BillboardSet* owner);

        bool isUseTexcoordRect(void) const { return mUseTexcoordRect; }

        void setTexcoordIndex(uint16 texcoordIndex);

        uint16 getTexcoordIndex(void) const { return mTexcoordIndex; }

        void setTexcoordRect(const FloatRect& texcoordRect);

        void setTexcoordRect(Real u0, Real v0, Real u1, Real v1);

        const FloatRect& getTexcoordRect(void) const { return mTexcoordRect; }
    };

}

#endif

---

Copyright © 2000-2005 by The OGRE Team

This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Mar 12 14:37:37 2006