batgrl.gadgets.text_raycaster

A raycaster gadget.

Classes

TextRaycaster(*, caster_map, camera, ...[, ...])

A raycaster gadget.

class batgrl.gadgets.text_raycaster.TextRaycaster(*, caster_map: ndarray[Any, dtype[uint16]], camera: RaycasterCamera, wall_textures: list[ndarray[Any, dtype[uint64]]] | None, sprites: list[Sprite] | None = None, sprite_textures: list[ndarray[Any, dtype[str_]]] | None = None, max_hops: int = 20, ascii_map: str = ' .,:;<+*LtCa4U80dQM@', default_cell: ndarray[Any, dtype[dtype(['char', '<U1', 'bold', '?', 'italic', '?', 'underline', '?', 'strikethrough', '?', 'overline', '?', 'reverse', '?', 'fg_color', 'u1', 3, 'bg_color', 'u1', 3])]] | str = ' ', alpha: float = 1.0, size: Size = (10, 10), pos: Point = (0, 0), size_hint: SizeHint | None = None, pos_hint: PosHint | None = None, is_transparent: bool = True, is_visible: bool = True, is_enabled: bool = True)

Bases: Text

A raycaster gadget.

Parameters:

caster_mapNDArray[np.ushort]

The raycaster map.

cameraRaycasterCamera

The raycaster camera.

wall_texturesList[NDArray[np.uint]]

Textures for walls.

spriteslist[Sprite] | None, default: None

A list of sprites.

sprite_textureslist[NDArray[np.str_]] | None, default: None

Textures for sprites.

max_hopsint, default: 20

Determines how far rays are cast.

ascii_mapstr, default: “ .,:;<+*LtCa4U80dQM@”

Dark to bright ascii characters for shading.

default_cellNDArray[Cell] | str, default: “ “

Default cell of text canvas.

alphafloat, default: 1.0

Transparency of gadget.

sizeSize, default: Size(10, 10)

Size of gadget.

posPoint, default: Point(0, 0)

Position of upper-left corner in parent.

size_hintSizeHint | None, default: None

Size as a proportion of parent’s height and width.

pos_hintPosHint | None, default: None

Position as a proportion of parent’s height and width.

is_transparentbool, default: True

Whether gadget is transparent.

is_visiblebool, default: True

Whether gadget is visible. Gadget will still receive input events if not visible.

is_enabledbool, default: True

Whether gadget is enabled. A disabled gadget is not painted and doesn’t receive input events.

Attributes:

caster_mapNDArray[np.ushort]

The raycaster map.

cameraRaycasterCamera

The raycaster camera.

wall_texturesList[NDArray[np.uint]]

Textures for walls.

spriteslist[Sprite]

A list of sprites.

sprite_textureslist[NDArray[np.str_]]

Textures for sprites.

max_hopsint

Determines how far rays are cast.

ascii_mapstr

Dark to bright ascii characters for shading.

canvasNDArray[Cell]

The array of characters for the gadget.

default_cellNDArray[Cell]

Default character for text canvas.

default_fg_colorColor

Foreground color of default character.

default_bg_colorColor

Background color of default character.

alphafloat

Transparency of gadget.

sizeSize

Size of gadget.

heightint

Height of gadget.

rowsint

Height of gadget.

widthint

Width of gadget.

columnsint

Width of gadget.

posPoint

Position relative to parent.

topint

y-coordinate of top of gadget.

yint

y-coordinate of top of gadget.

leftint

x-coordinate of left side of gadget.

xint

x-coordinate of left side of gadget.

bottomint

y-coordinate of bottom of gadget.

rightint

x-coordinate of right side of gadget.

centerPoint

Position of center of gadget.

absolute_posPoint

Absolute position on screen.

size_hintSizeHint

Gadget’s size as a proportion of its parent’s size.

pos_hintPosHint

Gadget’s position as a proportion of its parent’s size.

parent: Gadget | None

Parent gadget.

childrenlist[Gadget]

Children gadgets.

is_transparentbool

Whether gadget is transparent.

is_visiblebool

Whether gadget is visible.

is_enabledbool

Whether gadget is enabled.

rootGadget | None

Return the root gadget if connected to gadget tree.

appApp

The running app.

Methods

