LayoutGenerator.h

#pragma once
// ===========================================================================
// Copyright (c) 2015 Toolchefs Ltd. All rights reserved.
//
// Use of this software is subject to the terms of the Toolchefs license
// agreement provided at the time of installation or download, or which
// otherwise accompanies this software in either electronic or hard copy form.
// ===========================================================================
 
#include <Atoms/Globals.h>
#include <Atoms/AgentTypes.h>
#include <AtomsCore/Globals.h>
#include <Atoms/AgentType.h>
#include <Atoms/BehaviourModuleAttributeCache.h>
#include <Atoms/AgentInitData.h>
#include <atomic>
 
namespace Atoms
{
    class LayoutGenerator;
 
    typedef AtomsPtr<LayoutGenerator>  LayoutGeneratorPtr; 
 
 
    class ATOMS_EXPORT LayoutGenerator
    {
    public:
        
 
        LayoutGenerator(bool isStatic = true);
 
        virtual ~LayoutGenerator();
 
        virtual bool allowMultiLayoutGenerator();
 
        virtual bool allowMultiple();
 
        virtual bool mustBeFirst();
 
        inline bool isStaticGenerator() const;
 
        inline void setAsStaticGenerator(bool value);
        
        virtual std::vector<AgentInitData> generate(double time) = 0;
 
        virtual inline AgentTypePtr agentType(const int groupId, const std::string& groupIdStr);
 
        inline void setAgentTypeAttributeCache(const BehaviourModuleAttributeCache<std::string>& agentTypeAttributeCache);
 
        inline void setDirectionAttributeCache(const BehaviourModuleAttributeCache<AtomsCore::Vector3>& directionAttributeCache);
 
        inline void setUpVectorAttributeCache(const BehaviourModuleAttributeCache<AtomsCore::Vector3>& upVectorAttributeCache);
 
        inline std::atomic<size_t>& nextFreeId();
 
        inline const std::atomic<size_t>& nextFreeId() const;
 
        inline void setName(const std::string &name);
 
        inline const std::string &name();
 
        virtual const char *typeName() = 0;
 
        void setGroupIdOffset(const int offset);
        
        const int groupIdOffset();
 
        inline void setOffsetPelvisHeight(bool state);
 
        inline void setOffsetPelvisHeightOverride(const std::map<int, bool>& value);
 
        inline void setOffsetPelvisHeightAttributeCache(const BehaviourModuleAttributeCache<bool>& offsetPelvisHeightCache);
 
        static const std::string getDefaultAgentType();
 
    protected:
 
        // Apply pelvis height offset attribute cache
        BehaviourModuleAttributeCache<bool> m_applyPelvisHeightOffsetCache;
 
        // agent type attribute cache
        BehaviourModuleAttributeCache<std::string> m_agentTypeAttributeCache;
 
        // direction attribute cache
        BehaviourModuleAttributeCache<AtomsCore::Vector3> m_directionAttributeCache;
 
        // up vector attribute cache
        BehaviourModuleAttributeCache<AtomsCore::Vector3> m_upVectorAttributeCache;
 
    private:
 
        AgentTypePtr m_agentType;
 
        std::atomic<size_t> m_nextFreeId;
 
        bool m_staticGenerator;
 
        std::string m_name;
 
        int m_groupIdOffset;
    };
}
 
#include "LayoutGenerator.impl.h"