bbi.backplate

pydantic model BackplateProps

Bases: BaseModel

field gsd: float [Required]

field resolution: tuple[int, int] [Required]

class S3Backplates(bucket_name: str, aws_access_key_id: str, aws_secret_access_key: str, **kwargs: Any)

Bases: object

S3 source representing backplates stored in an S3 bucket.

generate_presigned_url(object_name: str) → str

Generate a presigned URL to share an S3 object. This method checks if the object name is in the bucket and if it is a backplate file.

Parameters:

object_name (str) – The name of the object to generate a presigned URL for.

get_file_gsd(file_name: str) → float

Get the GSD of a backplate file.

Parameters:

file_name (str) – The name of the file to get the GSD of.

Returns:

The GSD of the backplate file.

Return type:

float

get_file_resolution(file_name: str) → tuple[int, int]

Get the resolution of a backplate file.

Parameters:

file_name (str) – The name of the file to get the resolution of.

Returns:

The resolution of the backplate file.

Return type:

tuple[int, int]

pydantic model BackplateUpdateParam

Bases: AnimationFrame

field file_path: str | None = None

field source_name: str | None = None

class SatelliteBackplate

Bases: Node, Animatable[BackplateUpdateParam]

Backplate node representing a textured 2D plane in the scene.

property gsd: float

property resolution: tuple[int, int]

add_backplates(backplates: S3Backplates) → None

Add a backplate source to this backplate.

Parameters:

backplates (S3Backplates) – The source S3Backplates object to add.

set_backplate(source_name: str, file_path: str) → None

Set the backplate texture from a file in an added source.

Parameters:

• source_name (str) – The name of the added S3Backplates source.

• file_path (str) – The path to the backplate file in the added source.

reset_backplate()

Reset the backplate to the default texture.

execute(frame_id: int | None = None, frame_max: int | None = None, delta_seconds: float | None = None) → None

Updates the backplate to the specified frame.

Parameters:

• frame_id (int | None, optional) – The frame ID. Defaults to None.

• frame_max (int | None, optional) – Max frame count in the current loop. Defaults to None.

• delta_seconds (float | None, optional) – The target real-time in seconds between frames. This is used to calculate physical displacement for certain assets. Defaults to None.