clientinputconsumer.h

Go to the documentation of this file.

/*
* Copyright 2015 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.
*/


// primary contact: GUAL - secondary contact: LASI
#ifndef GwNavGen_ClientInputConsumer_H
#define GwNavGen_ClientInputConsumer_H

#include "gwnavgeneration/input/taggedtriangle3i.h"
#include "gwnavruntime/math/box3f.h"
#include "gwnavgeneration/input/clientinput.h"
#include "gwnavgeneration/input/clientinputchunk.h"
#include "gwnavgeneration/input/clientinputtagvolume.h"
#include "gwnavruntime/collision/indexedmesh.h"
#include "gwnavruntime/collision/heightfield.h"
#include "gwnavruntime/world/tagvolume.h"

namespace Kaim
{

class GeneratorSystem;
class SpatializedSectorInput;
class SectorInputData;
class GeneratorSector;
class GeneratorInputProducer;


// interesting statistics, can be used to check if there was a OneMeter problem
class ClientInputConsumerStatistics
{
    KY_DEFINE_NEW_DELETE_OPERATORS(Stat_Default_Mem)
public:
    ClientInputConsumerStatistics() { Clear(); }

    void Clear()
    {
        m_nbConsumedTriangles = 0;
        m_consumedSurface2d = 0;
        m_nbConsumedVolumes = 0;
    }

    KyUInt32 GetNbConsumedTriangles()               { return m_nbConsumedTriangles; }
    KyFloat32 GetConsumedSurface2d()                { return m_consumedSurface2d; }
    KyFloat32 GetAverageConsumedTriangleSurface2d() { return m_consumedSurface2d / (KyFloat32)m_nbConsumedTriangles; }
    void GetConsumedTrianglesBoundingBox(Box3f& box) { box = m_consumedTrianglesBoundingBox; }

public:
    KyInt32 m_nbConsumedTriangles;
    KyFloat32 m_consumedSurface2d;
    Box3f m_consumedTrianglesBoundingBox;
    KyUInt32 m_nbConsumedVolumes;
};

class ClientInputConsumer
{
    KY_DEFINE_NEW_DELETE_OPERATORS(MemStat_NavData)
    friend class GeneratorSectorBuilder;
    friend class SectorInputData;

public:
    // ClientInputConsumer will initialize
    // seedPoints       with what is passed to ConsumeSeedPoint()
    // inputMeshBuilder with what is passed to ConsumeTriangle...()
    // indexedMeshes    with what is passed to ConsumeIndexedMesh()
    // heightfield      with what is passed to ConsumeHeightfield()
    ClientInputConsumer(GeneratorSystem* sys, Ptr<GeneratorSector> sector, KyArray<Vec3f>* seedPoints, KyArray<TagVolumeInitConfig>* tagVolumeConfigs,
        IndexedMeshBlobBuilder* inputMeshBuilder, KyArray<Ptr<IndexedMesh> >* indexedMeshes, Ptr<HeightField>* heightfield);

    ~ClientInputConsumer();

public:
    // ---------------------------------- Consumption ----------------------------------

    KyResult ConsumeTriangle(const Vec3f& A, const Vec3f& B, const Vec3f& C);
    
    KyResult ConsumeTriangle(const Vec3f& client_A, const Vec3f& client_B, const Vec3f& client_C, const CoordSystem& clientCoordSystem);

    KyResult ConsumeTriangle(const Vec3f& A, const Vec3f& B, const Vec3f& C, const DynamicNavTag& navTag);
    
    KyResult ConsumeTriangle(
        const Vec3f& client_A, const Vec3f& client_B, const Vec3f& client_C, const DynamicNavTag& navTag, const CoordSystem& clientCoordSystem);

    KyResult ConsumeTagVolume(const ClientInputTagVolume& inputTagVolume);

    KyResult ConsumeSeedPoint(const Vec3f& position);

    KyResult ConsumeSeedPointInClientCoordinates(const Vec3f& client_position, const CoordSystem& clientCoordSystem) { return ConsumeSeedPoint(clientCoordSystem.ClientToNavigation_Pos(client_position)); }

    KyResult ConsumeHeightField(Ptr<HeightField> heightfield);
    KyResult ConsumeHeightFieldFile(const String& heightfieldFileName);

    KyResult ConsumeIndexedMesh(Ptr<IndexedMesh> indexedMesh);
    KyResult ConsumeIndexedMeshFile(const String& indexedMeshFileName);
    ClientInputConsumerStatistics& GetStats() { return m_stats; }

    VisualColor GetNavTagColor(const DynamicNavTag& dynamicNavTag) const;
public : // Deprecated:
    KY_DEPRECATED(VisualColor GetNavTagVisualColor(const DynamicNavTag& dynamicNavTag) const) { return GetNavTagColor(dynamicNavTag); }

private: 
    void Flush();
    KyResult SaveClientInput(const String& fullFileName);
    KyResult FlushClientInput();
    void TestWarningOnLowMemoryModeNbTriangles();
    bool IsTriangleSlopeWalkable(const Vec3f& A, const Vec3f& B, const Vec3f& C);

public:
    ClientInputConsumerStatistics m_stats; 
    GeneratorSystem* m_sys; 
    
private: // ---------------------------------- Internal ----------------------------------
    Ptr<GeneratorSector> m_sector;  

    // computed (or read) directly from m_sys->m_genIO->m_params
    DynamicNavTag m_defaultNavTag;    
    bool m_backFaceTrianglesWalkable; 
    KyFloat32 m_cosSlopeMax;          

    DynamicClientInputChunk m_dynamicClientInputChunk; 
    KyUInt32 m_clientInputFlushCount;                  

    KyUInt32 m_maxTriangleCountBeforeFlush; 
    KyUInt32 m_warnOnLowMemoryModeNbTriangles;

    SpatializedSectorInput* m_spatializedSectorInput; 
    KyArray<Vec3f>* m_seedPoints;                     
    KyArray<TagVolumeInitConfig>* m_tagVolumeConfigs;

    KyArray<Vec3f> m_inputTriangles;    
    KyArray<Vec3f> m_childrenTriangles; 

    IndexedMeshBlobBuilder* m_inputMeshBuilder;
    KyArray<Ptr<IndexedMesh> >* m_indexedMeshes; 
    Ptr<HeightField>*           m_heightfield;   
};



inline KyResult ClientInputConsumer::ConsumeTriangle(const Vec3f& A, const Vec3f& B, const Vec3f& C)
{
    return ConsumeTriangle(A, B, C, m_defaultNavTag);
}

inline KyResult ClientInputConsumer::ConsumeTriangle(const Vec3f& client_A, const Vec3f& client_B, const Vec3f& client_C, const CoordSystem& clientCoordSystem)
{
    return ConsumeTriangle(client_A, client_B, client_C, m_defaultNavTag, clientCoordSystem);
}


}


#endif