generatorrunoptions.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_GeneratorRunOptions_H
#define GwNavGen_GeneratorRunOptions_H


#include "gwnavruntime/base/memory.h"
#include "gwnavruntime/basesystem/logger.h"
#include "gwnavruntime/navmesh/navmeshtypes.h"
#include "gwnavruntime/containers/kyarray.h"
#include "gwnavgeneration/generator/generatorvisualdebugoptions.h"
#include "gwnavruntime/kernel/SF_String.h"
#include "gwnavruntime/blob/blobfieldarray.h"
#include "gwnavgeneration/generator/generatorblobtyperegistry.h"
#include "gwnavgeneration/generator/intermediatefilesconfig.h"


namespace Kaim
{

class BlobAggregate;


class GeneratorRunOptionsBlob
{
    KY_DEFINE_NEW_DELETE_OPERATORS(Stat_Default_Mem)
        KY_ROOT_BLOB_CLASS(Generator, GeneratorRunOptionsBlob, 0)
        KY_CLASS_WITHOUT_COPY(GeneratorRunOptionsBlob)
public:
    GeneratorRunOptionsBlob() {}
    BlobFieldArray m_fields;
};
inline void SwapEndianness(Endianness::Target e, GeneratorRunOptionsBlob& self)
{
    SwapEndianness(e, self.m_fields);
}


class GeneratorRunOptions
{
    KY_DEFINE_NEW_DELETE_OPERATORS(Stat_Default_Mem)

public:
    enum { Version = 0 };

public:
    GeneratorRunOptions();
    void Clear(); 
    void SetDefaultValues() { Clear(); } 

    const IntermediateFilesConfig& Intermediates() const { return m_intermediateFiles; }

    IntermediateFilesConfig& Intermediates() { return m_intermediateFiles; }

    void AddCellToBuild(const CellPos& pos) { m_intermediateFiles.Add(pos); }

    bool DoReallyUseMultiCore() const { return m_doMultiCore && !m_intermediateFiles.IsEnabled(); }

    bool DoReallyUseVisualDebug() const { return !DoReallyUseMultiCore() && m_visualDebugOptions.IsActive(); }

    void BuildBlob(BlobHandler<GeneratorRunOptionsBlob>& handler) const;
    KyResult ReadBlob(const GeneratorRunOptionsBlob& blob);
    KyResult ReadFromAggregate(BlobAggregate& aggregate);

    void InitBlobFieldsMapping(BlobFieldsMapping& mapping);
    void InitBlobFieldsMapping(BlobFieldsMapping& mapping) const;

public:
    KyUInt32 m_generationRevision;

    bool m_doSaveGeneratorInputOutput;

    String m_generatorInputOuputSaveFileName;

    bool m_doMultiCore;

    bool m_doWriteNavDataFiles;

    bool m_doWriteColDataFiles;

    bool m_doEnableLimitedMemoryMode;

    KyUInt32 m_limitedMemoryModeTileSizeInNbCells;

    KyUInt32 m_outputFilesEndianness;

    bool m_doUseTlsIfAvailable;

    bool m_doProfile;

    bool m_doLogConfiguration;

    bool m_doLogReport;

    bool m_doLogReportDetails;

    bool m_doLogPerSectorReport;

    bool m_doLogProgress;

    GeneratorVisualDebugOptions m_visualDebugOptions;

    IntermediateFilesConfig m_intermediateFiles;
};

template <class OSTREAM>
inline OSTREAM& operator<<(OSTREAM& os, GeneratorRunOptions& runOptions)
{
    os << KY_LOG_SMALL_TITLE_BEGIN("", "GeneratorRunOptions");

    os << "generationRevision                  : " << runOptions.m_generationRevision                 << Endl;
    os << "doSaveGeneratorInputOutput          : " << runOptions.m_doSaveGeneratorInputOutput         << Endl;
    os << "generatorInputOuputSaveFileName     : " << runOptions.m_generatorInputOuputSaveFileName    << Endl;
    os << "doMultiCore                         : " << runOptions.m_doMultiCore                        << Endl;
    os << "doWriteNavDataFiles                 : " << runOptions.m_doWriteNavDataFiles                << Endl;
    os << "doWriteColDataFiles                 : " << runOptions.m_doWriteColDataFiles                << Endl;
    os << "doEnableLimitedMemoryMode           : " << runOptions.m_doEnableLimitedMemoryMode          << Endl;
    os << "limitedMemoryModeTileSizeInNbCells  : " << runOptions.m_limitedMemoryModeTileSizeInNbCells << Endl;
    os << "outputFilesEndianness               : " << runOptions.m_outputFilesEndianness              << Endl;
    os << "doUseTlsIfAvailable                 : " << runOptions.m_doUseTlsIfAvailable                << Endl;
    os << "doProfile                           : " << runOptions.m_doProfile                          << Endl;
    os << "doLogConfiguration                  : " << runOptions.m_doLogConfiguration                 << Endl;
    os << "doLogReport                         : " << runOptions.m_doLogReport                        << Endl;
    os << "doLogReportDetails                  : " << runOptions.m_doLogReportDetails                 << Endl;
    os << "doLogPerSectorReport                : " << runOptions.m_doLogPerSectorReport               << Endl;
    
    os << KY_LOG_SMALL_TITLE_END("", "GeneratorRunOptions");

    return os;
}


class GeneratorRunOptionsBlobBuilder : public BaseBlobBuilder<GeneratorRunOptionsBlob>
{
public:
    GeneratorRunOptionsBlobBuilder(const GeneratorRunOptions* runOptions) : m_runOptions(runOptions) {}
private:
    virtual void DoBuild();
    const GeneratorRunOptions* m_runOptions;
};


} // namespace Kaim

#endif // GwNavGen_GeneratorRunOptions_H