cast_rays()	Update canvas by casting all rays.
add_border(style=”light”, …)	Add a border to the gadget.
add_syntax_highlighting(lexer, style)	Add syntax highlighting to current text in canvas.
add_str(str, pos, …)	Add a single line of text to the canvas.
set_text(text, …)	Resize gadget to fit text, erase canvas, then fill canvas with text.
clear()	Fill canvas with default cell.
shift(n=1)	Shift content in canvas up (or down in case of negative n).
apply_hints()	Apply size and pos hints.
to_local(point)	Convert point in absolute coordinates to local coordinates.
collides_point(point)	Return true if point collides with visible portion of gadget.
collides_gadget(other)	Return true if other is within gadget’s bounding box.
pull_to_front()	Move to end of gadget stack so gadget is drawn last.
walk()	Yield all descendents of this gadget (preorder traversal).
walk_reverse()	Yield all descendents of this gadget (reverse postorder traversal).
ancestors()	Yield all ancestors of this gadget.
add_gadget(gadget)	Add a child gadget.
add_gadgets(*gadgets)	Add multiple child gadgets.
remove_gadget(gadget)	Remove a child gadget.
prolicide()	Recursively remove all children.
destroy()	Remove this gadget and recursively remove all its children.
bind(prop, callback)	Bind callback to a gadget property.
unbind(uid)	Unbind a callback from a gadget property.
tween(…)	Sequentially update gadget properties over time.
on_size()	Update gadget after a resize.
on_transparency()	Update gadget after transparency is enabled/disabled.
on_add()	Update gadget after being added to the gadget tree.
on_remove()	Update gadget after being removed from the gadget tree.
on_key(key_event)	Handle a key press event.
on_mouse(mouse_event)	Handle a mouse event.
on_paste(paste_event)	Handle a paste event.
on_terminal_focus(focus_event)	Handle a focus event.

property absolute_pos: Point | None

Absolute position on screen.

add_border(style: Literal['light', 'heavy', 'double', 'curved', 'ascii', 'outer', 'inner', 'thick', 'dashed', 'dashed_2', 'dashed_3', 'heavy_dashed', 'heavy_dashed_2', 'heavy_dashed_3', 'near', 'mcgugan_tall', 'mcgugan_wide'] = 'light', bold: bool = False, fg_color: Color | None = None, bg_color: Color | None = None)

Add a text border (gadget height and width must be at least 2).

Parameters:

styleBorder, default: “light”

Style of border. Default style uses light box-drawing characters.

boldbool, default: False

Whether the border is bold.

fg_colorColor | None, default: None

Foreground color of border if not None.

bg_colorColor | None, default: None

Background color of border if not None.

add_gadget(gadget: Self) → None

Add a child gadget.

Parameters:

gadgetGadget

A gadget to add as a child.

add_gadgets(*gadgets: Self) → None

Add multiple child gadgets.

Parameters:

*gadgetsGadget

Gadgets to add as children. Can also accept a single iterable of gadgets.

add_str(str: str, *, pos: Point = (0, 0), fg_color: Color | None = None, bg_color: Color | None = None, markdown: bool = False, truncate_str: bool = False)

Add a single line of text to the canvas at position pos.

If markdown is true, text can be styled using batgrl markdown. The syntax is: - italic: *this is italic text* - bold: **this is bold text** - strikethrough: ~~this is strikethrough text~~ - underlined: __this is underlined text__ - overlined: ^^this is overlined text^^

Parameters:

strstr

A single line of text to add to canvas.

posPoint, default: Point(0, 0)

Position of first character of string. Negative coordinates position from the right or bottom of canvas (like negative indices).

fg_colorColor | None, default: None

Foreground color of text.

bg_colorColor | None, default: None

Background color of text.

markdownbool, default: False

Whether to parse text for batgrl markdown.

truncate_strbool, default: False

If false, an IndexError is raised if the text would not fit on canvas.

See also

text_tools.add_text

Add multiple lines of text to a view of a canvas.

add_syntax_highlighting(lexer: ~pygments.lexer.Lexer | None = None, style: ~pygments.style.Style = <class 'batgrl.colors.colors.Neptune'>)

Add syntax highlighting to current text in canvas.

Parameters:

lexerpygments.lexer.Lexer | None, default: None

Lexer for text. If not given, the lexer is guessed.

stylepygments.style.Style, default: Neptune

A pygments style to use for syntax highlighting.

property alpha: float

Transparency of gadget.

ancestors() → Iterator[Self]

Yield all ancestors of this gadget.

Yields:

