diff options
| author | Thierry Berger <contact@thierryberger.com> | 2024-07-12 16:29:22 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2024-07-12 16:29:22 +0200 |
| commit | 01dd2001525850ef0d66374c69e98e1560cb6421 (patch) | |
| tree | 5901b3c00d9ffc53a9af34e0023241eff256c8bc /src/dynamics | |
| parent | 87ada34008f4a1a313ccf8c3040040bab4f10e69 (diff) | |
| download | rapier-01dd2001525850ef0d66374c69e98e1560cb6421.tar.gz rapier-01dd2001525850ef0d66374c69e98e1560cb6421.tar.bz2 rapier-01dd2001525850ef0d66374c69e98e1560cb6421.zip | |
ci: cargo doc step (#671)
Diffstat (limited to 'src/dynamics')
| -rw-r--r-- | src/dynamics/integration_parameters.rs | 5 | ||||
| -rw-r--r-- | src/dynamics/joint/multibody_joint/multibody.rs | 6 | ||||
| -rw-r--r-- | src/dynamics/rigid_body.rs | 3 | ||||
| -rw-r--r-- | src/dynamics/rigid_body_components.rs | 3 |
4 files changed, 14 insertions, 3 deletions
diff --git a/src/dynamics/integration_parameters.rs b/src/dynamics/integration_parameters.rs index f475fd4..99b6fe4 100644 --- a/src/dynamics/integration_parameters.rs +++ b/src/dynamics/integration_parameters.rs @@ -2,6 +2,9 @@ use crate::math::Real; use na::RealField; use std::num::NonZeroUsize; +#[cfg(doc)] +use super::RigidBodyActivation; + // TODO: enabling the block solver in 3d introduces a lot of jitters in // the 3D domino demo. So for now we dont enable it in 3D. pub(crate) static BLOCK_SOLVER_ENABLED: bool = cfg!(feature = "dim2"); @@ -66,7 +69,7 @@ pub struct IntegrationParameters { /// This value is used internally to estimate some length-based tolerance. In particular, the /// values [`IntegrationParameters::allowed_linear_error`], /// [`IntegrationParameters::max_corrective_velocity`], - /// [`IntegrationParameters::prediction_distance`], [`RigidBodyActivation::linear_threshold`] + /// [`IntegrationParameters::prediction_distance`], [`RigidBodyActivation::normalized_linear_threshold`] /// are scaled by this value implicitly. /// /// This value can be understood as the number of units-per-meter in your physical world compared diff --git a/src/dynamics/joint/multibody_joint/multibody.rs b/src/dynamics/joint/multibody_joint/multibody.rs index 7832abe..6859fd9 100644 --- a/src/dynamics/joint/multibody_joint/multibody.rs +++ b/src/dynamics/joint/multibody_joint/multibody.rs @@ -13,6 +13,9 @@ use na::{ StorageMut, LU, }; +#[cfg(doc)] +use crate::prelude::{GenericJoint, RigidBody}; + #[repr(C)] #[derive(Copy, Clone, Debug, Default)] struct Force { @@ -861,8 +864,7 @@ impl Multibody { /// Apply displacements, in generalized coordinates, to this multibody. /// /// Note this does **not** updates the link poses, only their generalized coordinates. - /// To update the link poses and associated rigid-bodies, call [`Self::forward_kinematics`] - /// or [`Self::finalize`]. + /// To update the link poses and associated rigid-bodies, call [`Self::forward_kinematics`]. pub fn apply_displacements(&mut self, disp: &[Real]) { for link in self.links.iter_mut() { link.joint.apply_displacement(&disp[link.assembly_id..]) diff --git a/src/dynamics/rigid_body.rs b/src/dynamics/rigid_body.rs index 50e3211..8522d4d 100644 --- a/src/dynamics/rigid_body.rs +++ b/src/dynamics/rigid_body.rs @@ -10,6 +10,9 @@ use crate::math::{AngVector, Isometry, Point, Real, Rotation, Vector}; use crate::utils::SimdCross; use num::Zero; +#[cfg(doc)] +use super::IntegrationParameters; + #[cfg_attr(feature = "serde-serialize", derive(Serialize, Deserialize))] /// A rigid body. /// diff --git a/src/dynamics/rigid_body_components.rs b/src/dynamics/rigid_body_components.rs index 641434c..38ba491 100644 --- a/src/dynamics/rigid_body_components.rs +++ b/src/dynamics/rigid_body_components.rs @@ -10,6 +10,9 @@ use crate::parry::partitioning::IndexedData; use crate::utils::{SimdAngularInertia, SimdCross, SimdDot}; use num::Zero; +#[cfg(doc)] +use super::IntegrationParameters; + /// The unique handle of a rigid body added to a `RigidBodySet`. #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, Default)] #[cfg_attr(feature = "serde-serialize", derive(Serialize, Deserialize))] |
