tt::chess::King Class Reference

King chess Piece. More...

#include <chess.hpp>

Inheritance diagram for tt::chess::King:

Collaboration diagram for tt::chess::King:

Classes
class	Turn
	King Turn. More...

Public Member Functions
virtual TurnMap	moveMap (int mode=0) const override
	Generic moves.
bool	check () const
	Check if a King is under check.
bool	checkmate () const
	Check if a King is under checkmate.
bool	castled () const
	Has the King object already performed the castling Turn.
	Piece (const Position &pos={1, 1}, Color col=Color::White)
	Construct new Piece.
Public Member Functions inherited from tt::Piece
Color	color () const
	Piece color.
Color	setColor (Color col)
	Set the color.
const Position &	position () const
	Piece Position.
Position &	position ()
	Piece Position.
Position	setPosition (const Position &)
	Set Piece position.
virtual Position	move (const Position &to)
	Move piece.
const Board *	board () const
	Piece board.
Board *	board ()
	Piece board.
Board *	setBoard (Board *b)
	Set Piece Board.
std::size_t	movesMade () const
	Moves count.
std::size_t	turnIndex () const
	Current turn index.
	Piece (const Position &pos={1, 1}, Color col=Color::White)
	Construct new Piece.

Additional Inherited Members
Public Types inherited from tt::Piece
enum class	Color { Black = 0 , White = 1 }
	Piece color. More...
Static Public Member Functions inherited from tt::Piece
static TurnMap	diagonalMoves (const Piece *p)
	Construct diagonal moves TurnMap.
static TurnMap	straightMoves (const Piece *p)
	Construct straight moves (up, down, left, right) TurnMap.
Protected Attributes inherited from tt::Piece
Color	p_color
	Piece color.
Position	p_position
	Piece Position.
Board *	p_board = nullptr
	Piece Board.
std::size_t	p_movesMade = 0
	Turns count Count of turns Piece have made.
std::size_t	p_turnIndex = 0
	Last turn index.

Detailed Description

King chess Piece.

Member Function Documentation

castled()

bool tt::chess::King::castled ( ) const

inline

Has the King object already performed the castling Turn.

Returns

true if King object have done castling already, false otherwise

check()

bool tt::chess::King::check

(

)

const

Check if a King is under check.

Returns

true if King object is under check, false otherwise

checkmate()

bool tt::chess::King::checkmate

(

)

const

Check if a King is under checkmate.

Returns

true if King object is under checkmate, false otherwise

moveMap()

TurnMap tt::chess::King::moveMap ( int  mode = 0 ) const

overridevirtual

Generic moves.

Note

Developer had and intention that You will define unscoped enumeration for mode in Your Board class. It's value will be passed to function and influence it's behaivor in some way.

Parameters

mode	optional mode constant to influence the moveMap() behaivor in child classes.

Returns

TurnMap object filled with Turn objects. May not contain turns that are not possible because of piece placement

Implements tt::Piece.

Piece()

tt::Piece::Piece	(	const Position &	pos = {1,1},
		Color	col = Color::White
	)

Construct new Piece.

Parameters

pos	Piece Position
col	Piece Color

See also

color(), position()

---

The documentation for this class was generated from the following files:

• chess/include/tartan/chess/chess.hpp
• chess/pieces/king/king.cpp