Gadget

An ancestor of this gadget.

property app

The running app.

apply_hints() → None

Apply size and pos hints.

This is called automatically when the gadget is added to the gadget tree and when the gadget’s parent’s size changes.

ascii_map

Dark to bright ascii characters for shading.

bind(prop: str, callback: Callable[[], None]) → int

Bind callback to a gadget property. When the property is updated, callback is called with no arguments.

Parameters:

propstr

The name of the gadget property.

callbackCallable[[], None]

Callback to bind to property.

Returns:

int

A unique id used to unbind the callback.

property bottom: int

y-coordinate of bottom of gadget.

camera

The raycaster camera.

cast_rays()

Update canvas by casting all rays.

caster_map

The raycaster map.

property center: Point

Position of center of gadget.

children: _GadgetList

The gadget’s children.

clear()

Fill canvas with default cell.

collides_gadget(other: Self) → bool

Return true if other is within gadget’s bounding box.

Parameters:

otherGadget

Another gadget.

Returns:

bool

Whether other collides with gadget.

collides_point(point: Point) → bool

Return true if point collides with visible portion of gadget.

Parameters:

pointPoint

A point.

Returns:

bool

Whether point collides with gadget.

property columns: int

Width of gadget.

property default_bg_color: Color

Background color of default character.

property default_cell: ndarray[Any, dtype[dtype(['char', '<U1', 'bold', '?', 'italic', '?', 'underline', '?', 'strikethrough', '?', 'overline', '?', 'reverse', '?', 'fg_color', 'u1', 3, 'bg_color', 'u1', 3])]]

Default character for text canvas.

property default_fg_color: Color

Foreground color of default character.

destroy() → None

Remove this gadget and recursively remove all its children.

dispatch_key(key_event: KeyEvent) → bool | None

Dispatch a key press event until handled.

A key press event is handled if a handler returns True.

Parameters:

key_eventKeyEvent

The key event to dispatch.

Returns:

bool | None

Whether the dispatch was handled.

dispatch_mouse(mouse_event: MouseEvent) → bool | None

Dispatch a mouse event until handled.

A mouse event is handled if a handler returns True.

Parameters:

mouse_eventMouseEvent

The mouse event to dispatch.

Returns:

bool | None

Whether the dispatch was handled.

dispatch_paste(paste_event: PasteEvent) → bool | None

Dispatch a paste event until handled.

A paste event is handled if a handler returns True.

Parameters:

paste_eventPasteEvent

The paste event to dispatch.

Returns:

bool | None

Whether the dispatch was handled.

dispatch_terminal_focus(focus_event: FocusEvent) → bool | None

Dispatch a focus event until handled.

A focus event is handled if a handler returns True.

Parameters:

focus_eventFocusEvent

The focus event to dispatch.

Returns:

bool | None

Whether the dispatch was handled.

property height: int

Height of gadget.

property is_enabled: bool

Whether gadget is enabled. A disabled gadget is not painted and doesn’t receive input events.

property is_transparent: bool

Whether gadget is transparent.

property is_visible: bool

Whether gadget is visible. Gadget will still receive input events if not visible.

property left: int

x-coordinate of left side of gadget.

max_hops

Determines how far rays are cast.

on_add() → None

Update gadget after being added to the gadget tree.

on_key(key_event: KeyEvent) → bool | None

Handle a key press event.

Handled key presses should return True.

Parameters:

key_eventKeyEvent

The key event to handle.

Returns:

bool | None

Whether the key event was handled.

on_mouse(mouse_event: MouseEvent) → bool | None

Handle a mouse event.

Handled mouse events should return True.

Parameters:

mouse_eventMouseEvent

The mouse event to handle.

Returns:

bool | None

Whether the mouse event was handled.

on_paste(paste_event: PasteEvent) → bool | None

Handle a paste event.

Handled paste events should return True.

Parameters:

paste_eventPasteEvent

The paste event to handle.

Returns:

bool | None

Whether the paste event was handled.

on_remove() → None

Update gadget after being removed from the gadget tree.

on_size()

Resize canvas array and re-make caster buffers.

on_terminal_focus(focus_event: FocusEvent) → bool | None

Handle a focus event.

Handled focus events should return True.

Parameters:

focus_eventFocusEvent

The focus event to handle.

Returns:

bool | None

Whether the focus event was handled.

on_transparency() → None

Update gadget after transparency is enabled/disabled.

