Skip to content

TextStudio2DAnimatedEffectSpec

StructTextStudioTextStudio
public struct TextStudio2DAnimatedEffectSpec

Compact deterministic parameters shared by the animated Appearance family. Playback uses the owning Text Studio presentation clock, so scrubbing, pause, reverse, and reduced motion remain coherent.

TextStudio2DAnimatedEffectSpec(TextStudio2DAnimatedEffectKind, TextStudio2DMappingSpace, float, float, float, float, float, float, float, float, Vector2, Color, Color, int, int, TextStudioReducedMotionBehavior)

Section titled “TextStudio2DAnimatedEffectSpec(TextStudio2DAnimatedEffectKind, TextStudio2DMappingSpace, float, float, float, float, float, float, float, float, Vector2, Color, Color, int, int, TextStudioReducedMotionBehavior)”
public TextStudio2DAnimatedEffectSpec(TextStudio2DAnimatedEffectKind kind, TextStudio2DMappingSpace mapping, float amount, float speed, float phase, float scale, float width, float softness, float amplitude, float frequency, Vector2 direction, Color primaryColor, Color secondaryColor, int seed, int historyFrames, TextStudioReducedMotionBehavior reducedMotionBehavior)

Creates an animated-effect specification with the supplied mapping, timing, shape, colors, seed, history, and reduced-motion behavior.

Parameters

NameType
kindTextStudio.TextStudio2DAnimatedEffectKind
mappingTextStudio.TextStudio2DMappingSpace
amountSystem.Single
speedSystem.Single
phaseSystem.Single
scaleSystem.Single
widthSystem.Single
softnessSystem.Single
amplitudeSystem.Single
frequencySystem.Single
directionUnityEngine.Vector2
primaryColorUnityEngine.Color
secondaryColorUnityEngine.Color
seedSystem.Int32
historyFramesSystem.Int32
reducedMotionBehaviorTextStudio.TextStudioReducedMotionBehavior

public static TextStudio2DAnimatedEffectSpec Preset(TextStudio2DAnimatedEffectKind kind)

Returns a polished deterministic starting point for an animated family.

Parameters

NameType
kindTextStudio.TextStudio2DAnimatedEffectKind

Returns

TextStudio.TextStudio2DAnimatedEffectSpec

public TextStudio2DAnimatedEffectSpec WithTiming(float amount, float speed, float phase)

Returns an animated-effect copy with the supplied amount, speed, and phase.

Parameters

NameType
amountSystem.Single
speedSystem.Single
phaseSystem.Single

Returns

TextStudio.TextStudio2DAnimatedEffectSpec

WithShape(float, float, float, float, float, Vector2)

Section titled “WithShape(float, float, float, float, float, Vector2)”
public TextStudio2DAnimatedEffectSpec WithShape(float scale, float width, float softness, float amplitude, float frequency, Vector2 direction)

Returns an animated-effect copy with the supplied scale, width, softness, amplitude, frequency, and direction.

Parameters

NameType
scaleSystem.Single
widthSystem.Single
softnessSystem.Single
amplitudeSystem.Single
frequencySystem.Single
directionUnityEngine.Vector2

Returns

TextStudio.TextStudio2DAnimatedEffectSpec

public TextStudio2DAnimatedEffectSpec WithColors(Color primary, Color secondary)

Returns an animated-effect copy with the supplied primary and secondary colors.

Parameters

NameType
primaryUnityEngine.Color
secondaryUnityEngine.Color

Returns

TextStudio.TextStudio2DAnimatedEffectSpec

public TextStudio2DAnimatedEffectSpec WithMapping(TextStudio2DMappingSpace mapping)

Returns an animated-effect copy using the supplied mapping space.

Parameters

NameType
mappingTextStudio.TextStudio2DMappingSpace

Returns

TextStudio.TextStudio2DAnimatedEffectSpec

public TextStudio2DAnimatedEffectSpec WithSeed(int seed)

Returns an animated-effect copy using the supplied deterministic seed.

Parameters

NameType
seedSystem.Int32

Returns

TextStudio.TextStudio2DAnimatedEffectSpec

public TextStudio2DAnimatedEffectSpec WithHistoryFrames(int historyFrames)

Returns an animated-effect copy with the supplied temporal-history frame count.

Parameters

NameType
historyFramesSystem.Int32

Returns

TextStudio.TextStudio2DAnimatedEffectSpec

WithReducedMotion(TextStudioReducedMotionBehavior)

Section titled “WithReducedMotion(TextStudioReducedMotionBehavior)”
public TextStudio2DAnimatedEffectSpec WithReducedMotion(TextStudioReducedMotionBehavior behavior)

Returns an animated-effect copy with the supplied reduced-motion behavior.

Parameters

NameType
behaviorTextStudio.TextStudioReducedMotionBehavior

Returns

TextStudio.TextStudio2DAnimatedEffectSpec

public TextStudio2DAnimatedEffectKind Kind { get; }

Returns

TextStudio.TextStudio2DAnimatedEffectKind

public TextStudio2DMappingSpace Mapping { get; }

Returns

TextStudio.TextStudio2DMappingSpace

public float Amount { get; }

Returns

System.Single

public float Speed { get; }

Returns

System.Single

public float Phase { get; }

Returns

System.Single

public float Scale { get; }

Returns

System.Single

public float Width { get; }

Returns

System.Single

public float Softness { get; }

Returns

System.Single

public float Amplitude { get; }

Returns

System.Single

public float Frequency { get; }

Returns

System.Single

public Vector2 Direction { get; }

Returns

UnityEngine.Vector2

public Color PrimaryColor { get; }

Returns

UnityEngine.Color

public Color SecondaryColor { get; }

Returns

UnityEngine.Color

public int Seed { get; }

Returns

System.Int32

public int HistoryFrames { get; }

Returns

System.Int32

public TextStudioReducedMotionBehavior ReducedMotionBehavior { get; }

Returns

TextStudio.TextStudioReducedMotionBehavior