asyncquerydispatcher.h

Go to the documentation of this file.

/*
* Copyright 2016 Autodesk, Inc. All rights reserved.
* Use of this software is subject to the terms of the Autodesk license agreement and any attachments or Appendices thereto provided at the time of installation or download,
* or which otherwise accompanies this software in either electronic or hard copy form, or which is signed by you and accepted by Autodesk.
*/


#pragma once


#include "gwnavruntime/querysystem/queryqueuearray.h"
#include "gwnavruntime/querysystem/queryqueue.h"


namespace Kaim
{

class Bot;

enum AsyncQueryDispatchId
{
    AsyncQueryDispatchId_Default        = 0,
    AsyncQueryDispatchId_PathFinder     = 1,
    AsyncQueryDispatchId_DynamicNavMesh = 2,
    AsyncQueryDispatchId_PathFollower   = 3,

    AsyncQueryDispatchId_Count
};


enum AsyncQueryDispatcherType
{
    AsyncQueryDispatcherType_Unknown = 0,
    AsyncQueryDispatcherType_Default,
    AsyncQueryDispatcherType_FirstCustom
};

class IAsyncQueryDispatcher : public RefCountBase<IAsyncQueryDispatcher, MemStat_QuerySystem>
{
public:
    IAsyncQueryDispatcher() : m_world(nullptr) {}

    void SetWorld(World* world) { m_world = world; }
    World* GetWorld() { return m_world; }

    virtual void AddQueryQueuesToWorld() = 0;
    virtual void RemoveQueryQueuesFromWorld() = 0;

    virtual QueryQueue* GetQueue(IQuery* query, AsyncQueryDispatchId asyncQueryDispatchId = AsyncQueryDispatchId_Default, Bot* bot = nullptr) = 0;

    virtual ~IAsyncQueryDispatcher() {}

protected:
    World* m_world;
};


class AsyncQueryDispatcherInitConfig
{
public:
    // By default, only one queryQueue is created in the mainThread
    AsyncQueryDispatcherInitConfig()
        : m_createWorkerQueryQueueArray(false)
        , m_useWorkerQueryQueueByDefault(false)
        , m_usePathFinderQueryQueue(true)
        , m_useDynamicNavMeshQueryQueue(true)
        , m_usePathFollowerQueryQueue(true)
    {}

    bool m_createWorkerQueryQueueArray; // create a QueryQueueArray dedicated to run out of World::Update
    bool m_useWorkerQueryQueueByDefault; // will be used to init the AsyncQueryDispatcher::m_useWorkerQueryQueue

    bool m_usePathFinderQueryQueue;     // if false create only one queue: m_defaultQueryQueueConfig
    bool m_useDynamicNavMeshQueryQueue; // if false create only two queues: m_defaultQueryQueueConfig and m_pathFinderQueryQueueConfig
    bool m_usePathFollowerQueryQueue;   // if false create only three queues: m_defaultQueryQueueConfig, m_pathFinderQueryQueueConfig and m_dynamicNavMeshQueryQueueConfig

    QueryQueueConfig m_defaultQueryQueueConfig;        // will be queue[0]
    QueryQueueConfig m_pathFinderQueryQueueConfig;     // will be queue[1]
    QueryQueueConfig m_dynamicNavMeshQueryQueueConfig; // will be queue[2]
    QueryQueueConfig m_pathFollowerQueryQueueConfig;   // will be queue[3]
};

class AsyncQueryDispatcher : public IAsyncQueryDispatcher
{
public:
    AsyncQueryDispatcher(const AsyncQueryDispatcherInitConfig& initConfig);

    virtual ~AsyncQueryDispatcher();

    virtual void AddQueryQueuesToWorld();
    virtual void RemoveQueryQueuesFromWorld();

    virtual QueryQueue* GetQueue(IQuery* query, AsyncQueryDispatchId asyncQueryDispatchId = AsyncQueryDispatchId_Default, Bot* bot = nullptr);

    // change on the fly
    void UseWorker(bool useWorkerQueryQueue) { m_useWorkerQueryQueue = useWorkerQueryQueue; }

private:
    void InitQueryQueueArray(QueryQueueArray* queryQueueArray, QueryQueueArrayProcess queryQueueArrayProcessThread);
    QueryQueue* GetQueueInArray(QueryQueueArray* queryQueueArray, AsyncQueryDispatchId asyncQueryDispatchId);
    void RemoveQueryQueuesFromWorldImpl();

private:
    AsyncQueryDispatcherInitConfig m_initConfig;
    Ptr<QueryQueueArray> m_mainQueryQueueArray;
    Ptr<QueryQueueArray> m_workerQueryQueueArray;
    bool m_useWorkerQueryQueue;
};


} // namespace Kaim