arrow.py
rerun.log.arrow
def log_arrow(entity_path, origin, vector=None, *, color=None, label=None, width_scale=None, ext=None, timeless=False, recording=None)
Log a 3D arrow.
An arrow is defined with an origin, and a vector. This can also be considered as start and end positions
for the arrow.
The shaft is rendered as a cylinder with radius = 0.5 * width_scale.
The tip is rendered as a cone with height = 2.0 * width_scale and radius = 1.0 * width_scale.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
entity_path |
str
|
The path to store the entity at. |
required |
origin |
Optional[npt.ArrayLike]
|
The base position of the arrow. |
required |
vector |
Optional[npt.ArrayLike]
|
The vector along which the arrow will be drawn. |
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
|
label |
Optional[str]
|
An optional text to show beside the arrow. |
None
|
width_scale |
Optional[float]
|
An optional scaling factor, default=1.0. |
None
|
ext |
Optional[Dict[str, Any]]
|
Optional dictionary of extension components. See rerun.log_extension_components |
None
|
timeless |
bool
|
The entity is not time-dependent, and will be visible at any time point. |
False
|
recording |
Optional[RecordingStream]
|
Specifies the |
None
|