generator.h

Go to the documentation of this file.

/*
* Copyright 2015 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.
*/


// primary contact: GUAL - secondary contact: LASI
#ifndef GwNavGen_Generator_H
#define GwNavGen_Generator_H

#include "gwnavruntime/base/fileopener.h"
#include "gwnavruntime/kernel/SF_String.h"
#include "gwnavruntime/kernel/SF_RefCount.h"

#include "gwnavgeneration/common/generatormemory.h"
#include "gwnavgeneration/common/generatormemoryheap.h"
#include "gwnavgeneration/generator/generatorprofiling.h"
#include "gwnavgeneration/input/inputtilecontributionatpos.h"
#include "gwnavgeneration/input/inputcellinfogrid.h"
#include "gwnavgeneration/generator/igeneratorglue.h"
#include "gwnavgeneration/generator/generatorblobtyperegistry.h"
#include "gwnavgeneration/generator/generatorguidcompound.h"
#include "gwnavgeneration/generator/generatorsector.h"
#include "gwnavgeneration/generator/generatorsystem.h"
#include "gwnavgeneration/input/clientinputconsumer.h"
#include "gwnavgeneration/input/generatorinputproducer.h"
#include "gwnavgeneration/generator/generatorinputoutput.h"
#include "gwnavgeneration/generator/generatorreport.h"
#include "gwnavgeneration/generator/generatorsectorbuilder.h"


namespace Kaim
{

class IParallelForInterface;
class CollisionInterfaceFactory;
class NavMeshElementBlob;
class GeneratorSectorBuilder;
class GeneratorNavDataElement;


class Generator : public RefCountBaseNTS<Generator, MemStat_NavDataGen>
{
    KY_DEFINE_NEW_DELETE_OPERATORS(Stat_Default_Mem)

friend class NavDataIndexBlobBuilder_FromGenerator;

public:
    Generator(Ptr<GeneratorInputProducer> producer, 
              Ptr<IParallelForInterface> parallelForInterface = KY_NULL, 
              Ptr<ITlsAlloc> tlsAlloc = KY_NULL,
              Ptr<ICollisionInterface> visibilityInterface = KY_NULL);

    Generator(Ptr<GeneratorInputProducer> producer, Ptr<IGeneratorGlue> generatorGlue);

    ~Generator();

public:
    // ------------------------------ Configuration ------------------------------
    
    void SetFileOpener(FileOpenerBase* fileOpener);

    void SetOutputDirectory(const char* absoluteOutputBaseDir, const char* relativeOutputDir);

    const String& GetAbsoluteOutputDirectory() const { return m_sys.GetAbsoluteOutputDirectory(); }

    // ---------------------------------- Generation ----------------------------------

    KyResult Generate(GeneratorInputOutput& config);

    // ---------------------------------- Reporting ----------------------------------

    template <class OSTREAM> void LogConfiguration(OSTREAM& os);

    const GeneratorReport& GetGeneratorReport() const { return m_report; }

    const GeneratorProfiling& GetGeneratorProfiling() const { return m_generatorProfiling; }
    
    // ---------------------------------- Internal Access Only ----------------------------------

    GeneratorSystem& Sys() { return m_sys; }
    const KyArray<Ptr<GeneratorSectorBuilder> >& GetSectorBuilders() const { return m_sectorBuilders; }

private:
    void ClearGeneratedData();
    void ClearSectors();

    KyResult AddSector(Ptr<GeneratorSector> sector);

    void Init(Ptr<IParallelForInterface> parallelFor, Ptr<ITlsAlloc> tlsAlloc, Ptr<ICollisionInterface> visibilityInterface);
    
    KyResult GenerateInit(GeneratorInputOutput& generatorInputOutput);
    bool CheckUserConfig(const GeneratorParameters& config) const;
    bool CheckSysConfig() const;

    KyResult GenerateNavData();
    KyResult ProduceSectorInputs();
    void MakeGlobalGrid();
    void MakeNavDataElements();
    KyResult GenerateRawNavCells();
    KyResult PerformSeedOrSurfaceFiltering();
    KyResult PerformIntegrationOfTagvolumes();
    KyResult MakeOutputBlobAggregates();
    void ComputeStatistics();
    KyResult BuildOutputDataIndex();
    KyResult UpdateAndSaveGeneratorInputOutput();

    void AddInputCellInfosContributingToSingleGuid(
        KyUInt32 mainIdx, const InputCellInfoArrayAtPos* inputCellInfoArrayAtPos, InputCellInfoArrayAtPos* contributingInputCellInfoArrayAtPos);

    bool IsGuidCompoundExclusive(const GeneratorGuidCompound& guidCompound) const;
    void UpdateGeneratorInputOutput();
    KyResult SaveGeneratorInputOutput();
    KyResult SaveDatabaseDescriptorIndex();

    KyResult ProduceSectorInputs_FromChangedPatchs();
    KyResult ProduceSectorInputs_FromSectorsOverlappingWithChangedPatches();
    KyResult ProduceSectorInputs_FromChangedSectors();
    KyResult ProduceSectorInputs_FromSectorsOverlappingWithChangedRegularSectors();

    void MakeNavDataElementsAtCellPos(const InputCellInfoArrayAtPos* cellsAtPos);
    void RemoveInputTilesTempDir();

    KyResult MakeAbstractGraphs();

public: //internal
    void RemoveInputTilesPartTempDir();
    
private:
    Ptr<GeneratorInputProducer> m_producer;
    Ptr<IGeneratorGlue> m_generatorGlue; // Ptr stored so that the passed glue is not deleted while being used
    GeneratorSystem m_sys;
    DefaultFileOpener m_defaultFileOpener;
    KyArray<Ptr<GeneratorSectorBuilder> > m_sectorBuilders;
    GeneratorSectorList m_sectorList;
    InputCellInfoGrid m_inputCellGrid;
    KyArray<GeneratorGuidCompound> m_exclusiveGuids;
    GeneratorReport m_report;
    GeneratorProfiling m_generatorProfiling;
    KyArray<CellPos> m_patchedCellPositions;
};


template <class OSTREAM>
inline void Generator::LogConfiguration(OSTREAM& os)
{
    os << KY_LOG_BIG_TITLE_BEGIN("", "Generator Configuration Info");

    os << m_sys;
    os << m_sys.Config();
    os << m_sys.RunOptions();

    for (KyUInt32 sectorIdx = 0; sectorIdx < m_sectorBuilders.GetCount(); ++sectorIdx)
    {
        os << KY_LOG_SMALL_TITLE_BEGIN("", "Sector " << sectorIdx <<" Info");
        m_sectorBuilders[sectorIdx]->LogConfiguration(os);
        os << KY_LOG_SMALL_TITLE_END("", "Sector " << sectorIdx <<" Info");
    }

    os << KY_LOG_BIG_TITLE_END("", "Generator Configuration Info");
}


}


#endif