lsdtools.runtimeui reference

SDK distribution 1.0.0; API contract 1.0; generator 1.0.0.

Product source digest: 13800cef04184609594a0b15f310d52e8ece337faa4be2176039a5286946127b.

Generated from declared public exports and source syntax. Signatures and annotations are declaration spellings; decorators, factories and annotations are never executed. Class members below are declared members; base classes remain explicit. Source docstrings describe their owning implementation; they do not grant app permissions.

Runtime UI documents, native contexts, and the project UI editor, loaded on demand.

Importing this facade loads neither GTK nor a native library. Documents are data-only RML/RCSS
resource closures. The existing Timeline/tween service owns animation and runtime time.

lsdtools.runtimeui.BuildUI#

Kind: class. Source: services/runtimeui/src/lsd_runtimeui/steps.py:22.

Source docstring:

Build a contained UI resource bundle without native initialization or code execution.

Implementation alias: lsd_runtimeui.steps.BuildUI.

Declared bases: LoadStep.

lsdtools.runtimeui.BuildUI.output_ports#

Kind: attribute. Source: services/runtimeui/src/lsd_runtimeui/steps.py:24.

output_ports = ['ui']

lsdtools.runtimeui.BuildUI.cache_pin#

Kind: attribute. Source: services/runtimeui/src/lsd_runtimeui/steps.py:25.

cache_pin = 'lsd-runtimeui-document-v1'

lsdtools.runtimeui.BuildUI.document#

Kind: attribute. Source: services/runtimeui/src/lsd_runtimeui/steps.py:26.

document = param(dict, default_factory=lambda: dict(EMPTY_DOCUMENT), required=True, label='UI document', validators=[_validate_document], description='RML, RCSS, fonts and images included with this project.')

lsdtools.runtimeui.BuildUI.run#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/steps.py:30.

run(self)

self: (unannotated)

lsdtools.runtimeui.DocumentBundle#

Kind: class. Source: services/runtimeui/src/lsd_runtimeui/document.py:243.

Source docstring:

One immutable, self-contained document and its explicit resource closure.

Implementation alias: lsd_runtimeui.document.DocumentBundle.

lsdtools.runtimeui.DocumentBundle.id#

Kind: attribute. Source: services/runtimeui/src/lsd_runtimeui/document.py:245.

id: str

lsdtools.runtimeui.DocumentBundle.entry#

Kind: attribute. Source: services/runtimeui/src/lsd_runtimeui/document.py:246.

entry: str

lsdtools.runtimeui.DocumentBundle.resources#

Kind: attribute. Source: services/runtimeui/src/lsd_runtimeui/document.py:247.

resources: tuple[Resource, ...]

lsdtools.runtimeui.DocumentBundle.fonts#

Kind: attribute. Source: services/runtimeui/src/lsd_runtimeui/document.py:248.

fonts: tuple[str, ...]

fonts = ()

lsdtools.runtimeui.DocumentBundle.properties#

Kind: attribute. Source: services/runtimeui/src/lsd_runtimeui/document.py:249.

properties: Mapping[str, Mapping]

properties = field(default_factory=dict)

lsdtools.runtimeui.DocumentBundle.models#

Kind: attribute. Source: services/runtimeui/src/lsd_runtimeui/document.py:250.

models: Mapping[str, Mapping]

models = field(default_factory=dict)

lsdtools.runtimeui.DocumentBundle.event_bindings#

Kind: attribute. Source: services/runtimeui/src/lsd_runtimeui/document.py:251.

event_bindings: tuple[Mapping, ...]

event_bindings = ()

lsdtools.runtimeui.DocumentBundle.from_sources#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/document.py:327.

from_sources(cls, source: str, *, id='ui', entry='main.rml', resources=None, fonts=(), properties=None, models=None, event_bindings=())

cls: (unannotated)
entry: (unannotated)
event_bindings: (unannotated)
fonts: (unannotated)
id: (unannotated)
models: (unannotated)
properties: (unannotated)
resources: (unannotated)
source: str

lsdtools.runtimeui.DocumentBundle.source#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/document.py:335.

source(self, path=None)

path: (unannotated)
self: (unannotated)

lsdtools.runtimeui.DocumentBundle.resource_bytes#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/document.py:339.

