activator.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2004-2005 by Reality Rift Studios                       *
 *   http://www.realityrift.com  -  mattias@realityrift.com                *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 2 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program 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 General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/

#ifndef neo_core_activator_h
#define neo_core_activator_h

#include "platform.h"

#if NEO_ENABLE_SCRIPTING
#  include "../script/binding.h"
#endif

namespace neo {
namespace core {

class Activator
#if NEO_ENABLE_SCRIPTING
    : public virtual script::Scriptable
#endif
{
    public:


                                                            Activator( bool active = true );
    

                                                            Activator( const Activator& ref );
    
    virtual                                                ~Activator();
    

    void                                                    activate();


    void                                                    deactivate();


    inline bool                                             toggle();


    inline bool                                             isActive() const;
    

    Activator&                                              operator = ( const Activator& rhs );

    protected:
        

    virtual void                                            onActiveStateChange();
    
#if NEO_ENABLE_SCRIPTING
    virtual void                                            getEvents( core::Array< std::string >* p_events );
#endif

    private:

    bool                                                    _active;
};

#include "activator.inl"

}
}

#endif

---