Skip to main content

Interface: WaveLettersOptions

Defined in: src/animation/text/kineticTypography.ts:193

Options for waveLetters.

Extends​

Properties​

amplitude?​

optional amplitude: number

Defined in: src/animation/text/kineticTypography.ts:195

Peak displacement of the wave. Default: 0.2.

direction?​

optional direction: Vector3Tuple

Defined in: src/animation/text/kineticTypography.ts:201

Unit direction of displacement. Default: up [0, 1, 0].

duration?​

optional duration: number

Defined in: src/animation/Animation.ts:16

Duration of the animation in seconds (default: 1)

Inherited from​

AnimationOptions.duration

phase?​

optional phase: number

Defined in: src/animation/text/kineticTypography.ts:199

Phase offset between consecutive glyphs, in radians. Default: PI/3.

rateFunc?​

optional rateFunc: RateFunction

Defined in: src/animation/Animation.ts:18

Rate function controlling the animation's pacing (default: smooth)

Inherited from​

AnimationOptions.rateFunc

shift?​

optional shift: [number, number, number]

Defined in: src/animation/Animation.ts:20

Shift direction for fade animations

Inherited from​

AnimationOptions.shift

waves?​

optional waves: number

Defined in: src/animation/text/kineticTypography.ts:197

Number of full oscillation cycles over the run. Default: 2.