tt::chess::King::Turn Class Reference

King Turn. More...

#include <chess.hpp>

Inheritance diagram for tt::chess::King::Turn:

Collaboration diagram for tt::chess::King::Turn:

Public Member Functions
	Turn (const Piece *f, const Position &t, const Piece *c=nullptr, Rook::Turn *castling=nullptr, bool p=true)
	Make new King Turn object.
bool	isEqual (const Piece::Turn &) const override
	Compare turns.
virtual void	apply (int mode=0) override
	Apply turn.
virtual void	undo () override
	Undo turn.
virtual std::string	str () const override
	String Turn representation.
Public Member Functions inherited from tt::Piece::Turn
	Turn (const Piece *tpiece, const Position &to, const Piece *cap=nullptr, bool possible=true)
	Construct new Turn object.
Position	to () const
	Position where piece will end up after turn.
Position	from () const
	Position the turn is started at.
const Piece *	piece () const
	Turn Piece.
Piece *	piece ()
	Turn Piece.
const Piece *	capture () const
	Captured piece.
Piece *	capture ()
	Captured piece.
bool	possible () const
	Turn viability.
bool	setPossible (bool c)
	Set the turn viability.
virtual auto	clone () const -> std::decay< decltype(*this)>::type *
	Clone current Turn.

Additional Inherited Members
Protected Attributes inherited from tt::Piece::Turn
Position	t_from
	Turn piece starting position
Position	t_to
	Turn piece finishing position
Piece *	t_piece
	Turn Piece inself
Piece *	t_capture
	Piece that is captured as the resul of turn.
bool	t_possible
	Turn viability.

Detailed Description

King Turn.

Accomodates the Piece::Turn for castling turns

Constructor & Destructor Documentation

Turn()

tt::chess::King::Turn::Turn ( const Piece *  f, const Position &  t, const Piece *  c = nullptr, Rook::Turn *  castling = nullptr, bool  p = true  )

inline

Make new King Turn object.

Parameters

f	King pointer that performs the move
t	target Turn Position
c	captured Piece
castling	Rook object pointer which will perform castling move with f
p	Turn::t_possibe value

~Turn()

virtual tt::chess::King::Turn::~Turn ( )

inlineoverridevirtual

Reimplemented from tt::Piece::Turn.

Member Function Documentation

apply()

virtual void tt::chess::King::Turn::apply ( int  mode = 0 )

overridevirtual

Apply turn.

Applies current turn. Should be reimplemented in child Piece class if it have to do something special on move.

This does the next:

• erase capture() from piece() Board
• move the piece() to to()

You can define unscoped enum and use it with this fucntion to perform different applying logic on demand.

Parameters

mode	optional apply mode parameter

Reimplemented from tt::Piece::Turn.

isEqual()

bool tt::chess::King::Turn::isEqual ( const Piece::Turn &  rhs ) const

overridevirtual

Compare turns.

Should be reimplemented in child Piece class if it's Turn logic differs.

Parameters

rhs	Turn object compare to

Returns

true if rhs turn is the same as current object

Reimplemented from tt::Piece::Turn.

str()

virtual std::string tt::chess::King::Turn::str ( ) const

overridevirtual

String Turn representation.

This function may be redefined in Piece::Turn that inherit from Piece depending on new piece implementation

Returns

string representation of current Turn object

Reimplemented from tt::Piece::Turn.

undo()

virtual void tt::chess::King::Turn::undo ( )

overridevirtual

Undo turn.

Opposite to apply(). Should be reimplemented in child Piece class if it's apply() function does something special on applying.

Reimplemented from tt::Piece::Turn.

---

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

• chess/include/tartan/chess/chess.hpp