MazeLib::Position 構造体

迷路の区画の位置(座標)を定義。 [詳解]

#include <Maze.h>

公開メンバ関数
constexpr	Position ()
	ゼロ初期化のデフォルトコンストラクタ [詳解]
constexpr	Position (const int8_t x, const int8_t y)
	コンストラクタ [詳解]
uint16_t	getIndex () const
	迷路内の区画の一意な通し番号となるIDを取得する [詳解]
Position	operator+ (const Position p) const
	加法 [詳解]
Position	operator- (const Position p) const
	減法 [詳解]
bool	operator== (const Position p) const
	等号 [詳解]
bool	operator!= (const Position p) const
	等号否定 [詳解]
Position	next (const Direction d) const
	自分の引数方向に隣接した区画の Position を返す [詳解]
bool	isInsideOfField () const
	フィールド内かどうかを判定する関数 [詳解]
Position	rotate (const Direction d) const
	座標を回転変換する [詳解]
Position	rotate (const Direction d, const Position center) const
	座標を回転変換する [詳解]
const char *	toString () const
	表示用文字列に変換する [詳解]

静的公開メンバ関数
static Position	getPositionFromIndex (const uint16_t index)
	IDからPositionを作成する関数 [詳解]

公開変数類
union {
struct {
int8_t   x
	迷路区画のx座標成分 [詳解]
int8_t   y
	迷路区画のy座標成分 [詳解]
}
uint16_t   data
	データ全体へのアクセス用 [詳解]
};

静的公開変数類
static constexpr int	SIZE = MAZE_SIZE_MAX * MAZE_SIZE_MAX
	フィールドの区画数。配列確保などで使える。 [詳解]

フレンド
std::ostream &	operator<< (std::ostream &os, const Position p)
	output-stream の表示関数。 ( x, y) の形式 [詳解]

詳解

迷路の区画の位置(座標)を定義。

実体は 16bit の整数。 左下の区画が (0,0) の (x,y) 平面。

+--------+--------+
| (0, 1) | (1, 1) |
+--------+--------+
| (0, 0) | (1, 0) |
+--------+--------+

構築子と解体子

Position() [1/2]

constexpr MazeLib::Position::Position ( )

inlineconstexpr

ゼロ初期化のデフォルトコンストラクタ

: data(0) {}

Position() [2/2]

constexpr MazeLib::Position::Position ( const int8_t  x, const int8_t  y  )

inlineconstexpr

コンストラクタ

引数

x,y

初期化パラメータ

: x(x), y(y) {}

関数詳解

getIndex()

uint16_t MazeLib::Position::getIndex ( ) const

inline

迷路内の区画の一意な通し番号となるIDを取得する

迷路外の区画の場合未定義動作となる。 Position::isInsideOfField() を使って迷路区画内であることを確認すること。

戻り値

uint16_t 通し番号ID

{ return (x << MAZE_SIZE_BIT) | y; }

getPositionFromIndex()

static Position MazeLib::Position::getPositionFromIndex ( const uint16_t  index )

inlinestatic

IDからPositionを作成する関数

引数

index

通し番号 ID

                                                             {
    return {int8_t(index >> MAZE_SIZE_BIT),
            int8_t(index & (MAZE_SIZE_MAX - 1))};
  }

isInsideOfField()

bool MazeLib::Position::isInsideOfField ( ) const

inline

フィールド内かどうかを判定する関数

戻り値

true フィールド内

false フィールド外

                               {
    // return x >= 0 && x < MAZE_SIZE && y >= 0 && y < MAZE_SIZE;
    /* 高速化 */
    return (static_cast<uint8_t>(x) < MAZE_SIZE) &&
           (static_cast<uint8_t>(y) < MAZE_SIZE);
  }

next()

Position MazeLib::Position::next

(

const Direction

d

)

const

自分の引数方向に隣接した区画の Position を返す

引数

d

隣接方向

戻り値

隣接区画の座標

                                               {
  switch (d) {
    case Direction::East:
      return Position(x + 1, y);
    case Direction::NorthEast:
      return Position(x + 1, y + 1);
    case Direction::North:
      return Position(x, y + 1);
    case Direction::NorthWest:
      return Position(x - 1, y + 1);
    case Direction::West:
      return Position(x - 1, y);
    case Direction::SouthWest:
      return Position(x - 1, y - 1);
    case Direction::South:
      return Position(x, y - 1);
    case Direction::SouthEast:
      return Position(x + 1, y - 1);
    default:
      MAZE_LOGE << d << std::endl;
      return *this;
  }
}

呼び出し関係図:

operator!=()

bool MazeLib::Position::operator!= ( const Position  p ) const

inline

等号否定

                                          {
    // return x != p.x || y != p.y;
    return data != p.data;  //< 高速化
  }

operator+()

Position MazeLib::Position::operator+ ( const Position  p ) const

inline

加法

                                             {
    return Position(x + p.x, y + p.y);
  }

呼び出し関係図:

operator-()

Position MazeLib::Position::operator- ( const Position  p ) const

inline

減法

                                             {
    return Position(x - p.x, y - p.y);
  }

呼び出し関係図:

operator==()

bool MazeLib::Position::operator== ( const Position  p ) const

inline

等号

                                          {
    // return x == p.x && y == p.y;
    return data == p.data;  //< 高速化
  }

rotate() [1/2]

Position MazeLib::Position::rotate

(

const Direction

d

)

const

座標を回転変換する

引数

d	回転角度, 4方位のみ

戻り値

変換後の位置

                                                 {
  switch (d) {
    case Direction::East:
      return Position(x, y);
    case Direction::North:
      return Position(-y, x);
    case Direction::West:
      return Position(-x, -y);
    case Direction::South:
      return Position(y, -x);
    default:
      MAZE_LOGE << d << std::endl;
      return *this;
  }
}

呼び出し関係図:

rotate() [2/2]

Position MazeLib::Position::rotate ( const Direction  d, const Position  center  ) const

inline

座標を回転変換する

引数

d	回転角度, 4方位のみ
center	回転中心座標

戻り値

変換後の位置

                                                                  {
    return center + (*this - center).rotate(d);
  }

呼び出し関係図:

toString()

const char* MazeLib::Position::toString ( ) const

inline

表示用文字列に変換する

                               {
    static char str[32];
    snprintf(str, sizeof(str), "(%02d, %02d)", x, y);
    return str;
  }

フレンドと関連関数の詳解

operator<<

std::ostream& operator<< ( std::ostream &  os, const Position  p  )

friend

output-stream の表示関数。 ( x, y) の形式

                                                         {
  return os << "( " << std::setw(2) << +p.x << ", " << std::setw(2) << +p.y
            << ")";
}

メンバ詳解

union { ... }

data

uint16_t MazeLib::Position::data

データ全体へのアクセス用

SIZE

constexpr int MazeLib::Position::SIZE = MAZE_SIZE_MAX * MAZE_SIZE_MAX

staticconstexpr

フィールドの区画数。配列確保などで使える。

x

int8_t MazeLib::Position::x

迷路区画のx座標成分

y

int8_t MazeLib::Position::y

迷路区画のy座標成分

---

この構造体詳解は次のファイルから抽出されました:

• include/MazeLib/Maze.h
• src/Maze.cpp