resource_bytes(self)

self: (unannotated)

lsdtools.runtimeui.DocumentBundle.replace_source#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/document.py:342.

replace_source(self, path, source)

path: (unannotated)
self: (unannotated)
source: (unannotated)

lsdtools.runtimeui.DocumentBundle.with_resource#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/document.py:348.

with_resource(self, path, data, *, font=False)

data: (unannotated)
font: (unannotated)
path: (unannotated)
self: (unannotated)

Source docstring:

Include explicit asset bytes in a new generation, refusing accidental replacement.

lsdtools.runtimeui.DocumentBundle.without_resource#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/document.py:358.

without_resource(self, path)

path: (unannotated)
self: (unannotated)

Source docstring:

Remove an unreferenced asset; normal closure validation protects live references.

lsdtools.runtimeui.DocumentBundle.with_property#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/document.py:365.

with_property(self, element, name, value)

element: (unannotated)
name: (unannotated)
self: (unannotated)
value: (unannotated)

Source docstring:

Set a definite typed authored value above RCSS through a new document generation.

lsdtools.runtimeui.DocumentBundle.without_property#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/document.py:371.

without_property(self, element, name)

element: (unannotated)
name: (unannotated)
self: (unannotated)

Source docstring:

Release one authored override back to RCSS in a new document generation.

lsdtools.runtimeui.DocumentBundle.to_authoring_tables#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/document.py:381.

to_authoring_tables(self)

self: (unannotated)

lsdtools.runtimeui.DocumentBundle.to_dict#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/document.py:385.

to_dict(self)

self: (unannotated)

lsdtools.runtimeui.DocumentBundle.from_dict#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/document.py:395.

from_dict(cls, value)

cls: (unannotated)
value: (unannotated)

lsdtools.runtimeui.DocumentBundle.canonical_bytes#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/document.py:420.

canonical_bytes(self)

self: (unannotated)

lsdtools.runtimeui.DocumentBundle.digest#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/document.py:424.

digest(self)

self: (unannotated)

lsdtools.runtimeui.DocumentError#

Kind: class. Source: services/runtimeui/src/lsd_runtimeui/document.py:29.

Source docstring:

Invalid, incomplete, or unsupported runtime UI document data.

Implementation alias: lsd_runtimeui.document.DocumentError.

Declared bases: ValueError.

lsdtools.runtimeui.NativeDocument#

Kind: class. Source: services/runtimeui/src/lsd_runtimeui/native.py:175.

NativeDocument(self, width: int=800, height: int=600, dpi: float=1.0, *, resources: Mapping[str, bytes] | None=None, fonts: Iterable[str]=(), models: Mapping[str, Mapping] | None=None, event_bindings: Iterable[Mapping]=(), renderer: int=0, library: NativeLibrary | None=None)

Implementation alias: lsd_runtimeui.native.NativeDocument.

lsdtools.runtimeui.NativeDocument.__init__#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/native.py:176.

__init__(self, width: int=800, height: int=600, dpi: float=1.0, *, resources: Mapping[str, bytes] | None=None, fonts: Iterable[str]=(), models: Mapping[str, Mapping] | None=None, event_bindings: Iterable[Mapping]=(), renderer: int=0, library: NativeLibrary | None=None)

dpi: float
event_bindings: Iterable[Mapping]
fonts: Iterable[str]
height: int
library: NativeLibrary | None
models: Mapping[str, Mapping] | None
renderer: int
resources: Mapping[str, bytes] | None
self: (unannotated)
width: int

lsdtools.runtimeui.NativeDocument.add_resource#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/native.py:218.

add_resource(self, path: str, data: bytes)

data: bytes
path: str
self: (unannotated)

lsdtools.runtimeui.NativeDocument.load#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/native.py:223.

load(self, rml: str, source: str='main.rml')

rml: str
self: (unannotated)
source: str

lsdtools.runtimeui.NativeDocument.update#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/native.py:226.

update(self)

self: (unannotated)

lsdtools.runtimeui.NativeDocument.next_update_delay#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/native.py:229.

next_update_delay(self) -> float

self: (unannotated)

lsdtools.runtimeui.NativeDocument.resize#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/native.py:234.

