LayerSelection3DSpec

StructTextStudio.ThreeDTextStudio.3D

public struct LayerSelection3DSpec

Selects which visible glyphs receive a layer without changing the layer’s geometry recipe. Selection is evaluated before stacking, so omitted layers consume no depth for that glyph.

Fields

mode

[Tooltip("Which visible glyphs receive this layer. All applies it everywhere; Visible Glyph Range uses the zero-based start and count; Characters matches Unicode codepoints in the character set.")]
public LayerSelection3DMode mode

Returns

TextStudio.ThreeD.LayerSelection3DMode

startIndex

[Tooltip("Zero-based first visible glyph included by Visible Glyph Range.")]
[Min(0)]
public int startIndex

Returns

System.Int32

count

[Tooltip("Number of visible glyphs included by Visible Glyph Range. Zero selects none.")]
[Min(0)]
public int count

Returns

System.Int32

characters

[Tooltip("Unicode characters included by Characters mode. Supplementary characters are matched as full codepoints.")]
public string characters

Returns

System.String

invert

[Tooltip("Invert the selection so matching glyphs are excluded and every other glyph is included.")]
public bool invert

Returns

System.Boolean

Methods

Matches(int, uint)

public bool Matches(int visibleGlyphIndex, uint codepoint)

Reports whether a visible glyph identity satisfies the selection mode, range or character set, and inversion flag.

Parameters

Name	Type
visibleGlyphIndex	System.Int32
codepoint	System.UInt32

Returns

System.Boolean

VisibleRange(int, int, bool)

public static LayerSelection3DSpec VisibleRange(int startIndex, int count, bool invert = false)

Selects a consecutive range of visible glyph identities, optionally selecting its complement.

Parameters

Name	Type
startIndex	System.Int32
count	System.Int32
invert	System.Boolean

Returns

TextStudio.ThreeD.LayerSelection3DSpec

CharacterSet(string, bool)

public static LayerSelection3DSpec CharacterSet(string characters, bool invert = false)

Selects visible glyphs whose Unicode scalar appears in the supplied character set, optionally selecting its complement.

Parameters

Name	Type
characters	System.String
invert	System.Boolean

Returns

TextStudio.ThreeD.LayerSelection3DSpec

Properties

All

public static LayerSelection3DSpec All { get; }

Returns

TextStudio.ThreeD.LayerSelection3DSpec