TileColor ¶

def as_channels(self, bgr: bool = True, float: bool = False) -> np.ndarray:
    """Returns the matching color channels for this `TileColor`.

    The channels are [RGB / BGR] ranging from 0 to [255 (uint8) / 1.0 (float)] depending on the given parameters.

    Args:
        bgr: flag, indicating whether to return color in BGR channel order; otherwise returns RGB
        float: flag, indicating whether to return a floating point color (0.0 - 1.0 per channel)

    Returns:
        the channels
    """
    color = None
    if self == TileColor.NONE:
        color = np.array([255, 100, 255], dtype=np.uint8)
    if self == TileColor.RED:
        color = np.array([0, 0, 255], dtype=np.uint8)
    if self == TileColor.GREEN:
        color = np.array([0, 255, 0], dtype=np.uint8)
    if self == TileColor.ORANGE:
        color = np.array([0, 100, 255], dtype=np.uint8)
    if self == TileColor.BLUE:
        color = np.array([255, 0, 0], dtype=np.uint8)
    if self == TileColor.YELLOW:
        color = np.array([0, 255, 255], dtype=np.uint8)
    if self == TileColor.WHITE:
        color = np.array([255, 255, 255], dtype=np.uint8)

    if color is not None and not bgr:
        color = np.flip(color)

    if color is not None and float:
        color = np.array(color, dtype=np.float) / 255.0

    return color

def as_color(self) -> str:
    """The terminal highlighting codes as string representing this `TileColor`.

    Returns:
        the ansi color
    """
    ansi_color = ''
    if self == TileColor.RED:
        ansi_color = '\033[41m'
    if self == TileColor.GREEN:
        ansi_color = '\033[42;1m'
    if self == TileColor.YELLOW:
        ansi_color = '\033[48;5;191m'
    if self == TileColor.BLUE:
        ansi_color = '\033[44m'
    if self == TileColor.ORANGE:
        ansi_color = '\033[48;5;202m'
    if self == TileColor.WHITE:
        ansi_color = '\033[47m'
    return ansi_color + '  \033[0m'

@staticmethod
def from_string(color: str) -> 'TileColor':
    """Returns the `TileColor` represented by the given string.

    Args:
        color: the color token

    Returns:
        the matching tile color

    Raises:
        ValueError: No `TileColor` found for the given token.
    """
    c = color.lower()
    if c == 'red' or c == 'r':
        return TileColor.RED
    elif c == 'orange' or c == 'o':
        return TileColor.ORANGE
    elif c == 'blue' or c == 'b':
        return TileColor.BLUE
    elif c == 'yellow' or c == 'y':
        return TileColor.YELLOW
    elif c == 'green' or c == 'g':
        return TileColor.GREEN
    elif c == 'white' or c == 'w':
        return TileColor.WHITE
    else:
        raise ValueError("String \'" + color + "\' is not defined as a TileColor.")

def to_string(self) -> str:
    """Converts the color to a human readable string.

    Returns:
        the string repesentation which can be used for logging

    Raises:
        ValueError: The given tile color is not defined.
    """
    if self == TileColor.NONE:
        return "none"
    elif self == TileColor.BLUE:
        return "blue"
    elif self == TileColor.GREEN:
        return "green"
    elif self == TileColor.RED:
        return "red"
    elif self == TileColor.ORANGE:
        return "orange"
    elif self == TileColor.YELLOW:
        return "yellow"
    elif self == TileColor.WHITE:
        return "white"
    else:
        raise ValueError(f"TileColor '{self}' is not defined.")