generatorparameters.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/basesystem/coordsystem.h"
#include "gwnavgeneration/generator/generatoradvancedparameters.h"
#include "gwnavgeneration/input/taggedtriangle3i.h"
#include "gwnavgeneration/generator/generatorblobtyperegistry.h"
#include "gwnavruntime/database/navtag.h"

namespace Kaim
{

class BlobAggregate;
class DatabaseGenMetrics;

class GeneratorNormalizedParameters
{
    KY_DEFINE_NEW_DELETE_OPERATORS(Stat_Default_Mem)

public:
    GeneratorNormalizedParameters();
    void Clear();
    bool IsValid() const;

public:
    KyFloat32 m_normalizedRasterPrecision; // NearestInt(GeneratorParameters::m_entityRadius / GeneratorParameters::m_rasterPrecision)
    KyUInt32 m_cellSizeInPixel;
    KyUInt32 m_entityRadiusInPixel;
    KyUInt32 m_distanceFromWallsInPixel;
    KyUInt32 m_distanceFromHolesInPixel;
    KyFloat32 m_normalizedCellSize;     
    KyFloat32 m_normalizedEntityRadius; 
};


class GeneratorParametersBlob
{
    KY_DEFINE_NEW_DELETE_OPERATORS(Stat_Default_Mem)
    KY_ROOT_BLOB_CLASS(Generator, GeneratorParametersBlob, 0)
    KY_CLASS_WITHOUT_COPY(GeneratorParametersBlob)
public:
    GeneratorParametersBlob() {}
    BlobFieldArray m_fields;
    NavTag m_defaultNavTag;
    Color m_emptyDefaultNavTagColor;
    Color m_nonEmptyDefaultNavTagColor;
    Color m_nonDefaultNavTagColor;
};
inline void SwapEndianness(Endianness::Target e, GeneratorParametersBlob& self)
{
    SwapEndianness(e, self.m_fields);
    SwapEndianness(e, self.m_defaultNavTag);
    SwapEndianness(e, self.m_emptyDefaultNavTagColor);
    SwapEndianness(e, self.m_nonEmptyDefaultNavTagColor);
    SwapEndianness(e, self.m_nonDefaultNavTagColor);
}


class GeneratorParameters
{
    KY_DEFINE_NEW_DELETE_OPERATORS(Stat_Default_Mem)
public:
    // The binary backward compatibility of the GeneratorParameters blob is ensured by its nature (BlobFieldMapping)
    // However, when a parameter is added or renamed its value will be set to the default value (from Ctor)
    // when loading older versions of configs (from older clientInput).
    // This behavior might have some random effects.
    enum { Version = 1 };

public:
    // ------------------------------ Functions -----------------------------

    GeneratorParameters(); 
    void Clear(); 
    void SetDefaultValues() { Clear(); } 

    void SetDefaultNavTag(const KyArrayPOD<KyUInt32>& blindDataArray) { SetDefaultNavTag(blindDataArray.GetDataPtr(), blindDataArray.GetCount()); }
    void SetDefaultNavTag(const KyUInt32* blindDataBuffer, KyUInt32 blindDataCount);
    void SetEmptyDefaultNavTagColor(Color color);
    void SetNonEmptyDefaultNavTagColor(Color color);
    void SetNonDefaultNavTagColor(Color color);

    const DynamicNavTag& GetDefaultNavTag() const { return m_defaultNavTag; }

public: // internal
    void ComputeNormalizedParams();

    // Helper function allowing to transform a genParams to its runtime equivalent
    void ComputeDatabaseGenMetrics(DatabaseGenMetrics& genMetrics) const;

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

    KyResult ReadFromBlobHandler(BlobHandler<GeneratorParametersBlob>& handler) { return ReadFromBlob(*handler.Blob()); }
    KyResult ReadFromAggregate(BlobAggregate& aggregate);

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

    void InitBlobFieldMapping(BlobFieldsMapping& mapping, KyUInt32& version);
    void InitBlobFieldMapping(BlobFieldsMapping& mapping, KyUInt32& version) const;

    KyResult ReadFromBlob(const GeneratorParametersBlob& blob);

public:
    KyFloat32 m_entityHeight;

    KyFloat32 m_entityRadius;

    KyFloat32 m_stepMax;

    KyFloat32 m_slopeMax;

    KyFloat32 m_rasterPrecision;

    KyFloat32 m_cellSize;

    KyFloat32 m_altitudeTolerance;

    GeneratorAdvancedParameters m_advancedParameters;

    // computed in ComputeNormalizedParams(), do not set directly
    GeneratorNormalizedParameters m_normalizedParameters;

private:
    DynamicNavTag m_defaultNavTag;
};


template <class OSTREAM>
inline OSTREAM& operator<<(OSTREAM& os, GeneratorParameters& params)
{
    BlobFieldsMapping mapping;
    KyUInt32 version = 0;
    params.InitBlobFieldMapping(mapping, version);

    os << KY_LOG_SMALL_TITLE_BEGIN("", "GeneratorParameters Info");
    os << mapping;
    // os << m_defaultNavTag;
    os << KY_LOG_SMALL_TITLE_END("", "GeneratorParameters Info");
    return os;
}


class GeneratorParametersBlobBuilder : public BaseBlobBuilder<GeneratorParametersBlob>
{
public:
    GeneratorParametersBlobBuilder(const GeneratorParameters* params) : m_params(params) {}

private:
    virtual void DoBuild();

    const GeneratorParameters* m_params;
};

} // namespace Kaim