/*
* All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
* its licensors.
*
* For complete copyright and license terms please see the LICENSE at the root of this
* distribution (the "License"). All use of this software is governed by the License,
* or, if provided, by the license below or the license accompanying this file. Do not
* remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*
*/
// Original file Copyright Crytek GMBH or its affiliates, used under license.

// Description : Contains an agent's target tracks and handles updating them


#ifndef CRYINCLUDE_CRYAISYSTEM_TARGETSELECTION_TARGETTRACKGROUP_H
#define CRYINCLUDE_CRYAISYSTEM_TARGETSELECTION_TARGETTRACKGROUP_H
#pragma once

#include "TargetTrackCommon.h"

class CTargetTrack;
struct IDebugHistoryManager;

// Needed for CreateDummyPotentialTarget
#include <IPerceptionHandler.h>

class CTargetTrackGroup
{
public:
    CTargetTrackGroup(TargetTrackHelpers::ITargetTrackPoolProxy* pTrackPoolProxy, tAIObjectID aiObjectId, uint32 uConfigHash, int nTargetLimit);
    ~CTargetTrackGroup();

    tAIObjectID GetAIObjectID() const { return m_aiObjectId; }
    tAIObjectID GetLastBestTargetID() const { return m_aiLastBestTargetId; }
    uint32 GetConfigHash() const { return m_uConfigHash; }
    int GetTargetLimit() const { return m_nTargetLimit; }
    bool IsEnabled() const { return m_bEnabled; }
    void SetEnabled(bool bEnabled) { m_bEnabled = bEnabled; }

    void Reset();
    void Serialize_Write(TSerialize ser);
    void Serialize_Read(TSerialize ser);

    void Update(TargetTrackHelpers::ITargetTrackConfigProxy* pConfigProxy);

    bool HandleStimulusEvent(const TargetTrackHelpers::STargetTrackStimulusEvent& stimulusEvent, uint32 uStimulusNameHash);
    bool TriggerPulse(tAIObjectID targetID, uint32 uStimulusNameHash, uint32 uPulseNameHash);
    bool TriggerPulse(uint32 uStimulusNameHash, uint32 uPulseNameHash);
    bool GetDesiredTarget(TargetTrackHelpers::EDesiredTargetMethod eMethod, CWeakRef<CAIObject>& outTarget, SAIPotentialTarget*& pOutTargetInfo);
    uint32 GetBestTrack(TargetTrackHelpers::EDesiredTargetMethod eMethod, CTargetTrack** tracks, uint32 maxCount);

    bool IsPotentialTarget(tAIObjectID aiTargetId) const;
    bool IsDesiredTarget(tAIObjectID aiTargetId) const;

#ifdef TARGET_TRACK_DEBUG
    // Debugging
    void DebugDrawTracks(TargetTrackHelpers::ITargetTrackConfigProxy* pConfigProxy, bool bLastDraw);
    void DebugDrawTargets(int nMode, int nTargetedCount, bool bExtraInfo = false);
#endif //TARGET_TRACK_DEBUG

    typedef VectorMap<tAIObjectID, CTargetTrack*> TTargetTrackContainer;

    TTargetTrackContainer& GetTargetTracks() { return m_TargetTracks; }

private:
    CTargetTrackGroup(CTargetTrackGroup const&) {}
    CTargetTrackGroup& operator =(CTargetTrackGroup const&) { return *this; }

    void UpdateSortedTracks(bool bForced = false);
    bool TestTrackAgainstFilters(CTargetTrack* pTrack, TargetTrackHelpers::EDesiredTargetMethod eMethod) const;

    // Stimulus handling helpers
    bool HandleStimulusEvent_All(const TargetTrackHelpers::STargetTrackStimulusEvent& stimulusEvent, uint32 uStimulusNameHash);
    bool HandleStimulusEvent_Target(const TargetTrackHelpers::STargetTrackStimulusEvent& stimulusEvent, uint32 uStimulusNameHash, CTargetTrack* pTrack);

    // Returns the target track to be used for the given id
    CTargetTrack* GetTargetTrack(tAIObjectID aiTargetId);
    void DeleteTargetTracks();

    //void UpdateTargetRepresentation(const CTargetTrack *pBestTrack, tAIObjectID &outTargetId, SAIPotentialTarget* &pOutTargetInfo);
    void UpdateTargetRepresentation(const CTargetTrack* pBestTrack, CWeakRef<CAIObject>& outTarget, SAIPotentialTarget*& pOutTargetInfo);

    void InitDummy();   // set common dummy properties after creation.

private:
    TTargetTrackContainer m_TargetTracks;

    typedef std::vector<CTargetTrack*> TSortedTracks;
    TSortedTracks m_SortedTracks;

    TargetTrackHelpers::ITargetTrackPoolProxy* m_pTrackPoolProxy;
    tAIObjectID m_aiObjectId;
    tAIObjectID m_aiLastBestTargetId;
    uint32 m_uConfigHash;
    int m_nTargetLimit;
    bool m_bNeedSort;
    bool m_bEnabled;

    SAIPotentialTarget m_dummyPotentialTarget;

#ifdef TARGET_TRACK_DEBUG
    // Debugging
    bool FindFreeGraphSlot(uint32& outIndex) const;

    float m_fLastGraphUpdate;
    IDebugHistoryManager* m_pDebugHistoryManager;
    enum
    {
        DEBUG_GRAPH_OCCUPIED_SIZE = 16
    };
    bool m_bDebugGraphOccupied[DEBUG_GRAPH_OCCUPIED_SIZE];
#endif //TARGET_TRACK_DEBUG
};

#endif // CRYINCLUDE_CRYAISYSTEM_TARGETSELECTION_TARGETTRACKGROUP_H