Orientation.h

/*
 * Gamedev Framework (gf)
 * Copyright (C) 2016-2021 Julien Bernard
 *
 * This software is provided 'as-is', without any express or implied
 * warranty.  In no event will the authors be held liable for any damages
 * arising from the use of this software.
 *
 * Permission is granted to anyone to use this software for any purpose,
 * including commercial applications, and to alter it and redistribute it
 * freely, subject to the following restrictions:
 *
 * 1. The origin of this software must not be misrepresented; you must not
 *    claim that you wrote the original software. If you use this software
 *    in a product, an acknowledgment in the product documentation would be
 *    appreciated but is not required.
 * 2. Altered source versions must be plainly marked as such, and must not be
 *    misrepresented as being the original software.
 * 3. This notice may not be removed or altered from any source distribution.
 */
#ifndef GF_ORIENTATION_H
#define GF_ORIENTATION_H

#include <cstdint>

#include "CoreApi.h"
#include "Vector.h"

namespace gf {
#ifndef DOXYGEN_SHOULD_SKIP_THIS
inline namespace v1 {
#endif

  enum class Orientation : int8_t {
    Center    = -1, 
    North     =  0, 
    NorthEast =  1, 
    East      =  2, 
    SouthEast =  3, 
    South     =  4, 
    SouthWest =  5, 
    West      =  6, 
    NorthWest =  7, 
  };


  GF_CORE_API Vector2f unit(Orientation orientation);

  GF_CORE_API Vector2i displacement(Orientation orientation);

  GF_CORE_API float angle(Orientation orientation);

  GF_CORE_API Orientation orientation(float angle);

  GF_CORE_API Orientation opposite(Orientation orientation);

  GF_CORE_API Orientation orthogonalCW(Orientation orientation);

  GF_CORE_API Orientation orthogonalCCW(Orientation orientation);

  GF_CORE_API Orientation nextCW(Orientation orientation);

  GF_CORE_API Orientation nextCCW(Orientation orientation);

#ifndef DOXYGEN_SHOULD_SKIP_THIS
}
#endif
}


#endif // GF_ORIENTATION_H