RulerTicksColor

RulerTicksColor

#Overview

name: RulerTicksColor

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 6 C++ source files.

#Summary

#Usage in the C++ source code

The purpose of RulerTicksColor is to define the color of the ticks on the ruler in the Waveform Editor widget within Unreal Engine 5. This setting variable is primarily used for visual customization of the editor interface.

The RulerTicksColor variable is used by the WaveformEditorWidgets module, which is part of the WaveformEditor plugin in Unreal Engine 5. This plugin is likely used for audio editing and visualization within the engine’s editor.

The value of this variable is set in the UWaveformEditorWidgetsSettings class, which inherits from UDeveloperSettings. This suggests that the value can be configured through the project settings in the Unreal Engine editor.

RulerTicksColor interacts with other variables related to the ruler’s appearance, such as RulerTextColor, RulerBackgroundColor, and RulerFontSize. These variables together define the overall look of the ruler in the Waveform Editor.

Developers should be aware that changes to this variable will affect the visual appearance of the Waveform Editor interface. It’s important to choose a color that provides good contrast with the background color for readability.

Best practices when using this variable include:

  1. Ensuring sufficient contrast between the ticks color and the ruler background color for clear visibility.
  2. Coordinating the ticks color with other UI elements for a cohesive look.
  3. Considering accessibility guidelines when choosing colors to ensure the interface is usable for people with different visual capabilities.
  4. Testing the chosen color in different lighting conditions and on various displays to ensure consistent visibility.

#Setting Variables

#References In INI files

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

Scope: file

Source code excerpt:

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

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

Scope (from outer to inner):

file
function     FFixedSampleSequenceRulerStyle FWaveformEditorStyle::CreateTimeRulerStyleFromSettings

Source code excerpt:

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

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

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

Scope (from outer to inner):

file
function     UWaveformEditorWidgetsSettings::UWaveformEditorWidgetsSettings

Source code excerpt:

	, MinorGridColor(FLinearColor(0.f, 0.f, 0.f, 0.5f))
	, 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)

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

Scope (from outer to inner):

file
class        class UWaveformEditorWidgetsSettings : public UDeveloperSettings

Source code excerpt:


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

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

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

#Loc: <Workspace>/Engine/Plugins/Runtime/AudioWidgets/Source/AudioWidgets/Private/AudioWidgetsSlateTypes.cpp:13

Scope (from outer to inner):

file
namespace    AudioWidgetStylesSharedParams

Source code excerpt:

	const FLazyName BackgroundBrushName = "WhiteBrush";
	const FLinearColor PlayheadColor = FLinearColor(255.f, 0.1f, 0.2f, 1.f);
	const FLinearColor RulerTicksColor = FLinearColor(1.f, 1.f, 1.f, 0.9f);
	const float DefaultHeight = 720.f;
	const float DefaultWidth = 1280.f;
}

// Audio Text Box Style 
FAudioTextBoxStyle::FAudioTextBoxStyle()

#Loc: <Workspace>/Engine/Plugins/Runtime/AudioWidgets/Source/AudioWidgets/Private/AudioWidgetsSlateTypes.cpp:133

Scope (from outer to inner):

file
function     FFixedSampleSequenceRulerStyle::FFixedSampleSequenceRulerStyle

Source code excerpt:

	, HandleColor(AudioWidgetStylesSharedParams::PlayheadColor)
	, HandleBrush()
	, TicksColor(AudioWidgetStylesSharedParams::RulerTicksColor)
	, TicksTextColor(AudioWidgetStylesSharedParams::RulerTicksColor)
	, TicksTextFont(FAppStyle::GetFontStyle("Regular"))
	, TicksTextOffset(5.f)
	, BackgroundColor(FLinearColor::Black)
	, BackgroundBrush(*FAppStyle::GetBrush(AudioWidgetStylesSharedParams::BackgroundBrushName))
	, DesiredWidth(AudioWidgetStylesSharedParams::DefaultWidth)
	, DesiredHeight(30.f)