OgreAnimable.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-2013 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 __ANIMABLE_H__
#define __ANIMABLE_H__

#include "OgrePrerequisites.h"
#include "OgreVector2.h"
#include "OgreVector3.h"
#include "OgreVector4.h"
#include "OgreQuaternion.h"
#include "OgreColourValue.h"
#include "OgreSharedPtr.h"
#include "OgreStringVector.h"
#include "OgreException.h"
#include "OgreAny.h"
#include "OgreHeaderPrefix.h"

namespace Ogre {
    class _OgreExport AnimableValue : public AnimableAlloc
    {
    public:
        enum ValueType
        {
            INT,
            REAL,
            VECTOR2,
            VECTOR3,
            VECTOR4,
            QUATERNION,
            COLOUR,
            RADIAN,
            DEGREE
        };
    protected:
        ValueType mType;

        union
        {
            int mBaseValueInt;
            Real mBaseValueReal[4];
        };

        virtual void setAsBaseValue(int val) { mBaseValueInt = val; }
        virtual void setAsBaseValue(Real val) { mBaseValueReal[0] = val; }
        virtual void setAsBaseValue(const Vector2& val) 
        { memcpy(mBaseValueReal, val.ptr(), sizeof(Real)*2); }
        virtual void setAsBaseValue(const Vector3& val) 
        { memcpy(mBaseValueReal, val.ptr(), sizeof(Real)*3); }
        virtual void setAsBaseValue(const Vector4& val) 
        { memcpy(mBaseValueReal, val.ptr(), sizeof(Real)*4); }
        virtual void setAsBaseValue(const Quaternion& val) 
        { memcpy(mBaseValueReal, val.ptr(), sizeof(Real)*4); }
        virtual void setAsBaseValue(const Any& val);
        virtual void setAsBaseValue(const ColourValue& val)
        { 
            mBaseValueReal[0] = val.r;
            mBaseValueReal[1] = val.g;
            mBaseValueReal[2] = val.b;
            mBaseValueReal[3] = val.a;
        }
        virtual void setAsBaseValue(const Radian& val)
        { 
            mBaseValueReal[0] = val.valueRadians();
        }
        virtual void setAsBaseValue(const Degree& val)
        { 
            mBaseValueReal[0] = val.valueRadians();
        }


    public:
        AnimableValue(ValueType t) : mType(t) {}
        virtual ~AnimableValue() {}

        ValueType getType(void) const { return mType; }

        virtual void setCurrentStateAsBaseValue(void) = 0;

        virtual void setValue(int) {
            OGRE_EXCEPT(Exception::ERR_NOT_IMPLEMENTED, "", "");
        }
        virtual void setValue(Real) {
            OGRE_EXCEPT(Exception::ERR_NOT_IMPLEMENTED, "", "");
        }
        virtual void setValue(const Vector2&) {
            OGRE_EXCEPT(Exception::ERR_NOT_IMPLEMENTED, "", "");
        }
        virtual void setValue(const Vector3&) {
            OGRE_EXCEPT(Exception::ERR_NOT_IMPLEMENTED, "", "");
        }
        virtual void setValue(const Vector4&) {
            OGRE_EXCEPT(Exception::ERR_NOT_IMPLEMENTED, "", "");
        }
        virtual void setValue(const Quaternion&) {
            OGRE_EXCEPT(Exception::ERR_NOT_IMPLEMENTED, "", "");
        }
        virtual void setValue(const ColourValue&) {
            OGRE_EXCEPT(Exception::ERR_NOT_IMPLEMENTED, "", "");
        }
        virtual void setValue(const Radian&) {
            OGRE_EXCEPT(Exception::ERR_NOT_IMPLEMENTED, "", "");
        }
        virtual void setValue(const Degree&) {
            OGRE_EXCEPT(Exception::ERR_NOT_IMPLEMENTED, "", "");
        }
        virtual void setValue(const Any& val);

        // reset to base value
        virtual void resetToBaseValue(void);

        virtual void applyDeltaValue(int) {
            OGRE_EXCEPT(Exception::ERR_NOT_IMPLEMENTED, "", "");
        }
        virtual void applyDeltaValue(Real) {
            OGRE_EXCEPT(Exception::ERR_NOT_IMPLEMENTED, "", "");
        }
        virtual void applyDeltaValue(const Vector2&) {
            OGRE_EXCEPT(Exception::ERR_NOT_IMPLEMENTED, "", "");
        }
        virtual void applyDeltaValue(const Vector3&) {
            OGRE_EXCEPT(Exception::ERR_NOT_IMPLEMENTED, "", "");
        }
        virtual void applyDeltaValue(const Vector4&) {
            OGRE_EXCEPT(Exception::ERR_NOT_IMPLEMENTED, "", "");
        }
        virtual void applyDeltaValue(const Quaternion&) {
            OGRE_EXCEPT(Exception::ERR_NOT_IMPLEMENTED, "", "");
        }
        virtual void applyDeltaValue(const ColourValue&) {
            OGRE_EXCEPT(Exception::ERR_NOT_IMPLEMENTED, "", "");
        }
        virtual void applyDeltaValue(const Degree&) {
            OGRE_EXCEPT(Exception::ERR_NOT_IMPLEMENTED, "", "");
        }
        virtual void applyDeltaValue(const Radian&) {
            OGRE_EXCEPT(Exception::ERR_NOT_IMPLEMENTED, "", "");
        }
        virtual void applyDeltaValue(const Any& val);


    };

    typedef SharedPtr<AnimableValue> AnimableValuePtr;



    class _OgreExport AnimableObject
    {
    protected:
        typedef map<String, StringVector>::type AnimableDictionaryMap;
        static AnimableDictionaryMap msAnimableDictionary;
        virtual const String& getAnimableDictionaryName(void) const 
        { return StringUtil::BLANK; }
        void createAnimableDictionary(void) const
        {
            if (msAnimableDictionary.find(getAnimableDictionaryName()) 
                == msAnimableDictionary.end())
            {
                StringVector vec;
                initialiseAnimableDictionary(vec);
                msAnimableDictionary[getAnimableDictionaryName()] = vec;
            }

        }
    
        StringVector& _getAnimableValueNames(void)
        {
            AnimableDictionaryMap::iterator i = 
                msAnimableDictionary.find(getAnimableDictionaryName());
            if (i != msAnimableDictionary.end())
            {
                return i->second;
            }
            else
            {
                OGRE_EXCEPT(Exception::ERR_ITEM_NOT_FOUND, 
                    "Animable value list not found for " + getAnimableDictionaryName(), 
                    "AnimableObject::getAnimableValueNames");
            }

        }

        virtual void initialiseAnimableDictionary(StringVector&) const {}


    public:
        AnimableObject() {}
        virtual ~AnimableObject() {}

        const StringVector& getAnimableValueNames(void) const
        {
            createAnimableDictionary();

            AnimableDictionaryMap::iterator i = 
                msAnimableDictionary.find(getAnimableDictionaryName());
            if (i != msAnimableDictionary.end())
            {
                return i->second;
            }
            else
            {
                OGRE_EXCEPT(Exception::ERR_ITEM_NOT_FOUND, 
                    "Animable value list not found for " + getAnimableDictionaryName(), 
                    "AnimableObject::getAnimableValueNames");
            }

        }

        virtual AnimableValuePtr createAnimableValue(const String& valueName)
        {
            OGRE_EXCEPT(Exception::ERR_ITEM_NOT_FOUND, 
                "No animable value named '" + valueName + "' present.", 
                "AnimableObject::createAnimableValue");
        }



    };

}

#include "OgreHeaderSuffix.h"

#endif