CondSpace.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 __COND_SPACE_H__
#define __COND_SPACE_H__

#include "CoreConfig.h"
#include "Transitions/Condition.h"
#include "Transitions/ConditionFactory.h"
#include "Math/Geometry2D.h"
#include "fsmCommon.h"

namespace Menge {

    namespace BFSM {
        //forward declartions
        class SpaceCondFactory;

        class MENGE_API SpaceCondition : public Condition {
        public:
            SpaceCondition();

            SpaceCondition( const SpaceCondition & cond );

        protected:
            ~SpaceCondition();

        public:
            virtual bool conditionMet( Agents::BaseAgent * agent, const Goal * goal );

            friend class SpaceCondFactory;
        protected:
            virtual bool containsPoint( const Vector2 & pt ) const = 0;

            bool    _outsideActive;
        };


        class MENGE_API SpaceCondFactory : public ConditionFactory {
        public:
            SpaceCondFactory();

        protected:
            virtual bool setFromXML( Condition * condition, TiXmlElement * node, const std::string & behaveFldr ) const;
        
            size_t  _insideID;
        };


        class MENGE_API CircleCondition : public SpaceCondition, public CircleShape {
        public:
            CircleCondition();

            CircleCondition( const CircleCondition & cond );

            virtual Condition * copy();

        protected:
            virtual bool containsPoint( const Vector2 & pt ) const { return CircleShape::containsPoint( pt ); }
        };

        class MENGE_API CircleCondFactory : public SpaceCondFactory {
        public:
            CircleCondFactory();

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

            virtual const char * description() const {
                return "The circle condition.  It becomes active when an agent achieves "\
                    "a particular relationship (inside/outside) with a static circle in the " \
                    "environment.";
            }
        protected:
            virtual Condition * instance() const { return new CircleCondition(); }

            virtual bool setFromXML( Condition * condition, TiXmlElement * node, const std::string & behaveFldr ) const;
        
            size_t  _centerXID;
        
            size_t  _centerYID;
        
            size_t  _radiusID;
        };


        class MENGE_API AABBCondition : public SpaceCondition, public AABBShape {
        public:
            AABBCondition();

            AABBCondition( const AABBCondition & cond );

            virtual Condition * copy();
        protected:
            virtual bool containsPoint( const Vector2 & pt ) const { return AABBShape::containsPoint( pt ); }
        };

        class MENGE_API AABBCondFactory : public SpaceCondFactory {
        public:
            AABBCondFactory();

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

            virtual const char * description() const {
                return "The axis-aligned bounding box (AABB) condition.  It becomes active when an agent achieves "\
                    "a particular relationship (inside/outside) with a static axis-aligned bounding box in the " \
                    "environment.";
            }
        protected:
            virtual Condition * instance() const { return new AABBCondition(); }

            virtual bool setFromXML( Condition * condition, TiXmlElement * node, const std::string & behaveFldr ) const;
        
            size_t  _minXID;
        
            size_t  _minYID;
        
            size_t  _maxXID;
        
            size_t  _maxYID;
        };


        class MENGE_API OBBCondition : public SpaceCondition, public OBBShape {
        public:
            OBBCondition();

            OBBCondition( const OBBCondition & cond );

            virtual Condition * copy();
        protected:
            virtual bool containsPoint( const Vector2 & pt ) const { return OBBShape::containsPoint( pt ); }
        };

        class MENGE_API OBBCondFactory : public SpaceCondFactory {
        public:
            OBBCondFactory();

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

            virtual const char * description() const {
                return "The oriented bounding box (OBB) condition.  It becomes active when an agent achieves "\
                    "a particular relationship (inside/outside) with a static oriented bounding box in the " \
                    "environment.";
            }
        protected:
            virtual Condition * instance() const { return new OBBCondition(); }

            virtual bool setFromXML( Condition * condition, TiXmlElement * node, const std::string & behaveFldr ) const;
        
            size_t  _pivotXID;
        
            size_t  _pivotYID;
        
            size_t  _widthID;
        
            size_t  _heightID;
        
            size_t  _angleID;
        };

    }   // namespace BFSM
}

#endif  // __COND_SPACE_H__