boxddd 0.3.0

Safe, ergonomic Rust bindings for Box3D
Documentation
use super::*;

impl World {
    /// Tries to set the rest length, in world length units, on a distance joint.
    ///
    /// All distance-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_distance_joint_length(&mut self, joint_id: JointId, length: f32) -> Result<()> {
        validation::nonnegative("distance_joint.length", length)?;
        family_method!(self, joint_id, JointType::Distance, {
            unsafe { ffi::b3DistanceJoint_SetLength(joint_id.into_raw(), length) };
        })
    }

    /// Returns the rest length, in world length units, of a distance joint.
    pub fn distance_joint_length(&self, joint_id: JointId) -> Result<f32> {
        family_method!(self, joint_id, JointType::Distance, {
            unsafe { ffi::b3DistanceJoint_GetLength(joint_id.into_raw()) }
        })
    }

    /// Tries to enable or disable the spring on a distance joint.
    pub fn enable_distance_joint_spring(&mut self, joint_id: JointId, enabled: bool) -> Result<()> {
        family_method!(self, joint_id, JointType::Distance, {
            unsafe { ffi::b3DistanceJoint_EnableSpring(joint_id.into_raw(), enabled) };
        })
    }

    /// Returns whether the spring is enabled on a distance joint.
    pub fn distance_joint_spring_enabled(&self, joint_id: JointId) -> Result<bool> {
        family_method!(self, joint_id, JointType::Distance, {
            unsafe { ffi::b3DistanceJoint_IsSpringEnabled(joint_id.into_raw()) }
        })
    }

    /// Tries to set the spring force range on a distance joint.
    pub fn set_distance_joint_spring_force_range(
        &mut self,
        joint_id: JointId,
        lower: f32,
        upper: f32,
    ) -> Result<()> {
        validation::finite("distance_joint.spring_force_range", lower)?;
        validation::finite("distance_joint.spring_force_range", upper)?;
        family_method!(self, joint_id, JointType::Distance, {
            unsafe { ffi::b3DistanceJoint_SetSpringForceRange(joint_id.into_raw(), lower, upper) };
        })
    }

    /// Returns the spring force range of a distance joint.
    pub fn distance_joint_spring_force_range(&self, joint_id: JointId) -> Result<(f32, f32)> {
        family_method!(self, joint_id, JointType::Distance, {
            let mut lower = 0.0;
            let mut upper = 0.0;
            unsafe {
                ffi::b3DistanceJoint_GetSpringForceRange(
                    joint_id.into_raw(),
                    &mut lower,
                    &mut upper,
                )
            };
            (lower, upper)
        })
    }

    /// Tries to set the spring frequency, in hertz, on a distance joint.
    pub fn set_distance_joint_spring_hertz(&mut self, joint_id: JointId, hertz: f32) -> Result<()> {
        validation::nonnegative("distance_joint.hertz", hertz)?;
        family_method!(self, joint_id, JointType::Distance, {
            unsafe { ffi::b3DistanceJoint_SetSpringHertz(joint_id.into_raw(), hertz) };
        })
    }

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

    /// Tries to set the dimensionless spring damping ratio on a distance joint.
    pub fn set_distance_joint_spring_damping_ratio(
        &mut self,
        joint_id: JointId,
        damping_ratio: f32,
    ) -> Result<()> {
        validation::nonnegative("distance_joint.damping_ratio", damping_ratio)?;
        family_method!(self, joint_id, JointType::Distance, {
            unsafe {
                ffi::b3DistanceJoint_SetSpringDampingRatio(joint_id.into_raw(), damping_ratio)
            };
        })
    }

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

    /// Tries to enable or disable the limit on a distance joint.
    pub fn enable_distance_joint_limit(&mut self, joint_id: JointId, enabled: bool) -> Result<()> {
        family_method!(self, joint_id, JointType::Distance, {
            unsafe { ffi::b3DistanceJoint_EnableLimit(joint_id.into_raw(), enabled) };
        })
    }

    /// Returns whether the limit is enabled on a distance joint.
    pub fn distance_joint_limit_enabled(&self, joint_id: JointId) -> Result<bool> {
        family_method!(self, joint_id, JointType::Distance, {
            unsafe { ffi::b3DistanceJoint_IsLimitEnabled(joint_id.into_raw()) }
        })
    }

    /// Tries to set the length range, in world length units, on a distance joint.
    pub fn set_distance_joint_length_range(
        &mut self,
        joint_id: JointId,
        min: f32,
        max: f32,
    ) -> Result<()> {
        validate_length_range("distance_joint.length_range", min, max)?;
        family_method!(self, joint_id, JointType::Distance, {
            unsafe { ffi::b3DistanceJoint_SetLengthRange(joint_id.into_raw(), min, max) };
        })
    }

    /// Returns the minimum length, in world length units, of a distance joint.
    pub fn distance_joint_min_length(&self, joint_id: JointId) -> Result<f32> {
        family_method!(self, joint_id, JointType::Distance, {
            unsafe { ffi::b3DistanceJoint_GetMinLength(joint_id.into_raw()) }
        })
    }

    /// Returns the maximum length, in world length units, of a distance joint.
    pub fn distance_joint_max_length(&self, joint_id: JointId) -> Result<f32> {
        family_method!(self, joint_id, JointType::Distance, {
            unsafe { ffi::b3DistanceJoint_GetMaxLength(joint_id.into_raw()) }
        })
    }

    /// Returns the current length, in world length units, of a distance joint.
    pub fn distance_joint_current_length(&self, joint_id: JointId) -> Result<f32> {
        family_method!(self, joint_id, JointType::Distance, {
            unsafe { ffi::b3DistanceJoint_GetCurrentLength(joint_id.into_raw()) }
        })
    }

    /// Tries to enable or disable the motor on a distance joint.
    pub fn enable_distance_joint_motor(&mut self, joint_id: JointId, enabled: bool) -> Result<()> {
        family_method!(self, joint_id, JointType::Distance, {
            unsafe { ffi::b3DistanceJoint_EnableMotor(joint_id.into_raw(), enabled) };
        })
    }

    /// Returns whether the motor is enabled on a distance joint.
    pub fn distance_joint_motor_enabled(&self, joint_id: JointId) -> Result<bool> {
        family_method!(self, joint_id, JointType::Distance, {
            unsafe { ffi::b3DistanceJoint_IsMotorEnabled(joint_id.into_raw()) }
        })
    }

    /// Tries to set the motor speed, in length units per second, on a distance joint.
    pub fn set_distance_joint_motor_speed(&mut self, joint_id: JointId, speed: f32) -> Result<()> {
        validation::finite("distance_joint.motor_speed", speed)?;
        family_method!(self, joint_id, JointType::Distance, {
            unsafe { ffi::b3DistanceJoint_SetMotorSpeed(joint_id.into_raw(), speed) };
        })
    }

    /// Returns the motor speed, in length units per second, of a distance joint.
    pub fn distance_joint_motor_speed(&self, joint_id: JointId) -> Result<f32> {
        family_method!(self, joint_id, JointType::Distance, {
            unsafe { ffi::b3DistanceJoint_GetMotorSpeed(joint_id.into_raw()) }
        })
    }

    /// Tries to set the maximum motor force, in newtons, on a distance joint.
    pub fn set_distance_joint_max_motor_force(
        &mut self,
        joint_id: JointId,
        force: f32,
    ) -> Result<()> {
        validation::nonnegative("distance_joint.max_motor_force", force)?;
        family_method!(self, joint_id, JointType::Distance, {
            unsafe { ffi::b3DistanceJoint_SetMaxMotorForce(joint_id.into_raw(), force) };
        })
    }

    /// Returns the maximum motor force, in newtons, of a distance joint.
    pub fn distance_joint_max_motor_force(&self, joint_id: JointId) -> Result<f32> {
        family_method!(self, joint_id, JointType::Distance, {
            unsafe { ffi::b3DistanceJoint_GetMaxMotorForce(joint_id.into_raw()) }
        })
    }

    /// Returns the current motor force, in newtons, of a distance joint.
    pub fn distance_joint_motor_force(&self, joint_id: JointId) -> Result<f32> {
        family_method!(self, joint_id, JointType::Distance, {
            unsafe { ffi::b3DistanceJoint_GetMotorForce(joint_id.into_raw()) }
        })
    }
}