navhalfedge.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_NavHalfEdge_H
#define Navigation_NavHalfEdge_H

#include "gwnavruntime/navmesh/navmeshtypes.h"

namespace Kaim
{

class NavHalfEdge
{
public:
    NavHalfEdge() {}

    
    NavHalfEdgeType GetHalfEdgeType()   const; 
    NavVertexIdx    GetStartVertexIdx() const; 

    NavHalfEdgeIdx GetPairHalfEdgeIdx() const;

    KyUInt32 GetBoundaryEdgeIdx() const;

    KyUInt32 GetCellBoundaryDir() const;

    NavHalfEdgeIdx GetNextObstacleHalfEdgeIdx() const;

    NavHalfEdgeObstacleType GetHalfEdgeObstacleType() const;

public:
    /*  BitField
        bit  0 - 13 -> 14 bits : The index of the adjoining half-edge. Access through GetPairHalfEdgeIdx() or GetBoundaryEdgeIdx()
        bit 14 - 25 -> 12 bits : StartVertexIdx
        bit 26 - 27 ->  2 bits : unused
        bit      28 ->  1 bit  : NavHalfEdgeObstacleType
        bit 29 - 31 ->  3 bits : NavHalfEdgeType
    */
    KyUInt32 m_edgeData; 
};

KY_INLINE void SwapEndianness(Endianness::Target e, NavHalfEdge& self)
{
    SwapEndianness(e, self.m_edgeData);
}


KY_INLINE NavVertexIdx            NavHalfEdge::GetStartVertexIdx()       const { return (NavVertexIdx)((m_edgeData & 0x03FFC000) >> 14);            }
KY_INLINE NavHalfEdgeType         NavHalfEdge::GetHalfEdgeType()         const { return (NavHalfEdgeType)(m_edgeData >> 29);                        }
KY_INLINE NavHalfEdgeObstacleType NavHalfEdge::GetHalfEdgeObstacleType() const { return (NavHalfEdgeObstacleType)((m_edgeData & 0x10000000) >> 28); }

KY_INLINE CardinalDir NavHalfEdge::GetCellBoundaryDir() const
{
    KY_DEBUG_ASSERTN(IsHalfEdgeACellBoundary(GetHalfEdgeType()) == true,
        ("You must not call this function if the halfEdge is not of type NavHalfEdgeType::CELL_BOUNDARY"));

    return (CardinalDir)(GetHalfEdgeType());
}


KY_INLINE NavHalfEdgeIdx NavHalfEdge::GetPairHalfEdgeIdx() const
{
    KY_DEBUG_ASSERTN(GetHalfEdgeType() == EDGETYPE_PAIRED || GetHalfEdgeType() == EDGETYPE_CONNEXBOUNDARY,
        ("You must not call this function if the halfEdge is not of type NavHalfEdgeType::PAIRED."));

    return (NavHalfEdgeIdx)(m_edgeData & 0x00003FFF);
}

KY_INLINE KyUInt32 NavHalfEdge::GetBoundaryEdgeIdx() const
{
    KY_DEBUG_ASSERTN(IsHalfEdgeAFloorOrCellBoundary(GetHalfEdgeType()) == true,
        ("You must not call this function if the halfEdge is not a boundary edge."));

    return (KyUInt32)(m_edgeData & 0x00003FFF);
}

KY_INLINE NavHalfEdgeIdx NavHalfEdge::GetNextObstacleHalfEdgeIdx() const
{
    KY_DEBUG_ASSERTN(GetHalfEdgeType() == EDGETYPE_OBSTACLE,
        ("You must not call this function if the halfEdge is not of type NavHalfEdgeType::OBSTACLE."));

    return (NavHalfEdgeIdx)(m_edgeData & 0x00003FFF);
}

}

#endif //Navigation_NavHalfEdge_H