RulerTextColor

RulerTextColor

#Overview

name: RulerTextColor

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 RulerTextColor is to define the color of the text displayed on the ruler in the Waveform Editor within Unreal Engine 5. This setting variable is specifically used for customizing the visual appearance of the time ruler in the waveform editing interface.

This setting variable is primarily used by the WaveformEditorWidgets module, which is part of the WaveformEditor plugin in Unreal Engine 5. The plugin is designed for audio waveform editing and visualization 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 config property, meaning it can be modified through project settings or configuration files.

RulerTextColor interacts with other variables related to the ruler’s appearance, such as RulerBackgroundColor, RulerTicksColor, and RulerFontSize. These variables collectively define the visual style of the time ruler in the Waveform Editor.

Developers should be aware that changes to this variable will affect the readability and overall visual coherence of the Waveform Editor interface. It’s important to choose a color that contrasts well with the RulerBackgroundColor to ensure legibility.

Best practices when using this variable include:

  1. Ensuring sufficient contrast between the text color and background color for readability.
  2. Considering color accessibility for users with color vision deficiencies.
  3. Maintaining consistency with the overall color scheme of the editor interface.
  4. Testing the chosen color in different lighting conditions and on various display types to ensure visibility.

#Setting Variables

#References In INI files

Location: <Workspace>/Engine/Plugins/Editor/WaveformEditor/Config/BaseWaveformEditor.ini:9, 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:120

Scope: file

Source code excerpt:

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

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

Scope (from outer to inner):

file
function     FFixedSampleSequenceRulerStyle FWaveformEditorStyle::CreateTimeRulerStyleFromSettings

Source code excerpt:

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

	const ISlateStyle* AudioWidgetsStyle = FSlateStyleRegistry::FindSlateStyle("AudioWidgetsStyle");
	if (ensure(AudioWidgetsStyle))

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

Scope (from outer to inner):

file
function     UWaveformEditorWidgetsSettings::UWaveformEditorWidgetsSettings

Source code excerpt:

	, RulerBackgroundColor(FLinearColor::Black)
	, 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)

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

Scope (from outer to inner):

file
class        class UWaveformEditorWidgetsSettings : public UDeveloperSettings

Source code excerpt:


	UPROPERTY(config, EditAnywhere, Category = "Ruler")
	FLinearColor RulerTextColor;

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

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