Draw Lines Effect

Copyright 2023 Ethan Christensen

Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

class bruhanimate.bruheffect.draw_lines_effect.Line(start_point: tuple[int], end_point: tuple[int])[source]

Bases: object

A line segment defined by two endpoints.

__init__(start_point: tuple[int], end_point: tuple[int])[source]

Initializes a Line with start and end points (doubled for sub-cell rendering).

Parameters:

  • start_point (tuple[int]) – Start point as (x, y).

  • end_point (tuple[int]) – End point as (x, y).

update_points(start_point: tuple[int], end_point: tuple[int])[source]

Updates the line’s start and end points.

Parameters:

  • start_point (tuple[int]) – New start point as (x, y).

  • end_point (tuple[int]) – New end point as (x, y).

get_points()[source]

Returns the start and end points of the line.

Returns:

The start and end points.

Return type:

tuple[tuple[int], tuple[int]]

class bruhanimate.bruheffect.draw_lines_effect.DrawLinesEffect(buffer: Buffer, background: str, settings: DrawLinesSettings = None)[source]

Bases: BaseEffect

Effect for drawing Bresenham line segments onto the buffer.

__init__(buffer: Buffer, background: str, settings: DrawLinesSettings = None)[source]

Initializes the DrawLinesEffect.

Parameters:

  • buffer (Buffer) – Effect buffer to push updates to.

  • background (str) – Character or string to use as the background.

  • settings (DrawLinesSettings, optional) – Configuration for the effect. Defaults to None.

add_line(start_point: tuple[int], end_point: tuple[int])[source]

Adds a line segment to be rendered.

Parameters:

  • start_point (tuple[int]) – Start point as (x, y).

  • end_point (tuple[int]) – End point as (x, y).

render_frame(frame_number: int)[source]

Renders all lines on frame 0.

Parameters:

frame_number (int) – The current frame number.