D:/SoftwareEntwicklung/C++/HLC/Tools/SoftPixelEngine/repository/sources/Framework/Tools/spStoryboardTrigger.hpp

Go to the documentation of this file.

/*
 * Storyboard trigger header
 * 
 * This file is part of the "SoftPixel Engine" (Copyright (c) 2008 by Lukas Hermanns)
 * See "SoftPixelEngine.hpp" for license information.
 */

#ifndef __SP_STORYBOARD_TRIGGER_H__
#define __SP_STORYBOARD_TRIGGER_H__


#include "Base/spStandard.hpp"

#ifdef SP_COMPILE_WITH_STORYBOARD


#include <vector>


namespace sp
{
namespace tool
{


class SP_EXPORT Trigger
{
    
    public:
        
        virtual ~Trigger();
        
        /* === Functions === */
        
        //virtual bool triggeredParents() const;
        
        virtual bool active() const;
        
        virtual bool needLoopUpdate() const;
        
        virtual bool canTrigger() const;
        
        void trigger();
        void untrigger();
        
        virtual void connect(Trigger* ChildTrigger);
        virtual void disconnect(Trigger* ChildTrigger);
        
        virtual void clearTriggers();
        
        virtual void onTriggered();
        virtual void onUntriggered();
        virtual void onRunning();
        
        /* === Inline functions === */
        
        inline const std::vector<Trigger*>& getChildList() const
        {
            return Children_;
        }
        inline const std::vector<Trigger*>& getParentList() const
        {
            return Parents_;
        }
        
        inline bool triggered() const
        {
            return IsTriggered_;
        }
        
    protected:
        
        Trigger();
        
        /* === Functions === */
        
        //void triggerChildren();
        //void untriggerChildren();
        
        void addToLoopUpdate();
        void removeFromLoopUpdate();
        
        void updateStates();
        
        /* === Members === */
        
        bool IsTriggered_;
        
        bool WasActive_;
        
    private:
        
        /* === Members === */
        
        std::vector<Trigger*> Children_;
        std::vector<Trigger*> Parents_;
        
};


} // /namespace tool

} // /namespace sp


#endif

#endif



// ================================================================================