LiveSessionCameraFollowerList

class omni.kit.widget.live_session_management.LiveSessionCameraFollowerList(

usd_context: UsdContext,

camera_path: Path,

**kwargs,

)

Bases: object

Widget to build a user list to show all followers of the specific camera.

Parameters:

• usd_context (omni.usd.UsdContext) – USD Context instance.

• camera_path (Sdf.Path) – Interested camera.

Keyword Arguments:

• icon_size (int) – The width and height of the user icon. 16 pixel by default.

• spacing (int) – The horizontal spacing between two icons. 2 pixel by default.

• maximum_users (int) – The maximum users to show, and show others with overflow.

• show_my_following_users (bool) – Whether it should show the users that are following me or not.

Methods

__init__(usd_context, camera_path, **kwargs)	Initializes the LiveSessionCameraFollowerList widget.
destroy()	Destroys the widget and clears internal resources.
empty()	Checks if any user icons have been added.
track_camera(camera_path)	Switches the camera path to listen to.

Attributes

layout

Gets the root widget of the list.

__init__(

usd_context: UsdContext,

camera_path: Path,

**kwargs,

)

Initializes the LiveSessionCameraFollowerList widget.

destroy()

Destroys the widget and clears internal resources.

empty() → bool

Checks if any user icons have been added.

Returns:

True if no user icons are added, False otherwise.

Return type:

bool

track_camera(camera_path: Path)

Switches the camera path to listen to.

Parameters:

camera_path (Sdf.Path) – New camera path to track.

property layout: HStack

Gets the root widget of the list.

Returns:

The root widget of the list.

Return type:

ui.HStack