triggercontroller.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005-2013 by the FIFE team                              *
 *   http://www.fifengine.net                                              *
 *   This file is part of FIFE.                                            *
 *                                                                         *
 *   FIFE 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 2.1 of the License, or (at your option) any later version.    *
 *                                                                         *
 *   This library 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 this library; if not, write to the                 *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
 ***************************************************************************/

#ifndef FIFE_TRIGGER_CONTROLLER_H
#define FIFE_TRIGGER_CONTROLLER_H

// Standard C++ library includes
#include <vector>
#include <string>
#include <map>

// 3rd party library includes

// FIFE includes
// These includes are split up in two parts, separated by one empty line
// First block: files included from the FIFE root src directory
// Second block: files included from the same folder
#include "util/base/fifeclass.h"
#include "util/structures/rect.h"
#include "model/metamodel/modelcoords.h"

namespace FIFE {

    // FORWARD REFERENCES
    class Trigger;
    class Map;
    class Layer;
    class Location;
    class Instance;
    class Cell;

    class TriggerController : public FifeClass {
    public:

    // LIFECYCLE

        TriggerController(Map* map);

        virtual ~TriggerController();

        Trigger* createTrigger(const std::string& triggerName);

        Trigger* createTrigger(const std::string& triggerName, Layer* layer, const ModelCoordinate& pt);

        Trigger* createTrigger(const std::string& triggerName, Layer* layer, const std::vector<ModelCoordinate>& coords);

        Trigger* createTrigger(const std::string& triggerName, Layer* layer, const Rect& rec);

        Trigger* createTrigger(const std::string& triggerName, const Location& loc);

        Trigger* createTrigger(const std::string& triggerName, const std::vector<Location>& locs);

        Trigger* createTrigger(const std::string& triggerName, Cell* cell);

        Trigger* createTrigger(const std::string& triggerName, const std::vector<Cell*>& cells);

        Trigger* createTrigger(const std::string& triggerName, Instance* instance);

        Trigger* getTrigger(const std::string& triggerName);
        
        void deleteTrigger(const std::string& triggerName);

        void removeTrigger(const std::string& triggerName, Layer* layer, const ModelCoordinate& pt);

        void removeTrigger(const std::string& triggerName, Layer* layer, const std::vector<ModelCoordinate>& coords);

        void removeTrigger(const std::string& triggerName, Layer* layer, const Rect& rec);

        void removeTrigger(const std::string& triggerName, const Location& loc);

        void removeTrigger(const std::string& triggerName, const std::vector<Location>& locs);

        void removeTrigger(const std::string& triggerName, Cell* cell);

        void removeTrigger(const std::string& triggerName, const std::vector<Cell*>& cells);

        void removeTrigger(const std::string& triggerName, Instance* instance);

        std::vector<Trigger*> getAllTriggers();

        std::vector<std::string> getAllTriggerNames();

    private:
        bool exists(const std::string& name);

        Map* m_map;

        typedef std::map< std::string, Trigger* > TriggerNameMap;
        typedef std::map< std::string, Trigger*  >::iterator TriggerNameMapIterator;
        typedef std::map< std::string, Trigger*  >::const_iterator TriggerNameMapConstIterator;
        typedef std::pair< std::string, Trigger*  > TriggerNameMapPair;

        TriggerNameMap m_triggerNameMap;
    };
} //FIFE

#endif