TextPrimitive

A primitive representing a text label

Parent schema

TextPrimitive appears in the SceneEntity message schema.

Schema

fieldtypedescription
posePosePosition of the center of the text box and orientation of the text. Identity orientation means the text is oriented in the xy-plane and flows from -x to +x.
billboardbooleanWhether the text should respect pose.orientation (false) or always face the camera (true)
font_sizefloat64Font size (height of one line of text)
scale_invariantbooleanIndicates whether font_size is a fixed size in screen pixels (true), or specified in world coordinates and scales with distance from the camera (false)
colorColorColor of the text
textstringText

Reference implementations

Foxglove schemas are framework-agnostic, and can be implemented using any supported message encoding:

encodingschema
ROS 1foxglove_msgs/TextPrimitive
ROS 2foxglove_msgs/msg/TextPrimitive
JSONfoxglove.TextPrimitive
Protobuffoxglove.TextPrimitive
FlatBuffersfoxglove.TextPrimitive

You must use the schema names specified above for Foxglove Studio to recognize the schema.