SNMDeactivationOnTimeout.h

Go to the documentation of this file.

/*********************************************************\
 *  File: SNMDeactivationOnTimeout.h                     *
 *
 *  Copyright (C) 2002-2011 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_DEACTIVATIONONTIMEOUT_H__
#define __PLSCENE_SCENENODEMODIFIER_DEACTIVATIONONTIMEOUT_H__
#pragma once


//[-------------------------------------------------------]
//[ Includes                                              ]
//[-------------------------------------------------------]
#include "PLScene/Scene/SceneNodeModifier.h"


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


//[-------------------------------------------------------]
//[ Classes                                               ]
//[-------------------------------------------------------]
/**
*  @brief
*    Deactivation on timeout scene node modifier class
*
*  @remarks
*    Deactivates the owner scene node after the given timeout.
*/
class SNMDeactivationOnTimeout : public SceneNodeModifier {


    //[-------------------------------------------------------]
    //[ RTTI interface                                        ]
    //[-------------------------------------------------------]
    pl_class(PLS_RTTI_EXPORT, SNMDeactivationOnTimeout, "PLScene", PLScene::SceneNodeModifier, "Deactivation on timeout scene node modifier class")
        // Attributes
        pl_attribute(Timeout,   float,  5.0f,   ReadWrite,  GetSet, "Timeout in seconds (if value set=restart)",    "")
        // Constructors
        pl_constructor_1(ParameterConstructor,  SceneNode&, "Parameter constructor",    "")
        // Slots
        pl_slot_0(OnUpdate, "Called when the scene node modifier needs to be updated",  "")
    pl_class_end


    //[-------------------------------------------------------]
    //[ Public RTTI get/set functions                         ]
    //[-------------------------------------------------------]
    public:
        PLS_API float GetTimeout() const;
        PLS_API void SetTimeout(float fValue);


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

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


    //[-------------------------------------------------------]
    //[ 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 data                                          ]
    //[-------------------------------------------------------]
    private:
        float m_fTimeout;
        float m_fTimer;


};


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


#endif // __PLSCENE_SCENENODEMODIFIER_DEACTIVATIONONTIMEOUT_H__