Skip to content

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 ArrayLike | None

Array with [x, y, z] half dimensions of the OBB.

 required
position ArrayLike | None

Optional array with [x, y, z] position of the OBB in world space.

 None
rotation_q ArrayLike | None

Optional array with quaternion coordinates [x, y, z, w] for the rotation from model to world space.

 None
color Color | None

Optional RGB or RGBA in sRGB gamma-space as either 0-1 floats or 0-255 integers, with separate alpha.

 None
stroke_width float | None

Optional width of the line edges.

 None
label str | None

Optional text label placed at position.

 None
class_id int | None

Optional class id for the OBB. The class id provides colors and labels if not specified explicitly.

 None
ext dict[str, Any] | None

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 RecordingStream | None

Specifies the rerun.RecordingStream to use. If left unspecified, defaults to the current active data recording, if there is one. See also: rerun.init, rerun.set_global_data_recording.

 None

def log_obbs(entity_path, *, half_sizes, positions=None, rotations_q=None, colors=None, stroke_widths=None, labels=None, class_ids=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_sizes ArrayLike | None

Nx3 Array. Each row is the [x, y, z] half dimensions of an OBB.

 required
positions ArrayLike | None

Optional Nx3 array. Each row is [x, y, z] positions of an OBB in world space.

 None
rotations_q ArrayLike | None

Optional Nx3 array. Each row is quaternion coordinates [x, y, z, w] for the rotation from model to world space.

 None
colors Color | Colors | None

Optional Nx3 or Nx4 array. Each row is RGB or RGBA in sRGB gamma-space as either 0-1 floats or 0-255 integers, with separate alpha.

 None
stroke_widths ArrayLike | None

Optional array of the width of the line edges.

 None
labels Sequence[str] | None

Optional array of text labels placed at position.

 None
class_ids OptionalClassIds | None

Optional array of class id for the OBBs. The class id provides colors and labels if not specified explicitly.

 None
ext dict[str, Any] | None

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 RecordingStream | None

Specifies the rerun.RecordingStream to use. If left unspecified, defaults to the current active data recording, if there is one. See also: rerun.init, rerun.set_global_data_recording.

 None