LabelBlockBkgColor

LabelBlockBkgColor

#Overview

name: LabelBlockBkgColor

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 LabelBlockBkgColor is to define the background color for label blocks in the Curve Editor within Unreal Engine 5. This setting variable is primarily used for visual customization of the editor interface.

The LabelBlockBkgColor variable is primarily used in the DistCurveEditor module, which is part of the Unreal Editor’s curve editing system. It’s specifically utilized in the CurveEditorViewportClient class, which handles the viewport rendering for the Curve Editor.

The value of this variable is set in the UCurveEdOptions class, which is defined in the UnrealEd module. It’s declared as an UPROPERTY with the EditAnywhere and config specifiers, indicating that it can be edited in the editor and saved in configuration files.

LabelBlockBkgColor interacts with other color-related variables in the CurveEditorViewportClient, such as GridColor, GridTextColor, and SelectedKeyColor. These variables collectively define the color scheme of the Curve Editor interface.

Developers should be aware that changes to this variable will affect the visual appearance of the Curve Editor. It’s important to choose a color that provides good contrast with the text and other elements in the editor to ensure readability and usability.

Best practices when using this variable include:

  1. Choosing a color that complements the overall UI design of your project.
  2. Ensuring sufficient contrast with text and other UI elements for readability.
  3. Considering accessibility for users with color vision deficiencies.
  4. Testing the chosen color in different lighting conditions and on various displays to ensure consistency.
  5. Documenting any customizations made to this variable for team reference and maintenance purposes.

#Setting Variables

#References In INI files

Location: <Workspace>/Engine/Config/BaseEditorPerProjectUserSettings.ini:535, section: [/Script/UnrealEd.CurveEdOptions]

#References in C++ code

#Callsites

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

#Loc: <Workspace>/Engine/Source/Editor/DistCurveEditor/Private/CurveEditorViewportClient.cpp:83

Scope (from outer to inner):

file
function     FCurveEditorViewportClient::FCurveEditorViewportClient

Source code excerpt:

	GridColor = SharedData->EditorOptions->GridColor;
	GridTextColor = SharedData->EditorOptions->GridTextColor;
	LabelBlockBkgColor = SharedData->EditorOptions->LabelBlockBkgColor;
	SelectedKeyColor = SharedData->EditorOptions->SelectedKeyColor;

	MouseOverCurveIndex = INDEX_NONE;
	MouseOverSubIndex = INDEX_NONE;
	MouseOverKeyIndex = INDEX_NONE;

#Loc: <Workspace>/Engine/Source/Editor/DistCurveEditor/Private/CurveEditorViewportClient.cpp:165

Scope (from outer to inner):

file
function     void FCurveEditorViewportClient::Draw

Source code excerpt:

		Canvas->SetHitProxy(new HCurveEditorLabelBkgProxy());
	}
	Canvas->DrawTile( 0, 0, LabelWidth, CurveViewY, 0.f, 0.f, 1.f, 1.f, LabelBlockBkgColor,NULL,false);
	if (Canvas->IsHitTesting())
	{
		Canvas->SetHitProxy(NULL);
	}

	// Draw key entry for each curve

#Loc: <Workspace>/Engine/Source/Editor/DistCurveEditor/Private/CurveEditorViewportClient.h:154

Scope (from outer to inner):

file
class        class FCurveEditorViewportClient : public FCommonViewportClient

Source code excerpt:

	FLinearColor GridColor;
	FLinearColor GridTextColor;
	FLinearColor LabelBlockBkgColor;
	FLinearColor SelectedKeyColor;

	int32 MouseOverCurveIndex;
	int32 MouseOverSubIndex;
	int32 MouseOverKeyIndex;

#Loc: <Workspace>/Engine/Source/Editor/UnrealEd/Classes/Preferences/CurveEdOptions.h:41

Scope (from outer to inner):

file
class        class UCurveEdOptions : public UObject

Source code excerpt:


	UPROPERTY(EditAnywhere, config, Category=Options)
	FLinearColor LabelBlockBkgColor;

	UPROPERTY(EditAnywhere, config, Category=Options)
	FLinearColor SelectedKeyColor;

};