unreal.ViewportLabel

class unreal.ViewportLabel(name: str = '', label: str = '', class_: Class = Ellipsis, screen_position: IntPoint = Ellipsis, world_location: Vector = Ellipsis, distance_cm: float = 0.0)

Bases: StructBase

One labeled actor in a viewport capture’s annotation overlay.

Name is the canonical object name (unique within the level and stable across captures); Label is the human-readable text drawn on the image (actor label + position). Use Name when referring back to a specific actor, Label for display.

C++ Source:

  • Plugin: EditorToolset

  • Module: EditorToolset

  • File: EditorAppToolset.h

Editor Properties: (see get_editor_property/set_editor_property)

  • class_ (type(Class)): [Read-Write] Class of the actor.

  • distance_cm (float): [Read-Write] Distance from the camera to the actor origin (cm).

  • label (str): [Read-Write] Display label that was drawn on the image (actor label + position in meters). Not guaranteed unique.

  • name (str): [Read-Write] Canonical, level-unique name of the actor (AActor::GetName). Use this to reference the actor later.

  • screen_position (IntPoint): [Read-Write] Screen-space pixel position of the actor origin in the returned image.

  • world_location (Vector): [Read-Write] World-space location of the actor origin (cm).

property class_: Class

[Read-Only] Class of the actor.

Type:

(type(Class))

property distance_cm: float

[Read-Only] Distance from the camera to the actor origin (cm).

Type:

(float)

property label: str

[Read-Only] Display label that was drawn on the image (actor label + position in meters). Not guaranteed unique.

Type:

(str)

property name: str

[Read-Only] Canonical, level-unique name of the actor (AActor::GetName). Use this to reference the actor later.

Type:

(str)

property screen_position: IntPoint

[Read-Only] Screen-space pixel position of the actor origin in the returned image.

Type:

(IntPoint)

property world_location: Vector

[Read-Only] World-space location of the actor origin (cm).

Type:

(Vector)