NavGenProj.h

Go to the documentation of this file.

/*
* Copyright 2017 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 "labengine/base/filesystem.h"
#include "navgenproj/ProjProduceInputMask.h"
#include "navgenproj/ProjConfig.h"
#include "navgenproj/ProjMirrorOptions.h"
#include "navgenproj/ProjSector.h"
#include "navgenproj/ProjSeedPoint.h"
#include "gwnavgeneration/generator/generator.h"
#include "gwnavruntime/base/kyguid.h"
#include <memory>
#include <string>
#include <vector>

namespace LabEngine
{
class MirroredOBJProducer;
}

namespace Kaim
{

class ProjGeometry;
class ProjTagVolume;
class ProjClientInput;
class ProjMirrorOptions;
class ProjExclusiveGuids;

class NavGenProj
{
public:
    typedef LabEngine::PathUtilsString Path;

    // ------------------------------ Functions -----------------------------

    NavGenProj();
    ~NavGenProj();

    void Clear();

    KyResult Load(const std::string& fileName);

    KyResult Save(const std::string& fileName);

    KyResult Generate(const std::string& forcedOutputBaseDir, const std::string& forcedRelativeOutputDir);

    void SetIterativeRebuildFromGenIOMode(const std::string& genIOFileName) { m_projConfig.m_genIOFileName = genIOFileName; }

    bool IsInIterativeRebuildFromGenIOMode() const { return !m_projConfig.m_genIOFileName.empty(); }

    void AddSector(std::unique_ptr<ProjSector> sector) { m_sectors.push_back(std::move(sector)); }

    KyResult AddTagVolume(const Vec3f* polylinePoints, int pointArraySize, const DynamicNavTag& navTag, float minAltitude, float maxAltitude);

    void AddSeedPoint(float x, float y, float z);

    void AddExclusiveGuids(const KyGuid* guids, KyUInt32 guidsCount);

    void AddSpecificCellToGenerate(int posx, int posy);

    void SetOutputDir(const char* outputBaseDir, const char* relativeOutputDir);

    std::string GetRelativeOutputDir() { return m_outputRelativeDir; }
    std::string GetOutputBaseDir() { return m_outputBaseDir; }

    void     SetDatabaseIndex(KyUInt32 dabaseIndex);
    KyUInt32 GetDatabaseIndex() const;

    void SetConfig(const GeneratorParameters& params, const GeneratorRunOptions& runOptions, const CoordSystem& coordSystem);

    void SetAbstractGraphConfig(const GeneratorAbstractGraphParameters& abstractGraphParams);

    // MirrorOptions is not an SDK feature, this is an option of the NavGenProj to ease demoing/testing of large scale terrains.
    // It emulates large scale terrain by mirroring either one sector and its geometry or only the geometry into this sector.
    // SeedPoint and TagVolume are mirrored as well.
    void AddMirrorOptions(const ProjMirrorOptions& mirrorOptions);

    std::string GetGeometryFileName   (ProjSector* sector, int index) { return GetAbsolutePath(sector->GetGeometryFileName(index).c_str()); }
    std::string GetClientInputFileName(ProjSector* sector, int index) { return GetAbsolutePath(sector->GetClientInputFileName(index).c_str()); }

    int GetSectorCount() const { return (int)m_sectors.size(); }
    ProjSector* GetSector(int index) { return m_sectors[index].get(); }

    int GetSeedPointCount() const;
    const ProjSeedPoint& GetSeedPoint(int index) const;

    // Sets the navGenProj absolute fileName. Used in GetAbsolutePath().
    void SetNavGenProjAbsPath(const std::string& projAbsPath);

    // if path is relative then returns m_navGenProjDirectory/path or return path
    std::string GetAbsolutePath(const std::string& path) const;

    std::string GetGenIOFileName()
    {
        if (m_projConfig.m_genIOFileName.empty())
            return m_projPathStem + ".GenIO";
        return m_projConfig.m_genIOFileName;
    }

public:
    void ClearAllSpecificCellsToGenerate(); // For internal use.

    // Indicates if the NavGenProj is ready for mirroring the geometry which has to be a .obj file,
    // the NavGenProj must contain one and only one sector which contains a ProjMirrorOptions
    bool CanUseMirrorOptions() { return m_sectors.size() == 1 && m_mirrorOptions.m_enabled; }

    bool ReadProjectRoot(XmlNode root);

private:
    bool ReadOutputDir(XmlNode node);
    bool ReadExclusiveSectors(XmlNode node);
    bool ReadSectors(XmlNode node);
    bool ReadSector(XmlNode node);
    bool ReadTagVolumes(XmlNode node);
    bool ReadTagVolume(XmlNode node);
    bool ReadSeedPoints(XmlNode node);
    bool ReadSeedPoint(XmlNode node);

    KyResult GenerateMirroredObj(const std::string& absoluteOutputBaseDir, const std::string& relativeOutputDir);
    KyResult GenerateObj(const std::string& absoluteOutputBaseDir, const std::string& relativeOutputDir);
    KyResult DoGenerate(Kaim::GeneratorInputProducer* producer, const std::string& absoluteOutputBaseDir, const std::string& relativeOutputDir);
    Kaim::Ptr<Kaim::Generator> CreateGenerator(Kaim::Ptr<Kaim::GeneratorInputProducer> producer);
    void InitSectorFromNavGenProj(Kaim::GeneratorSector* sector, const ProjSector* projSector);
    void AddMirroredOBJProducerSeedPointsAndTagVolumes(ProjSector* navGenProjSector, LabEngine::MirroredOBJProducer* producer);
    void GetValidGuid(Kaim::KyGuid& sectorGuid);
    void InitGeneratorInputOutput(Kaim::GeneratorInputOutput& genIO, const std::string& absoluteOutputBaseDir, const std::string& relativeOutputDir);
    KyResult RunGenerator(Kaim::Ptr<Kaim::Generator> generator, Kaim::GeneratorInputOutput& generatorInputOutput, const std::string& absoluteOutputBaseDir,
                          const std::string& relativeOutputDir);

public:
    // sectors, tagVolumes, arrayOfExclusiveSectors, seedPoints
    // are maintained in these vectors instead of the m_navGenProjConfig.m_generatorInputOutput
    std::vector<std::unique_ptr<ProjSector>>           m_sectors;
    std::vector<std::unique_ptr<ProjTagVolume>>        m_tagVolumes;
    std::vector<std::unique_ptr<ProjExclusiveGuids>>   m_arrayOfExclusiveSectors;
    std::vector<ProjSeedPoint>                         m_seedPoints;

    ProjConfig m_projConfig; // content of <config>

    ProjMirrorOptions m_mirrorOptions;

    KyUInt32 m_databaseIndex;

    std::string m_outputBaseDir;      // content of <outputDir><baseDir> that is relative to m_navGenProjDirectory, or absolute
    std::string m_outputRelativeDir;  // content of <outputDir><relativeDir>> that is relative to <outputDir><baseDir>
    std::string m_projAbsDir;         // absolute directory of the NavGenProj file, all files in the navGenProj file are relative to this m_navGenProjDirectory
    std::string m_projPathStem;       // FileName without the directory and without the extension
};
}