Struct ArrowPrimitive

Struct Documentation

struct ArrowPrimitive

A primitive representing an arrow.

Public Functions

FoxgloveError encode(uint8_t *ptr, size_t len, size_t *encoded_len)

Encoded the ArrowPrimitive as protobuf to the provided buffer.

On success, writes the serialized length to *encoded_len. If the provided buffer has insufficient capacity, writes the required capacity to *encoded_len and returns FoxgloveError::BufferTooShort. If the message cannot be encoded, writes the reason to stderr and returns FoxgloveError::EncodeError.

Parameters:

  • ptr – the destination buffer. must point to at least len valid bytes.

  • len – the length of the destination buffer.

  • encoded_len – where the serialized length or required capacity will be written to.

Public Members

std::optional<Pose> pose

Position of the arrow’s tail and orientation of the arrow. Identity orientation means the arrow points in the +x direction.

double shaft_length = 0

Length of the arrow shaft.

double shaft_diameter = 0

Diameter of the arrow shaft.

double head_length = 0

Length of the arrow head.

double head_diameter = 0

Diameter of the arrow head.

std::optional<Color> color

Color of the arrow.

Public Static Functions

static Schema schema()

Get the ArrowPrimitive schema.

The schema data returned is statically allocated.