an.timing.address

The address grammar: one way to name an animatable value, in every genre.

<entity>[/<node>…]:<field>[@<qualifier>]

• entity — what the scene holds (a character, a prop, the camera, a view);

• /<node>… — a path inside it (charlie/left_arm); root is the stage’s reserved scene root, which the camera lowers onto;

• field — a property the entity kind’s property space declares (an.timing.spaces). It may be a dotted path (view:light.color), and a dotted segment names a declared field, never a member inside a composite value: an orbit interpolates as one value, so view:camera.azimuth is addressable only if the space declares camera.azimuth itself;

• @<qualifier> — a variant of the field (mouth:viseme@happy, a variant swap set), which the stage already emits.

The compiled form’s (target, property) pair is exactly (entity/nodes, field@qualifier), and the golden vectors key every state by the address string.

>>> a = parse_address("charlie/head/mouth:viseme@happy")
>>> a.entity, a.nodes, a.field, a.qualifier
('charlie', ('head', 'mouth'), 'viseme', 'happy')
>>> a.target, a.property
('charlie/head/mouth', 'viseme@happy')
>>> str(parse_address("view:light.color")), parse_address("view:light.color").field_path
('view:light.color', ('light', 'color'))
>>> str(Address.of("root", "pivot_x"))
'root:pivot_x'
>>> parse_address("charlie:")
Traceback (most recent call last):
 ...
an.timing.address.AddressError: 'charlie:': the field is empty

Module Attributes

ENTITY_FIELD_SEP

Separators of the grammar; none of them may appear inside a name.

Functions

format_address(target, prop)	The address string of a compiled (target, property) pair, unvalidated (the fast path for keying states; Address.of() validates).
parse_address(text)	text as an Address; raises AddressError naming the fault.

Classes

Address(entity[, nodes, field, qualifier])

A parsed address.

Exceptions

AddressError

A string is not an address under the grammar.

class an.timing.address.Address(entity, nodes=(), field='', qualifier=None)

Bases: object

A parsed address. str(address) writes it back unchanged.

property field_path: tuple[str, ...]

The dotted field, split.

classmethod of(target, prop)

The address of a compiled (target, property) pair (validated).

Return type:

Address

property property: str

the field and its qualifier.

Type:

The compiled form’s property

property target: str

the entity and its node path.

Type:

The compiled form’s target

exception an.timing.address.AddressError

Bases: ValueError

A string is not an address under the grammar.

an.timing.address.ENTITY_FIELD_SEP: str = ':'

Separators of the grammar; none of them may appear inside a name.

an.timing.address.format_address(target, prop)

The address string of a compiled (target, property) pair, unvalidated (the fast path for keying states; Address.of() validates).

Return type:

str

an.timing.address.parse_address(text)

text as an Address; raises AddressError naming the fault.

Return type:

Address

>>> parse_address("charlie/left_arm:rotation").target
'charlie/left_arm'
>>> parse_address("a::b")
Traceback (most recent call last):
 ...
an.timing.address.AddressError: 'a::b': an address has exactly one ':', found 2