navmeshtypes.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/math/vec3f.h"
#include "gwnavruntime/math/box2i.h"
#include "gwnavruntime/math/box2ll.h"
#include "gwnavruntime/kernel/SF_Debug.h"

namespace Kaim
{
typedef Vec2LL CoordPos64; 
typedef Box2LL CoordBox64; 

typedef KyInt32 Coord;
typedef Vec2i CoordPos;                            
typedef Box2i CoordBox;                            
static const KyInt32 InvalidCoord = KyInt32MAXVAL; 

typedef KyInt32 PixelCoord;
typedef Vec2i PixelPos;
typedef Box2i PixelBox;
static const KyInt32 InvalidPixelCoord = KyInt32MAXVAL;

typedef KyInt32 CellCoord;                             
typedef Vec2i CellPos;                                 
typedef Box2i CellBox;                                 
static const KyInt32 InvalidCellCoord = KyInt32MAXVAL; 

enum PolygonWinding
{
    POLYGON_IS_CCW,
    POLYGON_IS_CW,
    POLYGON_UNKNOWN_WINDING,
};

enum NavHalfEdgeObstacleType
{
    EDGEOBSTACLETYPE_WALL = 0, 
    EDGEOBSTACLETYPE_HOLE = 1, 
};

enum NavHalfEdgeType
{
    EDGETYPE_CELLBOUNDARY_EAST  = CardinalDir_EAST,  
    EDGETYPE_CELLBOUNDARY_NORTH = CardinalDir_NORTH, 
    EDGETYPE_CELLBOUNDARY_WEST  = CardinalDir_WEST,  
    EDGETYPE_CELLBOUNDARY_SOUTH = CardinalDir_SOUTH, 
    EDGETYPE_FLOORBOUNDARY      = 4,                 
    EDGETYPE_OBSTACLE           = 5,                 
    EDGETYPE_CONNEXBOUNDARY     = 6,                 
    EDGETYPE_PAIRED             = 7,                 
};

KY_INLINE bool IsHalfEdgeACellBoundary(NavHalfEdgeType type)        { return type < EDGETYPE_FLOORBOUNDARY;  }
KY_INLINE bool IsHalfEdgeAFloorOrCellBoundary(NavHalfEdgeType type) { return type < EDGETYPE_OBSTACLE;       }
KY_INLINE bool IsHalfEdgeOnNavFloorBorder(NavHalfEdgeType type)     { return type < EDGETYPE_CONNEXBOUNDARY; }
KY_INLINE bool IsHalfEdgeOnConnexBorder(NavHalfEdgeType type)       { return type < EDGETYPE_PAIRED;         }


// --- vertex Index in the Floor ---

typedef KyUInt16 CompactNavVertexIdx;
static const CompactNavVertexIdx CompactNavVertexIdx_MAXVAL = 0x0FFF; // vertexIndex encoded en 12 bits in NavHalfEdge

typedef KyUInt32 NavVertexIdx;                                                             
static const NavVertexIdx NavVertexIdx_Invalid = (NavVertexIdx)CompactNavVertexIdx_MAXVAL; 

KY_INLINE bool IsNavVertexIdxValid(const NavVertexIdx idx) { return idx < NavVertexIdx_Invalid; }


// --- HalfEdge Index in the Floor ---

typedef KyUInt16 CompactNavHalfEdgeIdx;
static const CompactNavHalfEdgeIdx CompactNavHalfEdgeIdx_MAXVAL = 0x3FFF;  // NavHalfEdgeIdx coded en 14 bits in NavHalfEdge

typedef KyUInt32 NavHalfEdgeIdx; 
static const NavHalfEdgeIdx NavHalfEdgeIdx_Invalid = (NavHalfEdgeIdx)CompactNavHalfEdgeIdx_MAXVAL; 

KY_INLINE bool IsNavHalfEdgeIdxValid(const NavHalfEdgeIdx idx) { return idx < NavHalfEdgeIdx_Invalid; }


// --- Triangle Index in the Floor ---

//WARNING, we call it Idx opposed to NavTrianglePtr, but it is not an Idx in an array
typedef KyUInt16 CompactNavTriangleIdx;
static const CompactNavTriangleIdx CompactNavTriangleIdx_MAXVAL = 0xFFFF;

typedef KyUInt32 NavTriangleIdx; 
static const NavTriangleIdx NavTriangleIdx_Invalid = (NavTriangleIdx)CompactNavVertexIdx_MAXVAL; 

KY_INLINE bool IsNavTriangleIdxValid(const NavTriangleIdx idx) { return idx < NavTriangleIdx_Invalid; }

//WARNING, we call it Idx opposed to NavConnexPtr, but it is not an Idx in an array
typedef KyUInt16 CompactNavConnexIdx;
static const CompactNavConnexIdx CompactNavConnexIdx_MAXVAL = 0xFFFF;

typedef KyUInt32 NavConnexIdx; 
static const NavConnexIdx NavConnexIdx_Invalid = (NavConnexIdx)CompactNavVertexIdx_MAXVAL; 

// --- Floor Index in the Cell ---

typedef KyUInt32 NavFloorIdx; 
static const NavFloorIdx NavFloorIdx_Invalid = KyUInt32MAXVAL; 

KY_INLINE bool IsNavFloorIdxValid(const NavFloorIdx idx) { return idx < NavFloorIdx_Invalid; }

// --- NavCellBlob Index in a NavMeshElement ---

typedef KyUInt32 NavCellIdx; 
static const NavCellIdx NavCellIdx_Invalid = KyUInt32MAXVAL; 

KY_INLINE bool IsNavCellIdxValid(const NavCellIdx idx) { return idx < NavCellIdx_Invalid; }

// --- index of a Cell in the buffer of ActiveData ---

typedef KyUInt32 CellIdxInActiveData;
static const CellIdxInActiveData CellIdxInActiveData_Invalid = 0x0FFFFFFF; // limit NavFloorIdx to 0x0FFFFFFF to be able to store IdxInActiveData and ActiveCellIdx on 32 bits

// --- Id of connected component ---

typedef KyUInt32 ConnectedComponentId;
static const ConnectedComponentId ConnectedComponent_UNDEFINED = KyUInt32MAXVAL;
static const ConnectedComponentId ConnectedComponent_TRAVERSALOPEN = KyUInt32MAXVAL - 1;

// SetBitInMask<bit_idx>(mask) UnSetBitInMask<bit_idx>(mask) IsBitSetInMask<bit_idx>(mask) mask being KyUInt8, KyUInt16 or KyUInt32
// Looks like it's used only in one place (DynamicNavTag), so we may reconsider the usefulness of these functions
#define KY_DEFINE_TEMPLATE_MASK_MANIPULATOR(integerType)                                                                   \
template<int BitIdx> KY_INLINE void SetBitInMask(integerType& mask)   { mask |=  (1 << (integerType)BitIdx); }             \
template<int BitIdx> KY_INLINE void UnSetBitInMask(integerType& mask) { mask &= ~(1 << (integerType)BitIdx); }             \
template<int BitIdx> KY_INLINE bool IsBitSetInMask(integerType mask)  { return (mask & (1 << (integerType)BitIdx)) != 0; } \

KY_DEFINE_TEMPLATE_MASK_MANIPULATOR(KyUInt8)
KY_DEFINE_TEMPLATE_MASK_MANIPULATOR(KyUInt16)
KY_DEFINE_TEMPLATE_MASK_MANIPULATOR(KyUInt32)

// ---
struct DatabaseVisualDetails { enum Enum { Normal  = 0, High = 1, VeryHigh  = 2 }; };

}