TextStudio2DDecorationLineSpec
public struct TextStudio2DDecorationLineSpecSettings for decoration-line patterns, font metrics, phase, caps, and clearance around glyph ink.
Methods
Section titled “Methods”
WithPattern(TextStudio2DLinePattern, float, float, float, float, float, float)
Section titled “WithPattern(TextStudio2DLinePattern, float, float, float, float, float, float)”public TextStudio2DDecorationLineSpec WithPattern(TextStudio2DLinePattern pattern, float dashLength = 0.2, float gap = 0.12, float dotSpacing = 0.15, float waveAmplitude = 0.035, float wavelength = 0.25, float doubleSeparation = 0.06)Returns a line specification copy with the supplied pattern and dash, dot, wave, and double-line dimensions.
Parameters
| Name | Type |
|---|---|
pattern |
TextStudio.TextStudio2DLinePattern |
dashLength |
System.Single |
gap |
System.Single |
dotSpacing |
System.Single |
waveAmplitude |
System.Single |
wavelength |
System.Single |
doubleSeparation |
System.Single |
Returns
TextStudio.TextStudio2DDecorationLineSpec
WithMetrics(TextStudio2DMetricMode, TextStudio2DMetricMode, TextStudio2DUnit, bool)
Section titled “WithMetrics(TextStudio2DMetricMode, TextStudio2DMetricMode, TextStudio2DUnit, bool)”public TextStudio2DDecorationLineSpec WithMetrics(TextStudio2DMetricMode thickness, TextStudio2DMetricMode offset, TextStudio2DUnit units = TextStudio2DUnit.Em, bool followFontRuns = false)Returns a line specification copy with the supplied thickness and offset metric modes, units, and font-run behavior.
Parameters
| Name | Type |
|---|---|
thickness |
TextStudio.TextStudio2DMetricMode |
offset |
TextStudio.TextStudio2DMetricMode |
units |
TextStudio.TextStudio2DUnit |
followFontRuns |
System.Boolean |
Returns
TextStudio.TextStudio2DDecorationLineSpec
WithPhase(float, TextStudio2DLinePhaseRestart, TextStudio2DLineCap)
Section titled “WithPhase(float, TextStudio2DLinePhaseRestart, TextStudio2DLineCap)”public TextStudio2DDecorationLineSpec WithPhase(float phase, TextStudio2DLinePhaseRestart restart = TextStudio2DLinePhaseRestart.Match, TextStudio2DLineCap cap = TextStudio2DLineCap.Butt)Returns a line specification copy with the supplied pattern phase, restart scope, and cap style.
Parameters
| Name | Type |
|---|---|
phase |
System.Single |
restart |
TextStudio.TextStudio2DLinePhaseRestart |
cap |
TextStudio.TextStudio2DLineCap |
Returns
TextStudio.TextStudio2DDecorationLineSpec
WithSkipInk(TextStudio2DSkipInk, float)
Section titled “WithSkipInk(TextStudio2DSkipInk, float)”public TextStudio2DDecorationLineSpec WithSkipInk(TextStudio2DSkipInk mode, float clearance = 0.025)Returns a line specification copy with the supplied ink-avoidance mode and clearance in em units.
Parameters
| Name | Type |
|---|---|
mode |
TextStudio.TextStudio2DSkipInk |
clearance |
System.Single |
Returns
TextStudio.TextStudio2DDecorationLineSpec
Properties
Section titled “Properties”
Pattern
Section titled “Pattern”public TextStudio2DLinePattern Pattern { get; }Returns
TextStudio.TextStudio2DLinePattern
ThicknessMode
Section titled “ThicknessMode”public TextStudio2DMetricMode ThicknessMode { get; }Returns
TextStudio.TextStudio2DMetricMode
OffsetMode
Section titled “OffsetMode”public TextStudio2DMetricMode OffsetMode { get; }Returns
TextStudio.TextStudio2DMetricMode
public TextStudio2DUnit Units { get; }Returns
TextStudio.TextStudio2DUnit
FollowFontRuns
Section titled “FollowFontRuns”public bool FollowFontRuns { get; }Returns
System.Boolean
PhaseRestart
Section titled “PhaseRestart”public TextStudio2DLinePhaseRestart PhaseRestart { get; }Returns
TextStudio.TextStudio2DLinePhaseRestart
DashLength
Section titled “DashLength”public float DashLength { get; }Returns
System.Single
public float Gap { get; }Returns
System.Single
DotSpacing
Section titled “DotSpacing”public float DotSpacing { get; }Returns
System.Single
WaveAmplitude
Section titled “WaveAmplitude”public float WaveAmplitude { get; }Returns
System.Single
Wavelength
Section titled “Wavelength”public float Wavelength { get; }Returns
System.Single
DoubleSeparation
Section titled “DoubleSeparation”public float DoubleSeparation { get; }Returns
System.Single
public float Phase { get; }Returns
System.Single
public TextStudio2DLineCap Cap { get; }Returns
TextStudio.TextStudio2DLineCap
SkipInk
Section titled “SkipInk”public TextStudio2DSkipInk SkipInk { get; }Returns
TextStudio.TextStudio2DSkipInk
InkClearance
Section titled “InkClearance”public float InkClearance { get; }Returns
System.Single
Default
Section titled “Default”public static TextStudio2DDecorationLineSpec Default { get; }Returns
TextStudio.TextStudio2DDecorationLineSpec