com.barrybecker4.game.twoplayer.go.board.elements.position.GoStone Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of bb4-go Show documentation
bb4-games java code.
There is a newer version: 1.6
/** Copyright by Barry G. Becker, 2000-2011. Licensed under MIT License: http://www.opensource.org/licenses/MIT  */
package com.barrybecker4.game.twoplayer.go.board.elements.position;

import com.barrybecker4.game.common.board.GamePiece;
import com.barrybecker4.game.twoplayer.go.board.PositionalScore;
import com.barrybecker4.game.twoplayer.go.board.elements.IGoMember;

/**
 * A GoStone describes the physical marker at a location on the board.
 * It is either a black or white stone.
 *
 * @see GoBoardPosition
 * @author Barry Becker
 */
public class GoStone extends GamePiece implements IGoMember {
    /**
     * The health is a number representing the influence of player1(black).
     * A living black stone has a positive health, while a black stone in poor health
     * has a negative health. The reverse is true for white.
     * the range  is (-1.0 to 1.0)
     */
    private float health_;

    /**
     * If true then the stone is dead and implicitly removed from the board.
     * this can only get set to true at the very end of the game when both players have passed.
     */
    private boolean isDead_;

    /** This structure is used to store a detailed breakdown of this stones score. (for debugging only). */
    private PositionalScore positionalScore_ = null;


    /**
     * create a new go stone.
     * @param player1 true if owned by player1.
     */
    public GoStone( boolean player1)  {
        super( player1, REGULAR_PIECE);
        health_ = 0.0f;
    }

    /** copy constructor */
    protected GoStone(GoStone stone) {
        super(stone);
        this.health_ = stone.health_;
        this.isDead_ = stone.isDead_;
        this.positionalScore_ = stone.positionalScore_;
    }

    /**
     * create a deep copy of this stone
     */
    @Override
    public GoStone copy() {
        return new GoStone(this);
    }

    /**
     * create a new go stone.
     * @param player1 true if owned by player1.
     * @param health health of the group that this stone belongs to.
     */
    public GoStone( boolean player1, float health) {
        super( player1, REGULAR_PIECE);
        health_ = health;
    }


    public void setPositionalScore(PositionalScore s) {
        positionalScore_ = s;
    }

    public void setHealth( float health ) {
        health_ = health;
    }

    public float getHealth() {
        return health_;
    }

    public String getLabel() {
        return this.isOwnedByPlayer1() ? "B" : "W";
    }

    /**
     * @return true if the stone is dead.
     */
    public boolean isDead() {
        return isDead_;
    }

    /**
     * set the dead state of the stone to true.
     * It will now be rendered differently.
     */
    public void setDead(boolean dead) {
        isDead_ = dead;
    }

    /**
     * @return a deep copy of this stone
     * @throws CloneNotSupportedException
     */
    @Override
    public Object clone() throws CloneNotSupportedException {
        return super.clone();
    }

    @Override
    public String getDescription() {
        StringBuilder sb = new StringBuilder( "" );
        //sb.append( type_ );
        sb.append(ownedByPlayer1_ ? "Black" : "White").append("stone");
        if (positionalScore_ != null)  {
            sb.append(positionalScore_.toString(true));
        }

        return sb.toString();
    }

    /**
     *  Print more compactly than super class.
     */
    @Override
    public String toString()  {
        StringBuilder sb = new StringBuilder( "" );
        sb.append( ownedByPlayer1_ ? 'B' : 'W' );

        return sb.toString();
    }
}