LedTextBasedDataSource

ClassLEDStudioLEDStudio

[ExecuteAlways]
public abstract class LedTextBasedDataSource : LedDataSourceBase, ILedSource, ITextBlinkSource

Common base for text-based data source components that share appearance, font and scrolling settings. Derive from this instead of LEDStudio.LedDataSourceBase for any source backed by a LEDStudio.ITextStyledSource.

Fields

_textColor

[Header("Appearance")]
[Tooltip("Text color used by this source before board brightness and material response are applied.")]
[SerializeField]
protected Color _textColor

No description is available for this member.

Returns

UnityEngine.Color — No return description is available.

_backgroundColor

[Tooltip("Optional backing color drawn behind the measured text cells. Transparent leaves playlist content visible through glyph holes and spaces.")]
[SerializeField]
protected Color _backgroundColor

No description is available for this member.

Returns

UnityEngine.Color — No return description is available.

_fontAsset

[Header("Font")]
[Tooltip("TMP font used when Text Rendering / Render Mode is Font Texture")]
[SerializeField]
protected TMP_FontAsset _fontAsset

No description is available for this member.

Returns

TMPro.TMP_FontAsset — No return description is available.

_textSettings

[Tooltip("Text sizing, alignment, wrapping and rasterization settings.")]
[SerializeField]
protected LedTextSettings _textSettings

No description is available for this member.

Returns

LEDStudio.LedTextSettings — No return description is available.

_autoScroll

[Header("Scrolling")]
[Tooltip("Automatically scroll text")]
[SerializeField]
protected bool _autoScroll

No description is available for this member.

Returns

System.Boolean — No return description is available.

_alwaysScroll

[Tooltip("Scroll even when text fits within the board width")]
[SerializeField]
protected bool _alwaysScroll

No description is available for this member.

Returns

System.Boolean — No return description is available.

_seamlessWrap

[Tooltip("When scrolling text leaves one edge, repeat it at the opposite edge instead of leaving an empty gap.")]
[SerializeField]
protected bool _seamlessWrap

No description is available for this member.

Returns

System.Boolean — No return description is available.

_seamlessWrapPaddingPixels

[Tooltip("Minimum transparent gap in source pixels between seamless text repetitions.")]
[SerializeField]
[Range(0, 512)]
protected float _seamlessWrapPaddingPixels

No description is available for this member.

Returns

System.Single — No return description is available.

_seamlessWrapDistribution

[Tooltip("Controls whether seamless text appears once or is evenly repeated across the output width.")]
[SerializeField]
protected LedSeamlessWrapDistribution _seamlessWrapDistribution

No description is available for this member.

Returns

LEDStudio.LedSeamlessWrapDistribution — No return description is available.

_scrollAxis

[Tooltip("Axis used by automatic scrolling, manual scroll offset, and seamless wrap.")]
[SerializeField]
protected LedTextScrollAxis _scrollAxis

No description is available for this member.

Returns

LEDStudio.LedTextScrollAxis — No return description is available.

_scrollSpeed

[Tooltip("Scroll speed in pixels per second (negative values scroll in the opposite direction)")]
[SerializeField]
[Range(-200, 200)]
protected float _scrollSpeed

No description is available for this member.

Returns

System.Single — No return description is available.

_enableScrollOffset

[Tooltip("Apply a custom starting position along the scrolling path. Disabled by default to avoid shifting existing text.")]
[SerializeField]
protected bool _enableScrollOffset

No description is available for this member.

Returns

System.Boolean — No return description is available.

_scrollOffsetPercent

[Tooltip("Initial position along the scrolling path. 0 starts at the beginning, 100 starts at the far end.")]
[SerializeField]
[Range(0, 100)]
protected float _scrollOffsetPercent

No description is available for this member.

Returns

System.Single — No return description is available.

_blinkSettings

[Header("Blinking")]
[Tooltip("Timed text blinking settings.")]
[SerializeField]
protected LedTextBlinkSettings _blinkSettings

No description is available for this member.

Returns

LEDStudio.LedTextBlinkSettings — No return description is available.

Properties

StyledSource

protected abstract ITextStyledSource StyledSource { get; }

The underlying text-styled source created by the subclass.

Returns

LEDStudio.ITextStyledSource — No return description is available.

BlinkSettings