parent: Gadget | None

The gadget’s parent.

property pos: Point

Position relative to parent.

property pos_hint: PosHint

Gadget’s position as a proportion of its parent’s size.

prolicide() → None

Recursively remove all children.

pull_to_front() → None

Move gadget to end of gadget stack so that it is drawn last.

remove_gadget(gadget: Self) → None

Remove a child gadget.

Parameters:

gadgetGadget

The gadget to remove from children.

property right: int

x-coordinate of right side of gadget.

property root: Self | None

Return the root gadget if connected to gadget tree.

property rows: int

Height of gadget.

set_text(text: str, *, fg_color: Color | None = None, bg_color: Color | None = None, markdown: bool = False)

Resize gadget to fit text, erase canvas, then fill canvas with text.

If markdown is true, text can be styled using batgrl markdown. The syntax is: - italic: *this is italic text* - bold: **this is bold text** - strikethrough: ~~this is strikethrough text~~ - underlined: __this is underlined text__ - overlined: ^^this is overlined text^^

Parameters:

textstr

Text to add to canvas.

fg_colorColor | None, default: None

Foreground color of text.

bg_colorColor | None, default: None

Background color of text.

markdownbool, default: False

Whether to parse text for batgrl markdown.

See also

text_tools.add_text

Add multiple lines of text to a view of a canvas.

shift(n: int = 1)

Shift content in canvas up (or down in case of negative n).

Rows at the bottom (or top) will be filled with the default cell.

property size: Size

Size of gadget.

property size_hint: SizeHint

Gadget’s size as a proportion of its parent’s size.

sprite_textures

Textures for sprites.

sprites

A list of sprites.

to_local(point: Point) → Point

Convert point in absolute coordinates to local coordinates.

Parameters:

pointPoint

Point in absolute (screen) coordinates.

Returns:

Point

The point in local coordinates.

property top: int

y-coordinate of top of gadget.

async tween(*, duration: float = 1.0, easing: Literal['linear', 'in_quad', 'out_quad', 'in_out_quad', 'in_cubic', 'out_cubic', 'in_out_cubic', 'in_quart', 'out_quart', 'in_out_quart', 'in_quint', 'out_quint', 'in_out_quint', 'in_sine', 'out_sine', 'in_out_sine', 'in_exp', 'out_exp', 'in_out_exp', 'in_circ', 'out_circ', 'in_out_circ', 'in_elastic', 'out_elastic', 'in_out_elastic', 'in_back', 'out_back', 'in_out_back', 'in_bounce', 'out_bounce', 'in_out_bounce'] = 'linear', on_start: Callable[[], None] | None = None, on_progress: Callable[[float], None] | None = None, on_complete: Callable[[], None] | None = None, **properties: Real | ndarray[Any, dtype[number]] | Sequence[Real] | PosHint | SizeHint) → None

Coroutine that sequentially updates gadget properties over a duration (in seconds).

Parameters:

durationfloat, default: 1.0

The duration of the tween in seconds.

easingEasing, default: “linear”

The easing used for tweening.

on_startCallable[[], None] | None, default: None

Called when tween starts.

on_progressCallable[[float], None] | None, default: None

Called as tween updates with current progress.

on_completeCallable[[], None] | None, default: None

Called when tween completes.

**propertiesReal | NDArray[np.number] | Sequence[Real] | PosHint | SizeHint

Gadget properties’ target values. E.g., to smoothly tween a gadget’s position to (5, 10) over 2.5 seconds, specify the pos property as a keyword-argument: await gadget.tween(pos=(5, 10), duration=2.5, easing="out_bounce")

Warning

Running several tweens on the same properties concurrently will probably result in unexpected behavior.

Notes

Tweened values will be coerced to match the type of the initial value of their corresponding property.

Non-numeric values will be set immediately.

unbind(uid: int) → None

Unbind a callback from a gadget property.

Parameters:

uidint

Unique id returned by the bind() method.

walk() → Iterator[Self]

Yield all descendents of this gadget (preorder traversal).

Yields:

Gadget

A descendent of this gadget.

walk_reverse() → Iterator[Self]

Yield all descendents of this gadget (reverse postorder traversal).

Yields:

Gadget

A descendent of this gadget.

wall_textures

Textures for walls.

property width: int

Width of gadget.

property x: int

x-coordinate of left side of gadget.

property y: int

y-coordinate of top of gadget.