carla 0.14.1

Rust client library for Carla simulator
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86

use super::{Actor, ActorBase};
use crate::{error::ffi::with_ffi_error, geom::BoundingBox, road::SignId};
use carla_sys::carla_rust::client::{FfiActor, FfiTrafficSign};
use cxx::SharedPtr;
use derivative::Derivative;
use static_assertions::assert_impl_all;

/// Represents a traffic sign in the simulation.
///
/// Traffic signs provide information to drivers about road rules, warnings,
/// and directions. They are static actors in the world.
///
/// Corresponds to [`carla.TrafficSign`](https://carla.readthedocs.io/en/0.9.16/python_api/#carla.TrafficSign) in the Python API.
///
/// # Examples
///
/// ```no_run
/// use carla::client::{ActorBase, Client};
///
/// # fn main() -> Result<(), Box<dyn std::error::Error>> {
/// let client = Client::default();
/// let world = client.world();
///
/// // Get all actors in the world
/// let actors = world.actors();
/// for actor in actors.iter() {
///     // Try to convert to traffic sign
///     if let Ok(sign) = carla::client::TrafficSign::try_from(actor.clone()) {
///         println!("Traffic sign at: {:?}", sign.location());
///         println!("Sign ID: {}", sign.sign_id()?);
///     }
/// }
/// # Ok(())
/// # }
/// ```
#[derive(Clone, Derivative)]
#[derivative(Debug)]
pub struct TrafficSign {
    #[derivative(Debug = "ignore")]
    inner: SharedPtr<FfiTrafficSign>,
}

impl TrafficSign {
    /// Returns the OpenDRIVE sign ID.
    ///
    /// See [carla.TrafficSign.get_opendrive_id](https://carla.readthedocs.io/en/0.9.16/python_api/#carla.TrafficSign) in the Python API.
    pub fn sign_id(&self) -> crate::Result<SignId> {
        let id = with_ffi_error("sign_id", |e| self.inner.GetSignId(e))?;
        Ok(id.to_string())
    }

    /// Returns the trigger volume bounding box.
    ///
    /// See [carla.TrafficSign.get_trigger_volume](https://carla.readthedocs.io/en/0.9.16/python_api/#carla.TrafficSign) in the Python API.
    ///
    /// The trigger volume is the area where the sign affects vehicles.
    pub fn trigger_volume(&self) -> crate::Result<BoundingBox> {
        let bbox = with_ffi_error("trigger_volume", |e| self.inner.GetTriggerVolume(e))?;
        Ok(BoundingBox::from_native(&bbox))
    }

    fn from_cxx(ptr: SharedPtr<FfiTrafficSign>) -> Option<Self> {
        if ptr.is_null() {
            None
        } else {
            Some(Self { inner: ptr })
        }
    }
}

impl ActorBase for TrafficSign {
    fn cxx_actor(&self) -> SharedPtr<FfiActor> {
        self.inner.to_actor()
    }
}

impl TryFrom<Actor> for TrafficSign {
    type Error = Actor;

    fn try_from(value: Actor) -> Result<Self, Self::Error> {
        let ptr = value.inner.to_traffic_sign();
        Self::from_cxx(ptr).ok_or(value)
    }
}

assert_impl_all!(TrafficSign: Send, Sync);