Struct BulbGroup

pub struct BulbGroup<'a> {
    pub bulb_group: &'a BulbGroup,
}

Models a group of bulbs within a traffic light. All of the bulbs within a group should share the same approximate orientation. However, this is not programmatically enforced. About the bulb group pose:

• The position of the bulb group is defined as the linear offset of this bulb group’s frame relative to the frame of the traffic light that contains it. The origin of this bulb group’s frame should approximate the bulb group’s CoM.
• The orientation of the bulb group is defined as the rotational offset of this bulb group’s frame relative to the frame of the traffic light that contains it. The +Z axis should align with the bulb group’s “up” direction, and the +X axis should point in the direction that the bulb group is facing. Following a right-handed coordinate frame, the +Y axis should point left when facing the +X direction.

Fields

bulb_group: &'a BulbGroup

Implementations

impl BulbGroup<'_>

pub fn unique_id(&self) -> UniqueBulbGroupId

Returns this BulbGroup instance’s unique identifier.

pub fn id(&self) -> String

Get the id of the BulbGroup.

Return

The id of the BulbGroup.

pub fn position_traffic_light(&self) -> InertialPosition

Get the position of the BulbGroup in the traffic light.

Return

An crate::api::InertialPosition representing the position of the BulbGroup in the traffic light.

pub fn orientation_traffic_light(&self) -> Rotation

Get the orientation of the BulbGroup in the traffic light.

Return

An crate::api::Rotation representing the orientation of the BulbGroup in the traffic light.

pub fn bulbs(&self) -> Vec<Bulb<'_>>

Returns the bulbs in the bulb group.

Return

A vector of Bulbs in the bulb group.

pub fn get_bulb(&self, id: &String) -> Option<Bulb<'_>>

Get a Bulb by its id

Arguments

• id - The id of the Bulb.

Return

The Bulb with the given id. If no Bulb is found with the given id, return None.

pub fn traffic_light(&self) -> TrafficLight<'_>

Returns the parent TrafficLight of the bulb group.

Return

The parent TrafficLight of the bulb group.