generatorinputoutput.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 "gwnavgeneration/generator/generatorsectorlist.h"
#include "gwnavgeneration/generator/generatorparameters.h"
#include "gwnavgeneration/generator/generatorabstractgraphparameters.h"
#include "gwnavgeneration/generator/generatorrunoptions.h"
#include "gwnavgeneration/generator/generatorguidcompound.h"
#include "gwnavruntime/abstractgraph/blobs/abstractdataindex.h"
#include "gwnavruntime/collision/collisiondataindex.h"
#include "gwnavruntime/base/endianness.h"
#include "gwnavruntime/base/types.h"
#include "gwnavruntime/base/memory.h"
#include "gwnavruntime/kernel/SF_String.h"
#include "gwnavruntime/base/fileopener.h"
#include "gwnavruntime/navdata/navdataindex.h"
#include "gwnavruntime/navdata/databasedescriptor.h"
#include "gwnavruntime/basesystem/coordsystem.h"

namespace Kaim
{

class GeneratorInputOutput : public RefCountBaseNTS<GeneratorInputOutput, MemStat_NavDataGen>
{
    KY_CLASS_WITHOUT_COPY(GeneratorInputOutput)

public:
    GeneratorInputOutput(); 
    void ShallowCopy(const GeneratorInputOutput& other);
    void DeepCopy(const GeneratorInputOutput& other, GeneratorSector::ClearPointedDataMode clearPointedDataMode);
    void Clear(); 

    // ---------------------------------- Save, Load, Copy, Clear Functions ----------------------------------

    KyResult Save(const char* fullFileName, FileOpenerBase* fileOpener = nullptr) const;

    KyResult Load(const char* fullFileName, FileOpenerBase* fileOpener = nullptr);

    // ---------------------------------- Add/Remove/Set Functions ----------------------------------

    void SetSectorChangeForAllSectors(GenFlags::SectorChange sectorChange);

    void SetInputSourceForAllSectors(GenFlags::SectorInputSource inputSource);

    KyResult AddSector(Ptr<GeneratorSector> sector);

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

    // ---------------------------------- Accessors ----------------------------------
    KyUInt32 GetSectorCount() const; 

    Ptr<GeneratorSector> GetSectorWithIndex(KyUInt32 index);     
    Ptr<GeneratorSector> GetSectorWithName(const char* name);    
    Ptr<GeneratorSector> GetSectorWithGuid(const KyGuid& guid);  

    const Ptr<GeneratorSector> GetSectorWithIndex(KyUInt32 index) const;     
    const Ptr<GeneratorSector> GetSectorWithName(const char* name) const;    
    const Ptr<GeneratorSector> GetSectorWithGuid(const KyGuid& guid) const;  

private:
    void CommonCopy(const GeneratorInputOutput& other);

public:
    GeneratorParameters m_params; //In
    GeneratorAbstractGraphParameters m_abstractGraphParams; //In
    GeneratorRunOptions m_runOptions; //In
    KyArray<GeneratorGuidCompound> m_exclusiveGuids; //In
    GeneratorSectorList m_sectors; // In/Out

    // Out. The info contained in m_navDataIndexHandler is redundant with m_sectors
    // but having a NavDataIndex Blob available allows to load them in a pure runtime environment
    // that does NOT link with gwnavgeneration.lib
    Ptr< BlobHandler<NavDataIndex> > m_navDataIndexHandler;

    // Out. The info contained in m_abstractDataIndexHandler is redundant with m_sectors
    // but having a AbstractDataIndex Blob available allows to load them in a pure runtime environment
    // that does NOT link with gwnavgeneration.lib
    Ptr< BlobHandler<AbstractDataIndex> > m_abstractDataIndexHandler;

    // Out. The info contained in m_colDataIndexHandler is redundant with m_sectors
    // but having a ColDataIndex Blob in GenIO files allows to load them in a pure runtime environment
    // that does not link with gwnavgeneration.lib
    Ptr< BlobHandler<ColDataIndex> > m_colDataIndexHandler;

    // In/Out. contains only an indicative databaseIndex
    DatabaseDescriptor m_databaseDescriptor;
};


}