public LedTextBlinkSettings BlinkSettings { get; set; }

No description is available for this member.

Returns

LEDStudio.LedTextBlinkSettings — No return description is available.

RequiresTimeUpdates

public virtual bool RequiresTimeUpdates { get; }

No description is available for this member.

Returns

System.Boolean — No return description is available.

ScrollSpeed

public float ScrollSpeed { get; set; }

No description is available for this member.

Returns

System.Single — No return description is available.

IsReady

public override sealed bool IsReady { get; }

No description is available for this member.

Returns

System.Boolean — No return description is available.

IsDirty

public override sealed bool IsDirty { get; }

No description is available for this member.

Returns

System.Boolean — No return description is available.

OutputTexture

public override sealed Texture OutputTexture { get; }

No description is available for this member.

Returns

UnityEngine.Texture — No return description is available.

Methods

CreateSource(Vector2Int)

protected abstract void CreateSource(Vector2Int targetResolution)

Create the concrete source. Called from LEDStudio.LedTextBasedDataSource.Prepare(UnityEngine.Vector2Int).

Parameters

Name	Type	Description
targetResolution	UnityEngine.Vector2Int

UpdateSubclassProperties()

protected abstract void UpdateSubclassProperties()

Push subclass-specific inspector changes during LEDStudio.LedTextBasedDataSource.UpdateSource(ImpossibleRobert.Common.Timing.TimeStep%40).

PushSubclassProperties()

protected abstract void PushSubclassProperties()

Push all subclass-specific fields to the source (called from LEDStudio.LedTextBasedDataSource.OnValidate).

ReleaseSource()

protected abstract void ReleaseSource()

Null out the concrete source reference (called from LEDStudio.LedTextBasedDataSource.Release).

BuildTextSettings()

protected LedTextSettings BuildTextSettings()

No description is available for this member.

Returns

LEDStudio.LedTextSettings — No return description is available.

ConfigureTextStyle(Color?, LedTextSettings?, TMP_FontAsset, Color?, bool, bool, bool, float, LedSeamlessWrapDistribution, LedTextScrollAxis, float, bool, float, LedTextBlinkSettings?)

public void ConfigureTextStyle(Color? textColor = null, LedTextSettings? textSettings = null, TMP_FontAsset fontAsset = null, Color? backgroundColor = null, bool autoScroll = false, bool alwaysScroll = false, bool seamlessWrap = false, float seamlessWrapPaddingPixels = 8, LedSeamlessWrapDistribution seamlessWrapDistribution = LedSeamlessWrapDistribution.SingleRepeat, LedTextScrollAxis scrollAxis = LedTextScrollAxis.Horizontal, float scrollSpeed = 30, bool enableScrollOffset = false, float scrollOffsetPercent = 0, LedTextBlinkSettings? blinkSettings = null)

No description is available for this member.

Parameters

Name	Type	Description
textColor	System.Nullable{UnityEngine.Color}
textSettings	System.Nullable{LEDStudio.LedTextSettings}
fontAsset	TMPro.TMP_FontAsset
backgroundColor	System.Nullable{UnityEngine.Color}
autoScroll	System.Boolean
alwaysScroll	System.Boolean
seamlessWrap	System.Boolean
seamlessWrapPaddingPixels	System.Single
seamlessWrapDistribution	LEDStudio.LedSeamlessWrapDistribution
scrollAxis	LEDStudio.LedTextScrollAxis
scrollSpeed	System.Single
enableScrollOffset	System.Boolean
scrollOffsetPercent	System.Single
blinkSettings	System.Nullable{LEDStudio.LedTextBlinkSettings}

Prepare(Vector2Int)

public override sealed void Prepare(Vector2Int targetResolution)

No description is available for this member.

Parameters

Name	Type	Description
targetResolution	UnityEngine.Vector2Int

UpdateSource(in TimeStep)

public override sealed void UpdateSource(in TimeStep step)

No description is available for this member.

Parameters

Name	Type	Description
step	ImpossibleRobert.Common.Timing.TimeStep

MarkClean()

public override sealed void MarkClean()

No description is available for this member.

Release()

public override sealed void Release()

No description is available for this member.

OnValidate()

protected override sealed void OnValidate()

No description is available for this member.

MarkOwningBoardDirty()

protected void MarkOwningBoardDirty()

No description is available for this member.