resize(self, width: int, height: int, dpi: float=1.0)

dpi: float
height: int
self: (unannotated)
width: int

lsdtools.runtimeui.NativeDocument.query#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/native.py:237.

query(self, element_id: str) -> dict

element_id: str
self: (unannotated)

lsdtools.runtimeui.NativeDocument.elements#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/native.py:240.

elements(self) -> list[dict]

self: (unannotated)

lsdtools.runtimeui.NativeDocument.query_all#

Kind: attribute. Source: services/runtimeui/src/lsd_runtimeui/native.py:243.

query_all = elements

lsdtools.runtimeui.NativeDocument.set_property#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/native.py:245.

set_property(self, element_id: str, name: str, value: str)

element_id: str
name: str
self: (unannotated)
value: str

lsdtools.runtimeui.NativeDocument.set_properties#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/native.py:248.

set_properties(self, changes: Iterable[tuple[str, str, str]])

changes: Iterable[tuple[str, str, str]]
self: (unannotated)

lsdtools.runtimeui.NativeDocument.set_text#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/native.py:255.

set_text(self, element_id: str, text: str)

element_id: str
self: (unannotated)
text: str

lsdtools.runtimeui.NativeDocument.set_model#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/native.py:258.

set_model(self, name: str, mapping: Mapping)

mapping: Mapping
name: str
self: (unannotated)

lsdtools.runtimeui.NativeDocument.patch_model#

Kind: attribute. Source: services/runtimeui/src/lsd_runtimeui/native.py:296.

patch_model = set_model

lsdtools.runtimeui.NativeDocument.get_model#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/native.py:298.

get_model(self, name: str) -> dict

name: str
self: (unannotated)

lsdtools.runtimeui.NativeDocument.query_selector#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/native.py:301.

query_selector(self, selector: str)

selector: str
self: (unannotated)

lsdtools.runtimeui.NativeDocument.query_selector_all#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/native.py:304.

query_selector_all(self, selector: str) -> list[dict]

selector: str
self: (unannotated)

lsdtools.runtimeui.NativeDocument.hit_test#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/native.py:307.

hit_test(self, x: float, y: float)

self: (unannotated)
x: float
y: float

lsdtools.runtimeui.NativeDocument.set_attribute#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/native.py:310.

set_attribute(self, identity: str, name: str, value: str)

identity: str
name: str
self: (unannotated)
value: str

lsdtools.runtimeui.NativeDocument.remove_attribute#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/native.py:313.

remove_attribute(self, identity: str, name: str)

identity: str
name: str
self: (unannotated)

lsdtools.runtimeui.NativeDocument.set_class#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/native.py:316.

set_class(self, identity: str, name: str, enabled: bool=True)

enabled: bool
identity: str
name: str
self: (unannotated)

lsdtools.runtimeui.NativeDocument.set_pseudo_class#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/native.py:321.

set_pseudo_class(self, identity: str, name: str, enabled: bool=True)

enabled: bool
identity: str
name: str
self: (unannotated)

lsdtools.runtimeui.NativeDocument.append_rml#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/native.py:326.

append_rml(self, identity: str, source: str)

identity: str
self: (unannotated)
source: str

lsdtools.runtimeui.NativeDocument.set_inner_rml#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/native.py:329.

set_inner_rml(self, identity: str, source: str)

identity: str
self: (unannotated)
source: str

lsdtools.runtimeui.NativeDocument.remove_element#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/native.py:332.

remove_element(self, identity: str)

identity: str
self: (unannotated)

lsdtools.runtimeui.NativeDocument.bind_event#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/native.py:335.

bind_event(self, model: str, callback: str)

callback: str
model: str
self: (unannotated)

lsdtools.runtimeui.NativeDocument.input#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/native.py:338.

input(self, kind: str, **values) -> bool

kind: str
self: (unannotated)
values: (unannotated)

lsdtools.runtimeui.NativeDocument.input_state#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/native.py:363.

input_state(self) -> dict

self: (unannotated)

lsdtools.runtimeui.NativeDocument.activate#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/native.py:366.

activate(self, identity: str)

identity: str
self: (unannotated)

Source docstring:

Activate an identified visible native control without pointer coordinates.

lsdtools.runtimeui.NativeDocument.drain_events#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/native.py:370.

