Anchor.h

/*
 * Gamedev Framework (gf)
 * Copyright (C) 2016-2017 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.
 *
 * Part of this file comes from SFML, with the same license:
 * Copyright (C) 2007-2015 Laurent Gomila (laurent@sfml-dev.org)
 */
#ifndef GF_ANCHOR_H
#define GF_ANCHOR_H

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

  /**
   * @ingroup graphics
   * @brief An anchor of a box
   *
   * It is used to define the origin in transformable objects. It is also used
   * to compute coordinates for HUD.
   *
   * @sa gf::Transformable, gf::Coordinates
   */
  enum class Anchor {
    TopLeft,      ///< Top-left
    TopCenter,    ///< Top-center
    TopRight,     ///< Top-right
    CenterLeft,   ///< Center-left
    Center,       ///< Center
    CenterRight,  ///< Center-right
    BottomLeft,   ///< Bottom-left
    BottomCenter, ///< Bottom-center
    BottomRight,  ///< Bottom-right
  };

#ifndef DOXYGEN_SHOULD_SKIP_THIS
}
#endif
}

#endif // GF_ANCHOR_H