Docsv3.10.0
Back to API Reference
Class

WaveModifier

Inherits:GlyphParamModifier<Params>

Sine wave traveling along the text, with a peak per axis: x = cos(Phase·frequency + cluster·spread)·amplitude.x, y = sin(Phase·frequency + cluster·spread)·amplitude.y. One axis waves along a line, two trace an ellipse and equal ones a circle. A phase held still renders that exact wave snapshot.

Remarks

The horizontal axis leads the vertical by a quarter turn, which is what makes two axes an orbit rather than a diagonal line; negating one of them reverses the orbit.

Nested Types

S
Params
public Vector2 Amplitude{ get; set }

Peak offset per axis in pixels.

public float Frequency{ get; set }

Oscillations per phase unit.

public float Spread{ get; set }

Phase offset between adjacent clusters — how far the wave travels along the text.

protected string AttributeKey{ get }
protected override Params ResolveParams()
protected override void OnGlyph()
Back to API Reference