drain_events(self) -> list[dict]

self: (unannotated)

lsdtools.runtimeui.NativeDocument.poll_form_event#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/native.py:373.

poll_form_event(self) -> dict | None

self: (unannotated)

Source docstring:

Consume one bounded native submission; copy all borrowed values now.

lsdtools.runtimeui.NativeDocument.render_native#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/native.py:386.

render_native(self)

self: (unannotated)

lsdtools.runtimeui.NativeDocument.close#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/native.py:389.

close(self)

self: (unannotated)

lsdtools.runtimeui.NativeDocument.__enter__#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/native.py:395.

__enter__(self)

self: (unannotated)

lsdtools.runtimeui.NativeDocument.__exit__#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/native.py:399.

__exit__(self, *exc)

exc: (unannotated)
self: (unannotated)

lsdtools.runtimeui.NativeDocument.native_library#

Kind: attribute. Source: services/runtimeui/src/lsd_runtimeui/native.py:180.

native_library: (unannotated)

native_library = library or load_native()

lsdtools.runtimeui.NativeDocument.handle#

Kind: attribute. Source: services/runtimeui/src/lsd_runtimeui/native.py:182.

handle: (unannotated)

handle = 0

lsdtools.runtimeui.Resource#

Kind: class. Source: services/runtimeui/src/lsd_runtimeui/document.py:226.

Implementation alias: lsd_runtimeui.document.Resource.

lsdtools.runtimeui.Resource.path#

Kind: attribute. Source: services/runtimeui/src/lsd_runtimeui/document.py:227.

path: str

lsdtools.runtimeui.Resource.data#

Kind: attribute. Source: services/runtimeui/src/lsd_runtimeui/document.py:228.

data: bytes

lsdtools.runtimeui.Resource.digest#

Kind: method. Source: services/runtimeui/src/lsd_runtimeui/document.py:238.

digest(self)

self: (unannotated)

lsdtools.runtimeui.builtin_font_resources#

Kind: function. Source: sdk/src/lsdtools/runtimeui.py:12.

builtin_font_resources() -> dict[str, bytes]

Source docstring:

Return authenticated LatoLatin Regular font/license bytes for an included UI resource bundle.

lsdtools.runtimeui.can_play_ui#

Kind: function. Source: sdk/src/lsdtools/runtimeui.py:24.

can_play_ui(entity) -> bool

entity: (unannotated)

Source docstring:

Whether an entity declares one UI output and a complete or genuinely empty scene.

lsdtools.runtimeui.create_runtime_ui_surface#

Kind: function. Source: sdk/src/lsdtools/runtimeui.py:52.

create_runtime_ui_surface(surface, *, input_port=None)

input_port: (unannotated)
surface: (unannotated)

Source docstring:

Compose the retained runtime overlay on an existing graphical surface and its clock.

The caller passes immutable UI component tables and borrowed published UI numeric state;
the adapter retains only copied property changes. Input authority stays in its existing
runtime channel or admitted human seat.

lsdtools.runtimeui.create_ui_editor#

Kind: function. Source: sdk/src/lsdtools/runtimeui.py:101.

create_ui_editor(host, *, entity=None, view_id)

entity: (unannotated)
host: (unannotated)
view_id: (unannotated)

Source docstring:

Compose an editor over attached Build UI steps and this host's admitted action port.

lsdtools.runtimeui.create_ui_player#

Kind: function. Source: sdk/src/lsdtools/runtimeui.py:34.

create_ui_player(host, *, entity=None, view_id)

entity: (unannotated)
host: (unannotated)
view_id: (unannotated)

Source docstring:

Present UI through the existing shared runtime viewport, input channel and Timeline clock.

The ordinary main-view binding delivers its entity after creation. A UI-only document has
zero objects, cameras and actors; this factory creates no spatial authoring or second player.
Its visible transport uses the existing entity-keyed runtime actions. The Timeline button
opens the ordinary Timeline editor on that same entity.

lsdtools.runtimeui.timeline_spec#

Kind: function. Source: sdk/src/lsdtools/runtimeui.py:18.

timeline_spec()

Source docstring:

Return Runtime UI's exact property/state contribution for the existing Scene Timeline.