boxddd 0.4.0

Safe, ergonomic Rust bindings for Box3D
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

use super::*;

impl World {
    /// Tries to set the spring frequency, in hertz, on a parallel joint.
    ///
    /// All parallel-joint runtime methods return [`Error::InvalidValue`] with
    /// context `joint.type` when `joint_id` belongs to another joint family.
    /// Stale and foreign handles return [`Error::StaleHandle`] and
    /// [`Error::ForeignHandle`], respectively.
    pub fn set_parallel_joint_spring_hertz(&mut self, joint_id: JointId, hertz: f32) -> Result<()> {
        callback_state::check_not_in_callback()?;
        validation::nonnegative("parallel_joint.hertz", hertz)?;
        family_method!(self, joint_id, JointType::Parallel, {
            unsafe { ffi::b3ParallelJoint_SetSpringHertz(joint_id.into_raw(), hertz) };
        })
    }

    /// Returns the spring frequency, in hertz, of a parallel joint.
    pub fn parallel_joint_spring_hertz(&self, joint_id: JointId) -> Result<f32> {
        family_method!(self, joint_id, JointType::Parallel, {
            unsafe { ffi::b3ParallelJoint_GetSpringHertz(joint_id.into_raw()) }
        })
    }

    /// Tries to set the dimensionless spring damping ratio on a parallel joint.
    pub fn set_parallel_joint_spring_damping_ratio(
        &mut self,
        joint_id: JointId,
        damping_ratio: f32,
    ) -> Result<()> {
        callback_state::check_not_in_callback()?;
        validation::nonnegative("parallel_joint.damping_ratio", damping_ratio)?;
        family_method!(self, joint_id, JointType::Parallel, {
            unsafe {
                ffi::b3ParallelJoint_SetSpringDampingRatio(joint_id.into_raw(), damping_ratio)
            };
        })
    }

    /// Returns the dimensionless spring damping ratio of a parallel joint.
    pub fn parallel_joint_spring_damping_ratio(&self, joint_id: JointId) -> Result<f32> {
        family_method!(self, joint_id, JointType::Parallel, {
            unsafe { ffi::b3ParallelJoint_GetSpringDampingRatio(joint_id.into_raw()) }
        })
    }

    /// Tries to set the maximum spring torque, in newton-meters, on a parallel joint.
    pub fn set_parallel_joint_max_torque(&mut self, joint_id: JointId, torque: f32) -> Result<()> {
        callback_state::check_not_in_callback()?;
        validation::nonnegative("parallel_joint.max_torque", torque)?;
        family_method!(self, joint_id, JointType::Parallel, {
            unsafe { ffi::b3ParallelJoint_SetMaxTorque(joint_id.into_raw(), torque) };
        })
    }

    /// Returns the maximum spring torque, in newton-meters, of a parallel joint.
    pub fn parallel_joint_max_torque(&self, joint_id: JointId) -> Result<f32> {
        family_method!(self, joint_id, JointType::Parallel, {
            unsafe { ffi::b3ParallelJoint_GetMaxTorque(joint_id.into_raw()) }
        })
    }
}