Struct PointsAnnotation 

pub struct PointsAnnotation {
    pub timestamp: Option<Timestamp>,
    pub type: i32,
    pub points: Vec<Point2>,
    pub outline_color: Option<Color>,
    pub outline_colors: Vec<Color>,
    pub fill_color: Option<Color>,
    pub thickness: f64,
    pub metadata: Vec<KeyValuePair>,
}

An array of points on a 2D image

https://docs.foxglove.dev/docs/visualization/message-schemas/points-annotation

Fields

timestamp: Option<Timestamp>

Timestamp of annotation

type: i32

Type of points annotation to draw

points: Vec<Point2>

Points in 2D image coordinates (pixels). These coordinates use the top-left corner of the top-left pixel of the image as the origin.

outline_color: Option<Color>

Outline color

outline_colors: Vec<Color>

Per-point colors, if type is POINTS, or per-segment stroke colors, if type is LINE_LIST, LINE_STRIP or LINE_LOOP.

fill_color: Option<Color>

Fill color

thickness: f64

Stroke thickness in pixels

metadata: Vec<KeyValuePair>

Additional user-provided metadata associated with this annotation. Keys must be unique.

Implementations

impl PointsAnnotation

pub fn type(&self) -> Type

Returns the enum value of type, or the default if the field is set to an invalid enum value.

pub fn set_type(&mut self, value: Type)

Sets type to the provided enum value.

Trait Implementations

impl Clone for PointsAnnotation

fn clone(&self) -> PointsAnnotation

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PointsAnnotation

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PointsAnnotation

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PointsAnnotation

Available on crate feature serde only.

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encode for PointsAnnotation

type Error = EncodeError

The error type returned by methods in this trait.

fn get_schema() -> Option<Schema>

Returns the schema for your data.

fn get_message_encoding() -> String

Returns the message encoding for your data.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

Encodes message data to the provided buffer.

fn encoded_len(&self) -> Option<usize>

Optional. Returns an estimated encoded length for the message data.

impl Message for PointsAnnotation

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for PointsAnnotation

fn eq(&self, other: &PointsAnnotation) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for PointsAnnotation

Available on crate feature serde only.

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PointsAnnotation