Skip to content

ITextStudioPathRevealSource

InterfaceTextStudioTextStudio
public interface ITextStudioPathRevealSource

Optional capability on a registered frame composer. Supplies per-unit travel times to the owning reveal schedule. The provider owns path sampling and uses the resulting frame transition for pose.

bool TryGetPathRevealRevision(out uint revision)

Returns false when timing is inactive. Change the revision when arrivals depend on new path data or settings.

Parameters

Name Type
revision System.UInt32

Returns

System.Boolean

GetMinimumAppearanceDuration(int, in GlyphPlacement)

Section titled “GetMinimumAppearanceDuration(int, in GlyphPlacement)”
float GetMinimumAppearanceDuration(int unitIndex, in GlyphPlacement placement)

Returns the minimum time, in seconds of the reveal clock, for a placed unit to arrive. The schedule accepts values from zero to 100 seconds.

Parameters

Name Type
unitIndex System.Int32
placement TextStudio.GlyphPlacement

Returns

System.Single