SNMPositionKeyframeAnimation.h

Go to the documentation of this file.

/*********************************************************\
 *  File: SNMPositionKeyframeAnimation.h                 *
 *
 *  Copyright (C) 2002-2012 The PixelLight Team (http://www.pixellight.org/)
 *
 *  This file is part of PixelLight.
 *
 *  PixelLight 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 3 of the License, or
 *  (at your option) any later version.
 *
 *  PixelLight 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 PixelLight. If not, see <http://www.gnu.org/licenses/>.
\*********************************************************/


#ifndef __PLSCENE_SCENENODEMODIFIER_POSITIONKEYFRAMEANIMATION_H__
#define __PLSCENE_SCENENODEMODIFIER_POSITIONKEYFRAMEANIMATION_H__
#pragma once


//[-------------------------------------------------------]
//[ Includes                                              ]
//[-------------------------------------------------------]
#include <PLCore/Base/Event/EventHandler.h>
#include "PLScene/Scene/SceneNodeModifiers/SNMTransform.h"


//[-------------------------------------------------------]
//[ Forward declarations                                  ]
//[-------------------------------------------------------]
namespace PLCore {
    class Chunk;
}
namespace PLRenderer {
    class Animation;
}


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
namespace PLScene {


//[-------------------------------------------------------]
//[ Classes                                               ]
//[-------------------------------------------------------]
/**
*  @brief
*    Keyframe position animation scene node modifier class
*
*  @remarks
*    Animates the position of the scene nodes over time using keyframes.
*
*  @note
*    - The "CoordinateSystem" attribute can be quite useful if the scene contains portals
*/
class SNMPositionKeyframeAnimation : public SNMTransform {


    //[-------------------------------------------------------]
    //[ Public definition                                     ]
    //[-------------------------------------------------------]
    public:
        /**
        *  @brief
        *    Scene node modifier flags (SceneNodeModifier flags extension)
        */
        enum EFlags {
            PlaybackNoLoop   = 1<<2,    /**< No loop animation */
            PlaybackPingPong = 1<<3     /**< Ping pong animation */
        };
        pl_enum(EFlags)
            pl_enum_base(SNMTransform::EFlags)
            pl_enum_value(PlaybackNoLoop,   "No loop animation")
            pl_enum_value(PlaybackPingPong, "Ping pong animation")
        pl_enum_end


    //[-------------------------------------------------------]
    //[ RTTI interface                                        ]
    //[-------------------------------------------------------]
    pl_class(PLS_RTTI_EXPORT, SNMPositionKeyframeAnimation, "PLScene", PLScene::SNMTransform, "Keyframe position animation scene node modifier class")
        // Attributes
        pl_attribute(Speed,             float,                  1.0f,   ReadWrite,  DirectValue,    "Animation playback speed",                                                                                                     "")
        pl_attribute(FramesPerSecond,   PLCore::uint32,         24,     ReadWrite,  DirectValue,    "Frames per second",                                                                                                            "")
        pl_attribute(Keys,              PLCore::String,         "",     ReadWrite,  GetSet,         "Position keys (x, y and z) chunk filename",                                                                                    "")
        pl_attribute(CoordinateSystem,  PLCore::String,         "",     ReadWrite,  DirectValue,    "Name of the scene container the position keys are in, empty string means scene container of the modifiers owner scene node",   "")
            // Overwritten SceneNodeModifier attributes
        pl_attribute(Flags,             pl_flag_type(EFlags),   0,      ReadWrite,  GetSet,         "Flags",                                                                                                                        "")
        // Constructors
        pl_constructor_1(ParameterConstructor,  SceneNode&, "Parameter constructor",    "")
    pl_class_end


    //[-------------------------------------------------------]
    //[ Public RTTI get/set functions                         ]
    //[-------------------------------------------------------]
    public:
        PLS_API PLCore::String GetKeys() const;
        PLS_API void SetKeys(const PLCore::String &sValue);


    //[-------------------------------------------------------]
    //[ Public functions                                      ]
    //[-------------------------------------------------------]
    public:
        /**
        *  @brief
        *    Constructor
        *
        *  @param[in] cSceneNode
        *    Owner scene node
        */
        PLS_API SNMPositionKeyframeAnimation(SceneNode &cSceneNode);

        /**
        *  @brief
        *    Destructor
        */
        PLS_API virtual ~SNMPositionKeyframeAnimation();

        /**
        *  @brief
        *    Returns the chunk holding the keyframe data
        *
        *  @return
        *    The chunk holding the keyframe data
        */
        PLS_API PLCore::Chunk &GetChunk();

        /**
        *  @brief
        *    Returns the animation controller
        *
        *  @return
        *    The animation controller
        */
        PLS_API PLRenderer::Animation &GetAnimation();


    //[-------------------------------------------------------]
    //[ Protected virtual SceneNodeModifier functions         ]
    //[-------------------------------------------------------]
    protected:
        PLS_API virtual void OnActivate(bool bActivate) override;


    //[-------------------------------------------------------]
    //[ Private functions                                     ]
    //[-------------------------------------------------------]
    private:
        /**
        *  @brief
        *    Called when the scene node modifier needs to be updated
        */
        void OnUpdate();


    //[-------------------------------------------------------]
    //[ Private event handlers                                ]
    //[-------------------------------------------------------]
    private:
        PLCore::EventHandler<> EventHandlerUpdate;


    //[-------------------------------------------------------]
    //[ Private data                                          ]
    //[-------------------------------------------------------]
    private:
        PLCore::String         m_sKeys;         /**< Position keys (x, y and z) chunk filename */
        PLCore::Chunk         *m_pChunk;        /**< Chunk holding the keyframe data, always valid! */
        PLRenderer::Animation *m_pAnimation;    /**< Animation */


};


//[-------------------------------------------------------]
//[ Namespace                                             ]
//[-------------------------------------------------------]
} // PLScene


#endif // __PLSCENE_SCENENODEMODIFIER_POSITIONKEYFRAMEANIMATION_H__