generatorabstractgraphparameters.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/types.h"
#include "gwnavruntime/blob/blobfieldarray.h"
#include "gwnavgeneration/generator/generatorblobtyperegistry.h"
#include "gwnavruntime/basesystem/logger.h"

namespace Kaim
{

class BlobAggregate;

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

enum AbstractGraphBuildMode
{
    GENERATE_ABSTRACTGRAPHS_DISABLE      = 0, // no abstract graph generated
    GENERATE_ABSTRACTGRAPHS_ENABLE       = 1, // abstract graph generated only for sectors which did change (cf. SECTOR_CHANGED)
    GENERATE_ABSTRACTGRAPHS_FORCE_ENABLE = 2, // abstract graph generated for all sectors even if they didn't change (cf. SECTOR_NOCHANGE)
};

class GeneratorAbstractGraphParameters
{
    KY_DEFINE_NEW_DELETE_OPERATORS(Stat_Default_Mem)
public:
    GeneratorAbstractGraphParameters();
    void Clear();

    void BuildBlob(BlobHandler<GeneratorAbstractGraphParametersBlob>& handler) const;

    KyResult ReadFromAggregate(BlobAggregate& aggregate);

    KyResult ReadBlob(const GeneratorAbstractGraphParametersBlob& blob);

    void SetMode(AbstractGraphBuildMode mode) { m_doGenerateAbstractGraphs = mode; }
    AbstractGraphBuildMode GetMode() const { return (AbstractGraphBuildMode)m_doGenerateAbstractGraphs; }

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

    bool operator==(const GeneratorAbstractGraphParameters& other) const
    {
        return m_doGenerateAbstractGraphs == other.m_doGenerateAbstractGraphs
            && m_extentsInNumberOfCells == other.m_extentsInNumberOfCells
            && m_workingMemorySizeLimit == other.m_workingMemorySizeLimit;
    }

    bool operator!=(const GeneratorAbstractGraphParameters& other) const { return !operator==(other); }

public:
    KyUInt32 m_doGenerateAbstractGraphs; // enum GenerateAbstractGraphs

    KyUInt32 m_extentsInNumberOfCells;

    KyUInt32 m_workingMemorySizeLimit;
};


template <class OSTREAM>
inline OSTREAM& operator<<(OSTREAM& os, GeneratorAbstractGraphParameters& params)
{
    BlobFieldsMapping mapping;
    params.InitBlobFieldsMapping(mapping);

    os << KY_LOG_SMALL_TITLE_BEGIN("", "GeneratorAbstractGraphParameters Info");
    os << mapping;
    os << KY_LOG_SMALL_TITLE_END("", "GeneratorAbstractGraphParameters Info");
    return os;
}


class GeneratorAbstractGraphParametersBlobBuilder : public BaseBlobBuilder<GeneratorAbstractGraphParametersBlob>
{
public:
    GeneratorAbstractGraphParametersBlobBuilder(const GeneratorAbstractGraphParameters* params)
        : m_params(params)
    {}

private:
    virtual void DoBuild();

    const GeneratorAbstractGraphParameters* m_params;
};

} // namespace Kaim