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-2012 Torus Knot Software Ltd

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.
-----------------------------------------------------------------------------
*/

#ifndef __Billboard_H__
#define __Billboard_H__

#include "OgrePrerequisites.h"

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

namespace Ogre {
    class _OgreExport Billboard : public FXAlloc
    {
        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