rotation.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.
*/

#ifndef Navigation_Rotation_H
#define Navigation_Rotation_H


#include "gwnavruntime/math/vec3f.h"
#include "gwnavruntime/channel/funnel.h"
#include "gwnavruntime/containers/stringstream.h"


namespace Kaim
{

enum RotationDirection
{
    UninitializedRotationDirection, // Default RotationDirection value when not initialized.
    UndefinedRotationDirection,     // The element has no rotation constraints and can turn in both direction.
    Clockwise,                      // The element can turn only clockwise.
    CounterClockwise                // The element can turn only counter clockwise.
};

KY_INLINE bool IsADefinedRotationDirection(RotationDirection rotDir) { return rotDir == Clockwise || rotDir == CounterClockwise; }

KY_INLINE const char* GetRotationDirectionLabel(RotationDirection rotationDirection)
{
    switch (rotationDirection)
    {
    case UninitializedRotationDirection : return "!!!  Not initialized  !!! ";
    case UndefinedRotationDirection     : return "UndefinedRotationDirection";
    case Clockwise                      : return "Clockwise                 ";
    case CounterClockwise               : return "CounterClockwise          ";
    default:
        break;
    }

    return "";
}

KY_INLINE FunnelSide GetFunnelSideFromRotationDirection(RotationDirection rotDir)
{
    return (
    (rotDir == Clockwise       ) ? FunnelRight :
    (rotDir == CounterClockwise) ? FunnelLeft  :
                                   UndefinedFunnelSide);
}


enum IsInTurnRangeResult
{
    InTurnRange,
    SmallTurnRange,
    NearTurnRangeStart,
    NearTurnRangeEnd,
    OutOfTurnRange
};

KY_INLINE void GetTurnRangeResultLabel(const IsInTurnRangeResult result, StringStream& text)
{
    switch (result)
    {
    case InTurnRange:            text << "InTurnRange       ";   break;
    case SmallTurnRange:         text << "SmallTurnRange    ";   break;
    case NearTurnRangeStart:     text << "NearTurnRangeStart";   break;
    case NearTurnRangeEnd:       text << "NearTurnRangeEnd  ";   break;
    case OutOfTurnRange:         text << "OutOfTurnRange    ";   break;
    }
}

IsInTurnRangeResult IsInTurnRange(const Vec2f& entryDir, const Vec2f& exitDir, RotationDirection rotDir, const Vec2f& dir2d, KyFloat32 fullTurnToleranceSin = 0.0f);

} // namespace Kaim

#endif // Navigation_Rotation_H