xnano.effects

def evaluate(self, context: EvaluationContext) -> ValueType_co:
    """
    Compute the expression's value.

    Examples:
        ```python
        from xnano_core._xnano_core import _reference

        width = _reference('Width', 'numeric_property')
        context = EvaluationContext(buffer=Buffer(width=5, height=1))
        assert (width * 2).evaluate(context) == 10
        ```
    """

def then(self, other: Operation) -> Operation:
    """
    An operation that applies this operation, then ``other``.

    Examples:
        ```python
        buffer = Buffer(width=6, height=1)
        buffer.update(Write('ab').then(Write('c', x=2)))
        assert buffer.text.startswith('abc')
        ```
    """

def when(self, condition: Predicate) -> Operation:
    """
    An operation that applies only while ``condition`` is true.

    Examples:
        ```python
        from xnano_core._xnano_core import _reference

        width = _reference('Width', 'numeric_property')
        buffer = Buffer(width=6, height=1)
        buffer.update(Write('wide').when(width > 4))
        assert buffer.text.startswith('wide')
        ```
    """

def __or__(self, other: Operation) -> Operation:
    """
    Combine this operation with ``other`` so both run in sequence.

    Examples:
        ```python
        buffer = Buffer(width=6, height=1)
        buffer.update(Write('ab') | Write('c', x=2))
        assert buffer.text.startswith('abc')
        ```
    """

def evaluate(self, context: EvaluationContext) -> ValueType_co:
    """
    Compute the expression's value.

    Examples:
        ```python
        from xnano_core._xnano_core import _reference

        width = _reference('Width', 'numeric_property')
        context = EvaluationContext(buffer=Buffer(width=5, height=1))
        assert (width * 2).evaluate(context) == 10
        ```
    """

def then(self, other: Operation) -> Operation:
    """
    An operation that applies this operation, then ``other``.

    Examples:
        ```python
        buffer = Buffer(width=6, height=1)
        buffer.update(Write('ab').then(Write('c', x=2)))
        assert buffer.text.startswith('abc')
        ```
    """

def when(self, condition: Predicate) -> Operation:
    """
    An operation that applies only while ``condition`` is true.

    Examples:
        ```python
        from xnano_core._xnano_core import _reference

        width = _reference('Width', 'numeric_property')
        buffer = Buffer(width=6, height=1)
        buffer.update(Write('wide').when(width > 4))
        assert buffer.text.startswith('wide')
        ```
    """

def __or__(self, other: Operation) -> Operation:
    """
    Combine this operation with ``other`` so both run in sequence.

    Examples:
        ```python
        buffer = Buffer(width=6, height=1)
        buffer.update(Write('ab') | Write('c', x=2))
        assert buffer.text.startswith('abc')
        ```
    """

@staticmethod
def evolve(
    symbols: EvolveSymbolSet | Expression[str] | None = None,
    *,
    style: Style | DynamicStyle | None = None,
    duration_milliseconds: int | Expression[int | float] | None = None,
    interpolation: str | Expression[str] | None = None,
) -> Effect:
    """
    Step every cell through a set of symbols, from empty to full.

    Maps to [`tachyonfx::fx::evolve`](https://docs.rs/tachyonfx/0.25.2/tachyonfx/fx/fn.evolve.html).

    Args:
        symbols: The symbol set; ``'circles'`` by default.
        style: A style applied to the symbols.
        duration_milliseconds: How long the effect lasts.
        interpolation: The easing curve.

    Examples:
        ```python
        effect = Effect.evolve('shaded', duration_milliseconds=200)
        assert effect.kind == 'evolve'
        ```
    """

@staticmethod
def evolve_into(
    symbols: EvolveSymbolSet | Expression[str] | None = None,
    *,
    style: Style | DynamicStyle | None = None,
    duration_milliseconds: int | Expression[int | float] | None = None,
    interpolation: str | Expression[str] | None = None,
) -> Effect:
    """
    Step cells through a set of symbols until the content underneath shows.

    Maps to [`tachyonfx::fx::evolve_into`](https://docs.rs/tachyonfx/0.25.2/tachyonfx/fx/fn.evolve_into.html).
    Takes the same arguments as [`evolve`][xnano_core._xnano_core.Effect.evolve].
    """

@staticmethod
def evolve_from(
    symbols: EvolveSymbolSet | Expression[str] | None = None,
    *,
    style: Style | DynamicStyle | None = None,
    duration_milliseconds: int | Expression[int | float] | None = None,
    interpolation: str | Expression[str] | None = None,
) -> Effect:
    """
    Step cells through a set of symbols, starting from the content underneath.

    Maps to [`tachyonfx::fx::evolve_from`](https://docs.rs/tachyonfx/0.25.2/tachyonfx/fx/fn.evolve_from.html).
    Takes the same arguments as [`evolve`][xnano_core._xnano_core.Effect.evolve].
    """

@staticmethod
def expand(
    direction: Literal['horizontal', 'vertical'] | Expression[str] | None = None,
    *,
    style: Style | DynamicStyle | None = None,
    duration_milliseconds: int | Expression[int | float] | None = None,
    interpolation: str | Expression[str] | None = None,
) -> Effect:
    """
    Grow a style outward from the center, horizontally or vertically.

    Maps to [`tachyonfx::fx::expand`](https://docs.rs/tachyonfx/0.25.2/tachyonfx/fx/fn.expand.html).

    Examples:
        ```python
        effect = Effect.expand('vertical', duration_milliseconds=200)
        assert effect.kind == 'expand'
        ```
    """

