token-value-map 0.2.1

A token-value map with interpolation of values: what you need for DCCs
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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

# `token-value-map`

Time-based data mapping library for animation and interpolation.

## Overview

Types for storing and manipulating data that changes over time, with automatic
interpolation between keyframes. Supports uniform (constant) and animated
(time-varying) values with multiple interpolation methods.
Think your Maya/Blender/Houdini/whatever Attribute Editor.

## Features

- `Token` key type -- wraps `ustr::Ustr` (with `ustr` feature, default) for
  O(1) interned string comparison, or plain `String` without it.
- Scalar types: `Boolean`, `Integer`, `Real`, `String`.
- `Color`.
- 2D types: `Vector2`, `Matrix3`.
- 3D types: `Vector3`, `Point3`, `Normal3`, `Matrix4`.
- Collection variants of all types.
- Curve types for curves/ramps: `RealCurve`, `ColorCurve` (with `curves`
  feature, default).
- Linear, quadratic, and hermite interpolation.
- Motion blur sampling support.

## Feature Flags

- `default` -- Includes `builtin-types`, `2d`, `vec_variants`, `glam`, `ustr`,
  `curves`.
- `ustr` -- Use `ustr` for interned string `Token` keys (default on). Without
  this, `Token` wraps `String`.
- `curves` -- Enable `RealCurve` and `ColorCurve` for position-keyed parameter
  mappings.
- `2d` -- Enable 2D types (`Vector2`, `Matrix3`).
- `3d` -- Enable 3D types (`Vector3`, `Matrix4`, `Normal3`, `Point3`).
- `vec_variants` -- Enable vector collection types.
- `interpolation` -- Enable keyframe interpolation with Bezier handles.
- `serde` -- Enable serialization/deserialization via `serde`.
- `rkyv` -- Enable zero-copy deserialization via `rkyv` (requires `glam`
  backend).
- `facet` -- Enable reflection/introspection via `facet`.
- `lua` -- Enable Lua bindings via `mlua`.
- `glam` / `nalgebra` / `ultraviolet` -- Math backend (mutually exclusive,
  `glam` is default).
- `mint` -- Enable `mint` interop for cross-library type conversion.

## Example

```rust
use frame_tick::Tick;
use token_value_map::{Token, TokenValueMap, Value};

// Create a token-value map for animation parameters.
let mut params = TokenValueMap::new();

// Add uniform (constant) values.
params.insert(Token::new("radius"), Value::uniform(5.0));

// Add animated values with keyframes.
let animated_position = Value::animated(vec![
    (Tick::new(0), 0.0),
    (Tick::new(30), 100.0),
    (Tick::new(60), 50.0),
]).unwrap();
params.insert(Token::new("x_position"), animated_position);

// Interpolate animated value at any time.
if let Some(value) = params.get(&Token::new("x_position")) {
    let interpolated = value.interpolate(Tick::new(15)); // Returns 50.0
}
```

## License

Licensed under either of

- [Apache License](http://www.apache.org/licenses/LICENSE-2.0)
- [BSD-3-Clause license](https://opensource.org/licenses/BSD-3-Clause)
- [MIT license](http://opensource.org/licenses/MIT)
- [Zlib license](http://opensource.org/licenses/Zlib)

at your option.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
quad-licensed as above, without any additional terms or conditions.