generatorsector.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/base/kyguid.h"
#include "gwnavruntime/navdata/navdata.h"
#include "gwnavruntime/base/endianness.h"
#include "gwnavruntime/basesystem/coordsystem.h"
#include "gwnavgeneration/input/clientinputtagvolume.h"
#include "gwnavgeneration/generator/genflags.h"
#include "gwnavruntime/collision/collisiondata.h"

namespace Kaim
{

class GeneratorSectorBlob;
class GeneratorFileSystem;
class BlobFieldsMapping;

class GeneratorSectorRefCountedUserData : public Kaim::RefCountBase<GeneratorSectorRefCountedUserData, Kaim::MemStat_NavDataGen>
{
public:
    virtual const char* GetType() const = 0;

    bool Isa(const char* type) const { return SFstrcmp(GetType(), type) == 0; }

    virtual ~GeneratorSectorRefCountedUserData() {}
};

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

friend class Generator;
friend class GeneratorSectorBuilder;
friend class GeneratorSectorBlobBuilder;
friend class GeneratorSectorListBlob;

public:
    GeneratorSector();
    GeneratorSector(const KyGuid& sectorGuid, const char* sectorName);
    void Clear(); 

    enum ClearPointedDataMode { CLEAR_NONE = 0, CLEAR_NAVDATA = 1, CLEAR_USERDATA = 2, CLEAR_ALL_POINTED_DATA = 3 };
    void ClearPointedData(ClearPointedDataMode clearPointedDataMode);

public:
    const char* GetName() const { return m_sectorName.ToCStr(); } 
    const String& GetNameString() const { return m_sectorName; }  

    const KyGuid& GetGuid() const { return m_sectorGuid; }; 
    String GetGuidString() const; 

    void SetInputSource(GenFlags::SectorInputSource inputSource) { m_inputSource = inputSource; }
    GenFlags::SectorInputSource GetInputSource() const { return (GenFlags::SectorInputSource)m_inputSource; }

    void SetProduceInputMask(GenFlags::ProduceInputMask produceInputMask) { m_produceInputMask = produceInputMask; }
    GenFlags::ProduceInputMask GetProduceInputMask() const { return (GenFlags::ProduceInputMask)m_produceInputMask; }

    void SetSectorChange(GenFlags::SectorChange sectorChange) { m_sectorChange = sectorChange; }
    GenFlags::SectorChange GetSectorChange() const { return (GenFlags::SectorChange)m_sectorChange; }

    void SetClientInputSaveEnabled(bool isClientInputSaveEnabled) { m_isClientInputSaveEnabled = isClientInputSaveEnabled; }
    bool GetClientInputSaveEnabled() const { return m_isClientInputSaveEnabled; }

    void SetColDataBuildMode(GenFlags::SectorColDataBuildMode colDataBuildMode) { m_colDataBuildMode = colDataBuildMode; }
    GenFlags::SectorColDataBuildMode GetColDataBuildMode() const { return (GenFlags::SectorColDataBuildMode)m_colDataBuildMode; }

    void AddInputFileName(const char* inputFileName) { m_inputFileNames.PushBack(String(inputFileName)); }

    void AddInputSeedPoint(const Vec3f& position)    { m_additionalSeedPoints.PushBack(position); }
    void AddInputSeedPointInClientCoordinates(const Vec3f& client_position, const CoordSystem& coordSystem) { AddInputSeedPoint(coordSystem.ClientToNavigation_Pos(client_position)); }

    void AddInputTagVolume(const ClientInputTagVolume& clientInputTagVolume) { m_additionalTagVolumes.PushBack(clientInputTagVolume); }

    bool IsNavDataCellBoxSet() const { return m_navDataCellBox.IsValid(); }

    String GetAbsoluteOutputFileName(const GeneratorFileSystem& fileSystem, const String& extension) const;
    String GetRelativeOutputFileName(const GeneratorFileSystem& fileSystem, const String& extension) const;

    Ptr<NavData> GetNavData() { return m_navData; }

    Ptr<NavData> GetNavDataPatch() { return m_navDataPatch; }

    Ptr<CollisionData> GetColData() { return m_colData; }

    KyResult SaveNavData(const char* filename, FileOpenerBase* fileOpener = nullptr, Endianness::Type endianness = Endianness::LittleEndian);

private:
    void InitBlobFieldsMapping(BlobFieldsMapping& mapping);
    void InitFromBlob(const GeneratorSectorBlob& blob);

public:
    // ---------- High level description of the sector, once these parameters has been set, they must not change. ----------
    KyGuid m_sectorGuid; 
    String m_sectorName; 
    CellBox m_navDataCellBox; 
    bool m_isPatch;         

    // ---------- How to produce the sector generation inputs. These parameters are mostly used in your implementation of GeneratorInputProducer::ProduceSectorInputs() ----------
    // How to produce the inputs. Your derivation of GeneratorInputProducer passed to the Generator constructor has the responsibility to produce inputs.
    // But the following parameters affect the process.
    KyUInt32 m_inputSource; 
    KyUInt32 m_produceInputMask; 
    KyUInt32 m_sectorChange; 
    bool m_isClientInputSaveEnabled; 
    KyUInt32 m_colDataBuildMode; 

    KyArray<String> m_inputFileNames; 
    KyArray<Vec3f> m_additionalSeedPoints; 
    KyArray<ClientInputTagVolume> m_additionalTagVolumes; 
    void* m_userData; 
    Ptr<GeneratorSectorRefCountedUserData> m_refCountedUserData; 

    // ---------- Generation Outputs ----------
    String m_clientInputAbsoluteFileName;  
    String m_navDataAbsoluteFileName;      
    String m_navDataPatchAbsoluteFileName; 
    String m_colDataAbsoluteFileName;      
    Ptr<NavData> m_navData;                
    Ptr<NavData> m_navDataPatch;           
    Ptr<CollisionData> m_colData;          

    // ---------- Previous generation outputs, which are useful for iterative generations ----------
    KyArray<CellPos> m_previousPatchCellPosList; 
    CellBox          m_previousInputCellBox;     
    KyArray<Vec3f>   m_previousSeedPoints;       
};


inline String GeneratorSector::GetGuidString() const
{
    char guidChars[37];
    m_sectorGuid.ToString(guidChars);
    return String(guidChars);
}

}