HexLatticeGenerator.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 __LATTICE_AGENT_GENERATOR_H__
#define __LATTICE_AGENT_GENERATOR_H__

#include "mengeCommon.h"
#include "AgentGenerators/AgentGenerator.h"
#include "AgentGenerators/AgentGeneratorFactory.h"

namespace Menge {

    namespace Agents {
        class MENGE_API HexLatticeGenerator : public AgentGenerator {
        public:
            enum AnchorAlignEnum {
                CENTER,         
                LEFT_CORNER,    
                RIGHT_CORNER    
            };

            enum LatticeRowEnum {
                ROW_X,          
                ROW_Y           
            };

            HexLatticeGenerator();

            virtual size_t agentCount() { return _totalPop; }

            virtual Vector2 agentPos( size_t i );
            
            void set( const Vector2 & anchor, AnchorAlignEnum align, LatticeRowEnum dir,
                float width, float density, size_t tgtPopulation, float angle );

            void setRotationDeg( float angle );

        protected:
            Vector2 _anchor;

            LatticeRowEnum  _rowDir;

            float _cosRot;

            float _sinRot;

            size_t  _totalPop;

            float   _rowDist;

            float   _nbrDist;

            size_t _rowPop;

            size_t _rowCount;

        };


        class MENGE_API HexLatticeGeneratorFactory : public AgentGeneratorFactory {
        public:
            HexLatticeGeneratorFactory();

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

            virtual const char * description() const {
                return "Agent generation is done via the specification of a bounded hexagonal lattice.";
            };

        protected:
            AgentGenerator * instance() const { return new HexLatticeGenerator(); }

            virtual bool setFromXML( AgentGenerator * gen, TiXmlElement * node, const std::string & specFldr ) const;

            size_t _anchorXID;

            size_t _anchorYID;

            size_t _alignID;

            size_t _rowDirID;

            size_t _densityID;

            size_t _widthID;

            size_t _popID;

            size_t _rotID;
        };
    }   // namespace Agents
}    // namespace Menge
#endif  // __LATTICE_AGENT_GENERATOR_H__