← Python SDK / frames

PYTHONPUBLIC API

fastsim.api.frames

fastsim.api.frames 的当前公共 Python API；签名从 vNext AST 直接提取。

FrameKind FrameDescriptor FrameQuery FrameCatalogSnapshot FrameTransform TransformStamped FrameDelta FrameQueryErrorCode FrameQueryError FrameDeltaSubscription FrameQueryService

公开符号 11

class

FrameKind

L224

class FrameKind(StrEnum)

当前源码未提供公开 docstring。

class

FrameDescriptor

L236

class FrameDescriptor(object)

One frame-node relationship without a backend-native transform handle.

字段	类型	默认值
frame_id	str	—
kind	FrameKind	—
parent_frame_id	str \| None	—
owner_entity_id	str \| None	None
owner_link_id	str \| None	None
name	str \| None	None

class

FrameQuery

L290

class FrameQuery(object)

A bounded deterministic intersection filter for frame reads.

字段	类型	默认值
frame_ids	tuple[str, ...]	()
entity_ids	tuple[str, ...]	()
kinds	tuple[FrameKind, ...]	()

class

FrameCatalogSnapshot

L326

class FrameCatalogSnapshot(object)

Immutable frame graph catalog for one locked plan and generation.

字段	类型	默认值
run_id	str	—
plan_digest	str	—
generation	int	—
catalog_revision	int	—
content_sha256	str	—
frames	tuple[FrameDescriptor, ...]	—

class

FrameTransform

L377

class FrameTransform(object)

Compact ``target_T_source`` transform used inside a frame delta.

字段	类型	默认值
target_frame	str	—
source_frame	str	—
target_T_source	Pose	—

class

TransformStamped

L398

class TransformStamped(object)

A committed ``target_T_source`` lookup result. ``target_T_source`` maps coordinates expressed in ``source_frame`` into ``target_frame``. Translation is metres and rotation is a right-handed ``xyzw`` unit quaternion through :class:`~fastsim.api.scene.Pose`.

字段	类型	默认值
run_id	str	—
generation	int	—
sim_tick	int	—
sim_time_s	float	—
sequence	int	—
captured_monotonic_ns	int	—
world_revision	int	—
catalog_revision	int	—
catalog_content_sha256	str	—
transform_revision	int	—
target_frame	str	—
source_frame	str	—
target_T_source	Pose	—

class

FrameDelta

L461

class FrameDelta(object)

Bounded graph/transform update or terminal resynchronization marker.

字段	类型	默认值
run_id	str	—
generation	int	—
sim_tick	int	—
sim_time_s	float	—
sequence	int	—
captured_monotonic_ns	int	—
base_sequence	int	—
previous_world_revision	int	—
world_revision	int	—
previous_catalog_revision	int	—
catalog_revision	int	—
previous_catalog_content_sha256	str \| None	—
catalog_content_sha256	str \| None	—
previous_transform_revision	int	—
transform_revision	int	—
added_frames	tuple[FrameDescriptor, ...]	()
removed_frame_ids	tuple[str, ...]	()
transforms	tuple[FrameTransform, ...]	()
resync_required	bool	False

class

FrameQueryErrorCode

L593

class FrameQueryErrorCode(StrEnum)

当前源码未提供公开 docstring。

class

FrameQueryError

L604

class FrameQueryError(RuntimeError)

Typed bounded failure from ``fastsim.frame.query@3``.

class

FrameDeltaSubscription

L637

class FrameDeltaSubscription(Protocol)

当前源码未提供公开 docstring。

dropped

FrameDeltaSubscription.dropped(self) -> int

当前源码未提供公开 docstring。

closed

FrameDeltaSubscription.closed(self) -> bool

当前源码未提供公开 docstring。

get_async

async FrameDeltaSubscription.get_async(self, timeout: float | None=None) -> FrameDelta

当前源码未提供公开 docstring。

FrameDeltaSubscription.close(self) -> None

当前源码未提供公开 docstring。

class

FrameQueryService

L650

class FrameQueryService(Protocol)

当前源码未提供公开 docstring。

service_id

FrameQueryService.service_id(self) -> str

当前源码未提供公开 docstring。

catalog

FrameQueryService.catalog(self, query: FrameQuery | None=None) -> FrameCatalogSnapshot

当前源码未提供公开 docstring。

lookup

FrameQueryService.lookup(self, target_frame: str, source_frame: str, *, generation: int | None=None) -> TransformStamped

当前源码未提供公开 docstring。

FrameQueryService.subscribe(self, query: FrameQuery | None=None, capacity: int=16) -> FrameDeltaSubscription

当前源码未提供公开 docstring。