Skip to content
Impossible Robert — Unity Tools

EffectEvaluationContext

StructTextStudioTextStudio
public readonly struct EffectEvaluationContext

Context passed to effect evaluation. Contains all timing and effect area information needed for effect computation without accessing global state.

Fields

Section titled “Fields”

glyphIndex

Section titled “glyphIndex”
public readonly int glyphIndex

Index of the glyph within visible glyph array.

Returns

System.Int32

totalGlyphs

Section titled “totalGlyphs”
public readonly int totalGlyphs

Total visible glyph count.

Returns

System.Int32

wordIndex

Section titled “wordIndex”
public readonly int wordIndex

Word index the glyph belongs to.

Returns

System.Int32

lineIndex

Section titled “lineIndex”
public readonly int lineIndex

Line index the glyph belongs to.

Returns

System.Int32

phase

Section titled “phase”
public readonly AnimationPhase phase

Current animation phase for this glyph.

Returns

TextStudio.AnimationPhase

phaseProgress

Section titled “phaseProgress”
public readonly float phaseProgress

Progress within the current phase (0–1).

Returns

System.Single

time

Section titled “time”
public readonly float time

Time since text controller started (seconds).

Returns

System.Single

playbackTime

Section titled “playbackTime”
public readonly float playbackTime

Time since the current effect invocation started (seconds). This normally matches TextStudio.EffectEvaluationContext.time, but previews may restart finite playback without resetting the continuous clock used by oscillators and procedural motion.

Returns

System.Single

deltaTime

Section titled “deltaTime”
public readonly float deltaTime

Delta time since last evaluation (seconds).

Returns

System.Single

normalizedIndex

Section titled “normalizedIndex”
public readonly float normalizedIndex

Normalized position of glyph within the current effect binding (0–1).

Returns

System.Single

area

Section titled “area”
public readonly TextStudioEffectAreaMode area

Returns

TextStudio.TextStudioEffectAreaMode

groupSize

Section titled “groupSize”
public readonly int groupSize

Returns

System.Int32

unitIndex

Section titled “unitIndex”
public readonly int unitIndex

Returns

System.Int32

unitCount

Section titled “unitCount”
public readonly int unitCount

Returns

System.Int32

unitStartGlyph

Section titled “unitStartGlyph”
public readonly int unitStartGlyph

Returns

System.Int32

unitGlyphCount

Section titled “unitGlyphCount”
public readonly int unitGlyphCount

Returns

System.Int32

indexInUnit

Section titled “indexInUnit”
public readonly int indexInUnit

Returns

System.Int32

normalizedIndexInUnit

Section titled “normalizedIndexInUnit”
public readonly float normalizedIndexInUnit

Returns

System.Single

normalizedUnitIndex

Section titled “normalizedUnitIndex”
public readonly float normalizedUnitIndex

Returns

System.Single

normalizedIndexInBinding

Section titled “normalizedIndexInBinding”
public readonly float normalizedIndexInBinding

Returns

System.Single

randomSeedIndex

Section titled “randomSeedIndex”
public readonly int randomSeedIndex

Returns

System.Int32

playbackOffset

Section titled “playbackOffset”
public readonly float playbackOffset

Returns

System.Single

sourcePosition

Section titled “sourcePosition”
public readonly Vector3 sourcePosition

Glyph center from the source TMP layout, before placement.

Returns

UnityEngine.Vector3

sourceTextNormalizedPosition

Section titled “sourceTextNormalizedPosition”
public readonly Vector3 sourceTextNormalizedPosition

Glyph center normalized inside the complete source-text visual bounds. This remains stable when placement, animation, or object transforms move the glyph.

Returns

UnityEngine.Vector3

sourceColor

Section titled “sourceColor”
public readonly Color sourceColor

Immutable center sample of the glyph’s original four-corner source color.

Returns

UnityEngine.Color

hasSourceColor

Section titled “hasSourceColor”
public readonly bool hasSourceColor

Whether the active renderer supplied an original source-color sample.

Returns

System.Boolean

spatialPosition

Section titled “spatialPosition”
public readonly Vector3 spatialPosition

Glyph center after the active Text Studio placement.

Returns

UnityEngine.Vector3

worldPosition

Section titled “worldPosition”
public readonly Vector3 worldPosition

Placed glyph center transformed into world space by the owning hub.

Returns

UnityEngine.Vector3

hasInfluenceTarget

Section titled “hasInfluenceTarget”
public readonly bool hasInfluenceTarget

Whether the owning hub currently supplies a shared spatial effect target.

Returns

System.Boolean

influenceTargetLocalPosition

Section titled “influenceTargetLocalPosition”
public readonly Vector3 influenceTargetLocalPosition

Shared effect target transformed into the owning hub’s local text space.

Returns

UnityEngine.Vector3

influenceTargetWorldPosition

Section titled “influenceTargetWorldPosition”
public readonly Vector3 influenceTargetWorldPosition

Shared effect target in world space.

Returns

UnityEngine.Vector3

Constructors

Section titled “Constructors”

EffectEvaluationContext(int, int, int, int, AnimationPhase, float, float, float, float)

Section titled “EffectEvaluationContext(int, int, int, int, AnimationPhase, float, float, float, float)”
public EffectEvaluationContext(int glyphIndex, int totalGlyphs, int wordIndex, int lineIndex, AnimationPhase phase, float phaseProgress, float time, float deltaTime, float normalizedIndex)

Creates evaluation context without extended source-unit metadata.

Parameters

Name Type
glyphIndex System.Int32
totalGlyphs System.Int32
wordIndex System.Int32
lineIndex System.Int32
phase TextStudio.AnimationPhase
phaseProgress System.Single
time System.Single
deltaTime System.Single
normalizedIndex System.Single

EffectEvaluationContext(int, int, int, int, AnimationPhase, float, float, float, float, in TextStudioEffectUnitContext)

Section titled “EffectEvaluationContext(int, int, int, int, AnimationPhase, float, float, float, float, in TextStudioEffectUnitContext)”
public EffectEvaluationContext(int glyphIndex, int totalGlyphs, int wordIndex, int lineIndex, AnimationPhase phase, float phaseProgress, float time, float deltaTime, float normalizedIndex, in TextStudioEffectUnitContext unit)

Creates evaluation context with renderer-neutral source-unit metadata.

Parameters

Name Type
glyphIndex System.Int32
totalGlyphs System.Int32
wordIndex System.Int32
lineIndex System.Int32
phase TextStudio.AnimationPhase
phaseProgress System.Single
time System.Single
deltaTime System.Single
normalizedIndex System.Single
unit TextStudio.TextStudioEffectUnitContext

EffectEvaluationContext(int, int, int, int, AnimationPhase, float, float, float, float, float, in TextStudioEffectUnitContext)

Section titled “EffectEvaluationContext(int, int, int, int, AnimationPhase, float, float, float, float, float, in TextStudioEffectUnitContext)”
public EffectEvaluationContext(int glyphIndex, int totalGlyphs, int wordIndex, int lineIndex, AnimationPhase phase, float phaseProgress, float time, float playbackTime, float deltaTime, float normalizedIndex, in TextStudioEffectUnitContext unit)

Creates complete evaluation context including source-text normalized position.

Parameters

Name Type
glyphIndex System.Int32
totalGlyphs System.Int32
wordIndex System.Int32
lineIndex System.Int32
phase TextStudio.AnimationPhase
phaseProgress System.Single
time System.Single
playbackTime System.Single
deltaTime System.Single
normalizedIndex System.Single
unit TextStudio.TextStudioEffectUnitContext
© Robert Wetzold Studios