@staticmethod
def stretch(
    direction: Literal['left_to_right', 'right_to_left', 'up_to_down', 'down_to_up']
    | Expression[str]
    | None = None,
    *,
    style: Style | DynamicStyle | None = None,
    duration_milliseconds: int | Expression[int | float] | None = None,
    interpolation: str | Expression[str] | None = None,
) -> Effect:
    """
    Stretch a style across the area in a direction.

    Maps to [`tachyonfx::fx::stretch`](https://docs.rs/tachyonfx/0.25.2/tachyonfx/fx/fn.stretch.html).

    Examples:
        ```python
        effect = Effect.stretch('up_to_down', duration_milliseconds=200)
        assert effect.kind == 'stretch'
        ```
    """

@staticmethod
def explode(
    *,
    force: float | Expression[int | float] | None = None,
    randomness: float | Expression[int | float] | None = None,
    duration_milliseconds: int | Expression[int | float] | None = None,
    interpolation: str | Expression[str] | None = None,
) -> Effect:
    """
    Blow the cells outward and away.

    Maps to [`tachyonfx::fx::explode`](https://docs.rs/tachyonfx/0.25.2/tachyonfx/fx/fn.explode.html).

    Args:
        force: How hard the cells are thrown; 10 by default.
        randomness: How much the force varies from cell to cell; 3 by default.
        duration_milliseconds: How long the effect lasts; 800 by default.
        interpolation: The easing curve.

    Examples:
        ```python
        effect = Effect.explode(force=5.0)
        assert effect.kind == 'explode'
        ```
    """

def translated(
    self,
    /,
    *,
    x: int | Expression[int | float] | None = None,
    y: int | Expression[int | float] | None = None,
    duration_milliseconds: int | Expression[int | float] | None = None,
    interpolation: str | Expression[str] | None = None,
) -> Effect:
    """
    Move everything this effect draws by an offset over time.

    Maps to [`tachyonfx::fx::translate`](https://docs.rs/tachyonfx/0.25.2/tachyonfx/fx/fn.translate.html).

    Args:
        x: Columns to move by.
        y: Rows to move by.
        duration_milliseconds: How long the move lasts; 500 by default.
        interpolation: The easing curve.

    Examples:
        ```python
        effect = Effect.dissolve().translated(y=-2)
        assert effect.kind == 'translate'
        ```
    """

def with_area(self, /, area: Rectangle | Expression[Rectangle]) -> Effect:
    """
    Limit the effect to a rectangle relative to its target.

    An expression is evaluated each frame. Moving or resizing its rectangle
    preserves the effect's elapsed time.

    Maps to [`tachyonfx::fx::dynamic_area`](https://docs.rs/tachyonfx/0.25.2/tachyonfx/fx/fn.dynamic_area.html).

    Args:
        area: Fixed rectangle or expression giving the affected cells.

    Returns:
        A copy of the effect restricted to ``area``.

    Examples:
        >>> effect = Effect.dissolve().with_area(Rectangle(0, 0, 3, 1))
        >>> effect.kind
        'dissolve'
    """

def evaluate(self, context: EvaluationContext) -> ValueType_co:
    """
    Compute the expression's value.

    Examples:
        ```python
        from xnano_core._xnano_core import _reference

        width = _reference('Width', 'numeric_property')
        context = EvaluationContext(buffer=Buffer(width=5, height=1))
        assert (width * 2).evaluate(context) == 10
        ```
    """

def then(self, other: Operation) -> Operation:
    """
    An operation that applies this operation, then ``other``.

    Examples:
        ```python
        buffer = Buffer(width=6, height=1)
        buffer.update(Write('ab').then(Write('c', x=2)))
        assert buffer.text.startswith('abc')
        ```
    """

def when(self, condition: Predicate) -> Operation:
    """
    An operation that applies only while ``condition`` is true.

    Examples:
        ```python
        from xnano_core._xnano_core import _reference

        width = _reference('Width', 'numeric_property')
        buffer = Buffer(width=6, height=1)
        buffer.update(Write('wide').when(width > 4))
        assert buffer.text.startswith('wide')
        ```
    """

def __or__(self, other: Operation) -> Operation:
    """
    Combine this operation with ``other`` so both run in sequence.

    Examples:
        ```python
        buffer = Buffer(width=6, height=1)
        buffer.update(Write('ab') | Write('c', x=2))
        assert buffer.text.startswith('abc')
        ```
    """

@staticmethod
def evolve(
    symbols: EvolveSymbolSet | Expression[str] | None = None,
    *,
    style: Style | DynamicStyle | None = None,
    duration_milliseconds: int | Expression[int | float] | None = None,
    interpolation: str | Expression[str] | None = None,
) -> Effect:
    """
    Step every cell through a set of symbols, from empty to full.

    Maps to [`tachyonfx::fx::evolve`](https://docs.rs/tachyonfx/0.25.2/tachyonfx/fx/fn.evolve.html).

    Args:
        symbols: The symbol set; ``'circles'`` by default.
        style: A style applied to the symbols.
        duration_milliseconds: How long the effect lasts.
        interpolation: The easing curve.

    Examples:
        ```python
        effect = Effect.evolve('shaded', duration_milliseconds=200)
        assert effect.kind == 'evolve'
        ```
    """

@staticmethod
def evolve_into(
    symbols: EvolveSymbolSet | Expression[str] | None = None,
    *,
    style: Style | DynamicStyle | None = None,
    duration_milliseconds: int | Expression[int | float] | None = None,
    interpolation: str | Expression[str] | None = None,
) -> Effect:
    """
    Step cells through a set of symbols until the content underneath shows.

    Maps to [`tachyonfx::fx::evolve_into`](https://docs.rs/tachyonfx/0.25.2/tachyonfx/fx/fn.evolve_into.html).
    Takes the same arguments as [`evolve`][xnano_core._xnano_core.Effect.evolve].
    """