use-rigidbody 0.0.1

Rigid-body mass properties and scalar mechanics helpers for RustUse
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

# use-rigidbody

Rigid-body mass properties and scalar mechanics helpers for `RustUse`.

## Install

```toml
[dependencies]
use-rigidbody = "0.0.1"
```

## Foundation

`use-rigidbody` provides small `f64`-first helpers for scalar rigid-body mechanics primitives:
mass properties, center of mass, moments of inertia, kinetic energy, angular momentum, simple
impulse response, and small rigid-body state helpers.

Inputs are expected to be SI-style numeric values:

- kilograms for mass
- meters for position, radius, length, and distance
- meters per second for velocity
- radians for angle
- radians per second for angular velocity
- kilogram square meters for moment of inertia
- kilogram meters per second for linear momentum
- kilogram square meters per second for angular momentum
- joules for kinetic energy
- newton-seconds for impulse

Vector mechanics should compose with `use-vector`.

Simulation loops belong in top-level `use-simulation`.

Collision-specific helpers belong in `use-collision`.

Rotation-specific helpers belong in `use-rotation`.

Torque-specific helpers belong in `use-torque`.

## Example

```rust
use use_rigidbody::{MassProperties, RigidBody1D, total_kinetic_energy};

let props = MassProperties::solid_sphere(5.0, 2.0).unwrap();
let body = RigidBody1D::new(props, 10.0, 3.0, 1.0, 5.0).unwrap();

assert_eq!(body.linear_momentum(), Some(15.0));
assert_eq!(body.rotational_kinetic_energy(), Some(100.0));
assert_eq!(total_kinetic_energy(5.0, 3.0, 8.0, 5.0), Some(122.5));
```

## When to use directly

Choose `use-rigidbody` when you need small, reusable scalar helpers for rigid-body mass
properties, inertia, momentum, kinetic energy, and simple kinematic state updates.

## Scope

- APIs stay `f64`-first and focus on scalar rigid-body mechanics primitives.
- This crate is not a physics engine, collision detector, contact solver, constraint solver, game
  physics package, or simulation framework.
- Vector rigid-body dynamics, joints, broad phase, narrow phase, and simulation loops are out of
  scope.

## Status

`use-rigidbody` is a pre-1.0 crate with a deliberately small API.