Skip to main content

Module prelude

Module prelude 

Source
Expand description

The preludes

Modules§

transform
Transform related things

Macros§

lagged
Construct an AnimLagged with a stagger ratio, pushing each animation in order.
seq
Construct an AnimSequence by playing each animation in order.
stack
Construct an AnimStack by pushing each animation at the same origin.

Structs§

AabbPoint
A point based on Aabb, the number in each axis means the fraction of the size of the Aabb. (0, 0, 0) is the center point.
AnimLagged
Dynamic lagged (staggered, end-filled) animation container.
AnimSequence
Dynamic sequential animation container.
AnimStack
Dynamic overlay animation container.
AudioClip
Decoded audio: interleaved f32 PCM samples.
AudioTrack
A sound’s content data: the clip plus how to play it.
CameraFrame
The data of a camera
Diag
The diagonal group (R*)³: axis-aligned non-uniform scaling.
Iterative
Adapter turning an IterativeEval into the general Eval protocol.
IterativeFn
An IterativeEval backed by a stepping function.
NotSimilarity
Error returned when an affine transform is not a similarity transform (its linear part has non-uniform scale, shear, or reflection).
Pure
Adapter turning a raw closure Fn(f64) -> T into an Eval segment.
RanimScene
Animation definition builder passed to scene constructors.
Rigid
The rigid (Euclidean) group SE(3): rotation + translation.
Similarity
The similarity group Sim(3): uniform scale + rotation + translation.
Sound
An audio leaf: plays a clip’s span inside its placed window.
Static
A constant evaluator.
Transformed
An item paired with an external transform represented by G.
Translation
The translation group T(3): pure displacements.

Enums§

CoreItem
The core ranim builtin items
LaggedFill
How an AnimLagged fills the time outside a child’s window.
ScaleHint
A hint for scaling the mobject.
TimeMark
A marker attached to a time in a scene definition.

Traits§

Aabb
Axis-Aligned Bounding Box
AlignSlice
Align a slice of items
Alignable
A trait for aligning two items
AnimIterExt
Collect iterators of animations into containers.
ApplyTransform
A group action of G on Self: baking a transform into the item’s data.
ArrangeSlice
A trait for arranging operations.
Color
A trait for items that have both fill color and stroke color
Discard
A trait for discarding a value.
Empty
A trait for items that can be empty
Eval
The general animation segment protocol: what the runtime can do with a segment.
EvalExt
Build-time conveniences over Eval, split out so Eval stays a single primitive (eval_alpha).
Extract
Extract one or more target values from a reference.
FillColor
A trait for items that have fill color
Interpolatable
A trait for interpolating to values
IntoAnimNode
A definition that can be lowered into the runtime animation tree.
IterativeEval
The capability of an iterative, stateful evaluation.
Locate
Locate a point.
Opacity
A trait for items with opacity
Partial
A trait for items that can be displayed partially
PlaybackExt
Playback parameter builders for animations that have not been placed yet.
PointsFunc
A trait for items that can apply points function.
RotateTransform
Rotating operations.
ScaleTransform
Scaling operations: the axis-aligned (diagonal group) scaling action.
ScaleTransformExt
Useful extensions for scaling operations.
ScaleTransformStrokeExt
A trait for scaling operations with stroke width.
ShiftTransform
Shifting operations.
ShiftTransformExt
Useful extensions for shifting operations.
StaticAnim
Convenience methods for zero-duration static animations.
StrokeColor
A trait for items that have stroke color
StrokeWidth
A trait for items have stroke width
TransformGroup
A transformation representation closed under identity and composition.
TransformedExt
Extension methods for attaching an exact transform representation to a value.
UniformScaleTransform
Uniform-scaling operations: the similarity-group action.
Unplaced
Capability for animation definitions that have not been fixed in parent time coordinates.
With
A trait for mutating a value in place.

Functions§

color
Parse color string to AlphaColor<Srgb>
rgb
Construct an AlphaColor<Srgb> from rgb f32, the alpha value will be 1.0
rgb8
Construct an AlphaColor<Srgb> from rgb u8, the alpha value will be 255
rgba
Construct an AlphaColor<Srgb> from rgba f32
rgba8
Construct an AlphaColor<Srgb> from rgba u8
try_color
Parse color string to AlphaColor<Srgb> without panic

Attribute Macros§

output
Define a video output.
scene
wasm_demo_doc