Skip to content

Commit 98c867f

Browse files
authored
Update Body docstring
1 parent c93c37a commit 98c867f

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

src/components.jl

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -201,16 +201,18 @@ To obtain an axis-angle representation of any rotation, see [Conversion between
201201
end
202202

203203
"""
204-
Body(; name, m = 1, r_cm, I = collect(0.001 * LinearAlgebra.I(3)), isroot = false, phi0 = zeros(3), phid0 = zeros(3), r_0=zeros(3))
204+
Body(; name, m = 1, r_cm, isroot = false, phi0 = zeros(3), phid0 = zeros(3), r_0=zeros(3))
205205
206206
Representing a body with 3 translational and 3 rotational degrees-of-freedom.
207207
208+
This component has a single frame, `frame_a`. To represent bodies with more than one frame, see [`BodyShape`](@ref), [`BodyCylinder`](@ref), [`BodyBox`](@ref).
209+
208210
# Parameters
209211
- `m`: Mass
210212
- `r_cm`: Vector from `frame_a` to center of mass, resolved in `frame_a`
211-
- `I`: Inertia matrix of the body
213+
- `I_11, I_22, I_33, I_21, I_31, I_32`: Inertia-matrix elements
212214
- `isroot`: Indicate whether this component is the root of the system, useful when there are no joints in the model.
213-
- `phi0`: Initial orientation, only applicable if `isroot = true`
215+
- `phi0`: Initial orientation, only applicable if `isroot = true` and `quat = false`
214216
- `phid0`: Initial angular velocity
215217
216218
# Variables
@@ -919,4 +921,4 @@ end
919921
# connect(frame_a, body.frame_a)
920922
# ]
921923
# ODESystem(equations, t, vars, pars; name, systems)
922-
# end
924+
# end

0 commit comments

Comments
 (0)