Skip to content

ITextStudioStatefulPreviewProvider

InterfaceTextStudioTextStudio
public interface ITextStudioStatefulPreviewProvider

Stateful preview lifecycle for simulations and other history-dependent extensions.

void ResetPreview()

Resets preview state to its initial time and values.

void StepPreview(float deltaTime)

Advances preview state by the supplied time interval.

Parameters

Name Type
deltaTime System.Single

SeekPreview(double, TextStudioStatefulPreviewSeekMode)

Section titled “SeekPreview(double, TextStudioStatefulPreviewSeekMode)”
bool SeekPreview(double time, TextStudioStatefulPreviewSeekMode mode)

Requests a preview time. True means accepted; incremental providers can finish over later updates.

Parameters

Name Type
time System.Double
mode TextStudio.TextStudioStatefulPreviewSeekMode

Returns

System.Boolean

bool IsAvailable { get; }

Returns

System.Boolean

bool SupportsRandomAccess { get; }

Returns

System.Boolean

TextStudioStatefulPreviewFidelity Fidelity { get; }

Returns

TextStudio.TextStudioStatefulPreviewFidelity

double CurrentTime { get; }

Returns

System.Double