RulerFontSize

RulerFontSize

#Overview

name: RulerFontSize

The value of this variable can be defined or overridden in .ini config files. 1 .ini config file referencing this setting variable.

It is referenced in 4 C++ source files.

#Summary

#Usage in the C++ source code

The purpose of RulerFontSize is to control the font size of the ruler text in the Waveform Editor widget within Unreal Engine 5. This setting is specifically related to the user interface and visual presentation of the waveform editing tool.

The RulerFontSize variable is primarily used in the WaveformEditorWidgets module, which is part of the WaveformEditor plugin for Unreal Engine 5. This plugin is likely used for audio-related tasks within the engine’s editor.

The value of this variable is set in the UWaveformEditorWidgetsSettings class, which inherits from UDeveloperSettings. It is defined as a configurable property with a range between 1 and 15:

UPROPERTY(config, EditAnywhere, Category = "Ruler", Meta = (ClampMin = "1", ClampMax = "15"))
float RulerFontSize;

This variable interacts with other styling properties in the WaveformEditorWidgetsSettings, such as RulerTextColor and RulerBackgroundColor. These properties collectively define the appearance of the ruler in the waveform editor.

Developers should be aware that changing this value will affect the readability of the ruler in the waveform editor. A balance should be struck between visibility and space efficiency.

Best practices when using this variable include:

  1. Adjusting it in conjunction with other UI elements to maintain a consistent look and feel.
  2. Testing different values to ensure readability across various display resolutions.
  3. Considering accessibility needs when setting the font size.
  4. Using the provided clamp values (1-15) to ensure the font size remains within a reasonable range.

When modifying this variable, developers should be mindful of its impact on the overall user experience of the waveform editor tool.

#Setting Variables

#References In INI files

Location: <Workspace>/Engine/Plugins/Editor/WaveformEditor/Config/BaseWaveformEditor.ini:10, section: [/Script/WaveformEditorWidgets.WaveformEditorWidgetsSettings]

#References in C++ code

#Callsites

This variable is referenced in the following C++ source code:

#Loc: <Workspace>/Engine/Plugins/Editor/WaveformEditor/Source/WaveformEditorWidgets/Private/WaveformEditorStyle.cpp:124

Scope: file

Source code excerpt:

		CreateTimeRulerStyleFromSettings(*Settings);
	}
	else if (PropertyName == GET_MEMBER_NAME_CHECKED(UWaveformEditorWidgetsSettings, RulerFontSize))
	{
		CreateTimeRulerStyleFromSettings(*Settings);
	}
	else if (PropertyName == GET_MEMBER_NAME_CHECKED(UWaveformEditorWidgetsSettings, LoudnessGridColor))
	{
		CreateValueGridOverlayStyleFromSettings(*Settings);

#Loc: <Workspace>/Engine/Plugins/Editor/WaveformEditor/Source/WaveformEditorWidgets/Private/WaveformEditorStyle.cpp:181

Scope (from outer to inner):

file
function     FFixedSampleSequenceRulerStyle FWaveformEditorStyle::CreateTimeRulerStyleFromSettings

Source code excerpt:

		.SetTicksTextColor(InSettings.RulerTextColor)
		.SetHandleColor(InSettings.PlayheadColor)
		.SetFontSize(InSettings.RulerFontSize)
		.SetBackgroundColor(InSettings.RulerBackgroundColor);

	const ISlateStyle* AudioWidgetsStyle = FSlateStyleRegistry::FindSlateStyle("AudioWidgetsStyle");
	if (ensure(AudioWidgetsStyle))
	{
		TimeRulerStyle.SetHandleBrush(*AudioWidgetsStyle->GetBrush("SampledSequenceRuler.VanillaScrubHandleDown"));

#Loc: <Workspace>/Engine/Plugins/Editor/WaveformEditor/Source/WaveformEditorWidgets/Private/WaveformEditorWidgetsSettings.cpp:15

Scope (from outer to inner):

file
function     UWaveformEditorWidgetsSettings::UWaveformEditorWidgetsSettings

Source code excerpt:

	, RulerTicksColor(FLinearColor(1.f, 1.f, 1.f, 0.9f))
	, RulerTextColor(FLinearColor(1.f, 1.f, 1.f, 0.9f))
	, RulerFontSize(10.f)
	, ShowLoudnessGrid(true)
	, ShowLoudnessGridDecibelValues(true)
	, MaxLoudnessGridDivisions(3)
	, LoudnessGridThickness(1.f)
	, LoudnessGridColor(FLinearColor::Black)
	, LoudnessGridTextColor(FLinearColor(1.f, 1.f, 1.f, 0.9f))

#Loc: <Workspace>/Engine/Plugins/Editor/WaveformEditor/Source/WaveformEditorWidgets/Private/WaveformEditorWidgetsSettings.h:66

Scope (from outer to inner):

file
class        class UWaveformEditorWidgetsSettings : public UDeveloperSettings

Source code excerpt:


	UPROPERTY(config, EditAnywhere, Category = "Ruler", Meta = (ClampMin = "1", ClampMax = "15"))
	float RulerFontSize;

	UPROPERTY(config, EditAnywhere, Category = "Loudness Grid")
	bool ShowLoudnessGrid;

	UPROPERTY(config, EditAnywhere, Category = "Loudness Grid")
	bool ShowLoudnessGridDecibelValues;