FormationsModifier.h

Go to the documentation of this file.

/*

License

Menge
Copyright © and trademark ™ 2012-14 University of North Carolina at Chapel Hill. 
All rights reserved.

Permission to use, copy, modify, and distribute this software and its documentation 
for educational, research, and non-profit purposes, without fee, and without a 
written agreement is hereby granted, provided that the above copyright notice, 
this paragraph, and the following four paragraphs appear in all copies.

This software program and documentation are copyrighted by the University of North 
Carolina at Chapel Hill. The software program and documentation are supplied "as is," 
without any accompanying services from the University of North Carolina at Chapel 
Hill or the authors. The University of North Carolina at Chapel Hill and the 
authors do not warrant that the operation of the program will be uninterrupted 
or error-free. The end-user understands that the program was developed for research 
purposes and is advised not to rely exclusively on the program for any reason.

IN NO EVENT SHALL THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL OR THE AUTHORS 
BE LIABLE TO ANY PARTY FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL 
DAMAGES, INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS 
DOCUMENTATION, EVEN IF THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL OR THE 
AUTHORS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL AND THE AUTHORS SPECIFICALLY 
DISCLAIM ANY WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 
OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE AND ANY STATUTORY WARRANTY 
OF NON-INFRINGEMENT. THE SOFTWARE PROVIDED HEREUNDER IS ON AN "AS IS" BASIS, AND 
THE UNIVERSITY OF NORTH CAROLINA AT CHAPEL HILL AND THE AUTHORS HAVE NO OBLIGATIONS 
TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.

Any questions or comments should be sent to the authors {menge,geom}@cs.unc.edu

*/

#ifndef __FORMATIONS_MODIFIER_H__
#define __FORMATIONS_MODIFIER_H__

#include "FormationsConfig.h"
#include "FreeFormation.h"
#include "VelocityModifiers/VelModifier.h"
#include "VelocityModifiers/VelModifierFactory.h"
#include "FSMEnumeration.h"
#include "ReadersWriterLock.h"

using namespace Menge;

#if defined(_MSC_VER)
    // Visual Studio spews warnings about some members.
    // It wants them to be exposed in the dll IN CASE a client uses it.
    //TODO: remove this warning supression, correct the problem
    #pragma warning(disable:4251)
#endif

//forward declaration
class TiXmlElement;

namespace Formations {

    // forward declaration
    class FormationModifierFactory;

    class FORMATIONS_API FormationModifier : public BFSM::VelModifier {
    public:
        FormationModifier();

        FormationModifier( FormationPtr form );

    protected:
        virtual ~FormationModifier();

    public:

        BFSM::VelModifier* copy() const;

        void adaptPrefVelocity( const Agents::BaseAgent * agent, Agents::PrefVelocity & pVel );

        virtual BFSM::Task * getTask();

        void setFormation( FormationPtr form );

        void registerAgent(const Agents::BaseAgent * agent);

        void unregisterAgent(const Agents::BaseAgent * agent);

        //virtual VelModContext * getContext();

        friend class FormationModifierFactory;

    protected:

        FormationPtr _formation;
        
        ReadersWriterLock   _lock;

    };


    class FORMATIONS_API FormationModifierFactory : public BFSM::VelModFactory {
    public:
        FormationModifierFactory();

        virtual const char * name() const { return "formation"; }

        virtual const char * description() const {
            return "Forces agents in this state or machine to move in formation";
        };

    protected:
        BFSM::VelModifier * instance() const { return new FormationModifier(); }    
        
        virtual bool setFromXML( BFSM::VelModifier * modifier, TiXmlElement * node, const std::string & behaveFldr ) const;

        size_t  _fileNameID;
    };
};
#endif