Guidelines

Guidelines

Bases: Dict[float, GuidelineColor], RobTop

Represents guidelines.

Binary

struct Guideline {
    timestamp: f32,
    color: f32,
}

struct Guidelines {
    guidelines_length: u32,
    guidelines: [Guideline; guidelines_length],
}

Source code in gd/api/guidelines.py

class Guidelines(Dict[float, GuidelineColor], RobTop):
    """Represents guidelines.

    Binary:
        ```rust
        struct Guideline {
            timestamp: f32,
            color: f32,
        }

        struct Guidelines {
            guidelines_length: u32,
            guidelines: [Guideline; guidelines_length],
        }
        ```
    """

    def add(self, timestamp: float, color: GuidelineColor = GuidelineColor.DEFAULT) -> None:
        """Adds the guideline described by `timestamp` and `color`.

        Arguments:
            timestamp: The timestamp of the guideline.
            color: The color of the guideline.

        Example:
            ```python
            >>> guidelines = Guidelines()
            >>> guidelines.add(1.0, GuidelineColor.GREEN)
            >>> guidelines
            {1.0: <GuidelineColor.GREEN: 1.0>}
            ```
        """
        self[timestamp] = color

    @classmethod
    def from_robtop(cls, string: str) -> Self:
        color = GuidelineColor

        return cls(
            {timestamp: color(value) for timestamp, value in split_guidelines(string).items()}
        )

    def to_robtop(self) -> str:
        return concat_guidelines({timestamp: color.value for timestamp, color in self.items()})

    @classmethod
    def can_be_in(cls, string: str) -> bool:
        return GUIDELINES_SEPARATOR in string

add(timestamp: float, color: GuidelineColor = GuidelineColor.DEFAULT) -> None

Adds the guideline described by timestamp and color.

Parameters:

Name	Type	Description	Default
timestamp	float	The timestamp of the guideline.	required
color	GuidelineColor	The color of the guideline.	DEFAULT

Example

>>> guidelines = Guidelines()
>>> guidelines.add(1.0, GuidelineColor.GREEN)
>>> guidelines
{1.0: <GuidelineColor.GREEN: 1.0>}

Source code in gd/api/guidelines.py

def add(self, timestamp: float, color: GuidelineColor = GuidelineColor.DEFAULT) -> None:
    """Adds the guideline described by `timestamp` and `color`.

    Arguments:
        timestamp: The timestamp of the guideline.
        color: The color of the guideline.

    Example:
        ```python
        >>> guidelines = Guidelines()
        >>> guidelines.add(1.0, GuidelineColor.GREEN)
        >>> guidelines
        {1.0: <GuidelineColor.GREEN: 1.0>}
        ```
    """
    self[timestamp] = color