Struct Bulb

pub struct Bulb<'a> {
    pub bulb: &'a Bulb,
}

Models a bulb within a bulb group.

Fields

bulb: &'a Bulb

Implementations

impl Bulb<'_>

pub fn unique_id(&self) -> UniqueBulbId

Returns this Bulb instance’s unique identifier.

pub fn id(&self) -> String

Get the id of the Bulb.

Return

The id of the Bulb.

pub fn color(&self) -> BulbColor

Get the color of the Bulb.

Return

The BulbColor.

pub fn bulb_type(&self) -> BulbType

Get the type of the Bulb.

Return

The BulbType.

pub fn position_bulb_group(&self) -> InertialPosition

Get the position of the Bulb in the bulb group.

Return

An crate::api::InertialPosition representing the position of the Bulb in the bulb group.

pub fn orientation_bulb_group(&self) -> Rotation

Get the orientation of the Bulb in the bulb group.

Return

An crate::api::Rotation representing the orientation of the Bulb in the bulb group.

pub fn arrow_orientation_rad(&self) -> Option<f64>

Returns the arrow’s orientation. Only applicable if Bulb::bulb_type returns BulbType::Arrow.

pub fn states(&self) -> Vec<BulbState>

Get the possible states of the Bulb.

pub fn get_default_state(&self) -> BulbState

Get the default state of the Bulb.

pub fn is_valid_state(&self, state: &BulbState) -> bool

Check if the given state is possible valid for the Bulb.

pub fn bounding_box(&self) -> (Vector3, Vector3)

Returns the bounding box of the bulb.

Return

A tuple containing the minimum and maximum points of the bounding box.

pub fn bulb_group(&self) -> BulbGroup<'_>

Returns the parent BulbGroup of the bulb.

Return

The parent BulbGroup of the bulb. If the bulb is not part of any group, return None.