bounding_box.py
rerun.log.bounding_box
def log_obb(entity_path, *, half_size, position=None, rotation_q=None, color=None, stroke_width=None, label=None, class_id=None, ext=None, timeless=False, recording=None)
Log a 3D Oriented Bounding Box, or OBB.
Example:
rr.log_obb("my_obb", half_size=[1.0, 2.0, 3.0], position=[0, 0, 0], rotation_q=[0, 0, 0, 1])
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
entity_path |
str
|
The path to the oriented bounding box in the space hierarchy. |
required |
half_size |
Optional[npt.ArrayLike]
|
Array with [x, y, z] half dimensions of the OBB. |
required |
position |
Optional[npt.ArrayLike]
|
Optional array with [x, y, z] position of the OBB in world space. |
None
|
rotation_q |
Optional[npt.ArrayLike]
|
Optional array with quaternion coordinates [x, y, z, w] for the rotation from model to world space. |
None
|
color |
Optional[Color]
|
Optional RGB or RGBA in sRGB gamma-space as either 0-1 floats or 0-255 integers, with separate alpha. |
None
|
stroke_width |
Optional[float]
|
Optional width of the line edges. |
None
|
label |
Optional[str]
|
Optional text label placed at |
None
|
class_id |
Optional[int]
|
Optional class id for the OBB. The class id provides colors and labels if not specified explicitly. |
None
|
ext |
Optional[Dict[str, Any]]
|
Optional dictionary of extension components. See rerun.log_extension_components |
None
|
timeless |
bool
|
If true, the bounding box will be timeless (default: False). |
False
|
recording |
Optional[RecordingStream]
|
Specifies the |
None
|