databasegenmetrics.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: JUBA - secondary contact: NOBODY
#ifndef Navigation_DatabaseGenMetrics_H
#define Navigation_DatabaseGenMetrics_H

#include "gwnavruntime/navmesh/worldintegerpos.h"
#include "gwnavruntime/navmesh/navmeshtypes.h"
#include "gwnavruntime/math/box2f.h"
#include "gwnavruntime/basesystem/intcoordsystem.h"
#include "gwnavruntime/basesystem/logger.h"

namespace Kaim
{

class DatabaseGenMetrics
{
    KY_DEFINE_NEW_DELETE_OPERATORS(Stat_Default_Mem)
    KY_CLASS_WITHOUT_COPY(DatabaseGenMetrics)
public:
    DatabaseGenMetrics();
    ~DatabaseGenMetrics();

    // Clears all information maintained by this object. For internal use. 
    void Clear();
    bool IsClear() const;

    // ---------------------------------- Public Member Functions ----------------------------------

    KyFloat32 GetCellSize()                    const; 
    KyFloat32 GetGenerationRadius()            const; 
    KyFloat32 GetGenerationHeight()            const; 
    KyFloat32 GetGenerationAltitudeTolerance() const; 
    KyFloat32 GetPixelSize()                   const; 

    KyInt64   GetNearestInteger64FromFloatValue(KyFloat32 inputValue) const; 
    KyFloat32 GetFloatValueFromInteger64(KyInt64 inputValue)          const; 
    KyFloat32 GetFloatValueFromInteger32(KyInt32 inputValue)          const; 

    CoordPos64 ComputeCellOrigin(const CellPos& cellPos) const; 

    // ---------------------------------- Functions to compute CellPos ----------------------------------

    CellPos ComputeCellPos(const Vec2f& pos) const;

    void ComputeCellPos(const Vec2f& pos, CellPos& cellPos) const;

    CellPos ComputeCellPos(const Vec3f& pos) const;

    void ComputeCellPos(const Vec3f& pos, CellPos& cellPos) const;

    CellPos ComputeCellPosFromCoordPos64(const CoordPos64& coordPos64) const;

    void ComputeCellPosFromCoordPos64(const CoordPos64& coordPos64, CellPos& cellPos) const;

    // ---------------------------------- Conversion from floating-point coordinates to 64 bits integer coordinates ----------------------------------

    CoordPos64 GetCoordPos64FromVec3f(const Vec3f& inputPosition)               const; 
    void GetCoordPos64FromVec3f(const Vec3f& inputPosition, CoordPos64& result) const; 

    CoordPos64 GetCoordPos64FromVec2f(const Vec2f& inputPosition)               const; 
    void GetCoordPos64FromVec2f(const Vec2f& inputPosition, CoordPos64& result) const; 

    // ---------------------------------- Conversion from 64 bits integer coordinates to floating-point coordinates ----------------------------------

    Vec2f GetVec2fFromCoordPos64(const CoordPos64& inputPosition)               const; 
    void GetVec2fFromCoordPos64(const CoordPos64& inputPosition, Vec2f& result) const; 

    // ---------------------------------- Conversion from floating-point coordinates to WorldIntegerPos coordinates ----------------------------------

    WorldIntegerPos GetWorldIntegerPosFromVec2f(const Vec2f& inputPosition)               const; 
    void GetWorldIntegerPosFromVec2f(const Vec2f& inputPosition, WorldIntegerPos& result) const; 

    WorldIntegerPos GetWorldIntegerPosFromVec3f(const Vec3f& inputPosition)               const; 
    void GetWorldIntegerPosFromVec3f(const Vec3f& inputPosition, WorldIntegerPos& result) const; 

    // ---------------------------------- Conversion from WorldIntegerPos coordinates to floating-point coordinates ----------------------------------

    Vec2f GetVec2fFromWorldIntegerPos(const WorldIntegerPos& inputPosition)               const; 
    void GetVec2fFromWorldIntegerPos(const WorldIntegerPos& inputPosition, Vec2f& result) const; 

    // ---------------------------------- CoordPos64 <-> WorldIntegerPos Conversion ----------------------------------

    WorldIntegerPos GetWorldIntegerPosFromCoordPos64(const CoordPos64& inputPosition)               const; 
    void GetWorldIntegerPosFromCoordPos64(const CoordPos64& inputPosition, WorldIntegerPos& result) const; 

    CoordPos64 GetCoordPos64FromWorldIntegerPos(const WorldIntegerPos& inputPosition)               const; 
    void GetCoordPos64FromWorldIntegerPos(const WorldIntegerPos& inputPosition, CoordPos64& result) const; 

    // ---------------------------------- CellBox computation ----------------------------------

    void GetCellBoxOfAnAABBox(const Box2f& aABB     , CellBox& cellBox) const; 
    void GetCellBoxOfAnAABBox(const Box3f& aABB     , CellBox& cellBox) const; 
    void GetCellBoxOfAnAABBox(const CoordBox64& aABB, CellBox& cellBox) const; 

public: //internal
    void SetDefaultValues();
    KyFloat32 SnapFloatOnIntegerGrid(KyFloat32 inputValue) const;
    KyInt32 SnapFloatOnPixelGrid(KyFloat32 inputValue) const;
    KyInt64 ComputeCellPosXFromInteger64(KyInt64 x) const;
    KyInt64 ComputeCellPosYFromInteger64(KyInt64 y) const;

public: // internal
    
    void Setup(); 

public: // internal
    
    // ---------------------------------- Members to be initialized before calling Setup() ----------------------------------

    KyFloat32 m_generationRadius;    
    KyFloat32 m_generationHeight;    
    KyFloat32 m_altitudeTolerance;   
    KyFloat32 m_integerPrecision;    
    KyInt32 m_cellSizeInPixel;       
    
    // ---------------------------------- Initialized from other members in Setup() ----------------------------------

    KyFloat32 m_integerPrecisionInv; 
    KyFloat32 m_pixelSize;           
    KyInt32 m_cellSizeInCoord;       
};

}

#include "gwnavruntime/database/databasegenmetrics.inl"

#endif //Navigation_DatabaseGenMetrics_H