bShowLayerBars

bShowLayerBars

#Overview

name: bShowLayerBars

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

#Summary

#Usage in the C++ source code

The purpose of bShowLayerBars is to control the visibility of layer bars in the Sequencer editor of Unreal Engine 5. Layer bars are used to edit keyframes in bulk within the timeline.

This setting variable is primarily used in the Sequencer module of Unreal Engine’s editor. The Sequencer is a powerful tool for creating and editing cinematic sequences and animations.

The value of this variable is set in the USequencerSettings constructor, where it is initialized to true. It can be modified through the SetShowLayerBars function, which also saves the configuration when the value changes.

The bShowLayerBars variable interacts with other Sequencer settings, such as bShowKeyBars and bInfiniteKeyAreas, which are part of the same USequencerSettings class.

Developers should be aware that changing this variable affects the visual representation of the Sequencer timeline. Enabling it allows for easier bulk editing of keyframes, while disabling it may provide a cleaner interface if layer bars are not needed.

Best practices when using this variable include:

  1. Consider the needs of your specific project and team when deciding whether to show or hide layer bars.
  2. Use the provided getter and setter functions (GetShowLayerBars and SetShowLayerBars) to access and modify the value, as they ensure proper configuration saving.
  3. Be consistent in its usage across your project to maintain a uniform editing experience for all team members.
  4. Remember that this setting is part of the user’s configuration, so changes made programmatically should be done thoughtfully and with user consent.

#Setting Variables

#References In INI files

Location: <Workspace>/Engine/Config/BaseEditorPerProjectUserSettings.ini:891, section: [NiagaraSequenceEditor SequencerSettings]

#References in C++ code

#Callsites

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

#Loc: <Workspace>/Engine/Source/Editor/Sequencer/Private/SequencerSettings.cpp:46

Scope (from outer to inner):

file
function     USequencerSettings::USequencerSettings

Source code excerpt:

	ZeroPadFrames = 0;
	JumpFrameIncrement = FFrameNumber(5);
	bShowLayerBars = true;
	bShowKeyBars = true;
	bInfiniteKeyAreas = false;
	bShowChannelColors = false;
	bShowInfoButton = true;
	ReduceKeysTolerance = KINDA_SMALL_NUMBER;
	KeyAreaHeightWithCurves = SequencerLayoutConstants::KeyAreaHeight;

#Loc: <Workspace>/Engine/Source/Editor/Sequencer/Private/SequencerSettings.cpp:571

Scope (from outer to inner):

file
function     bool USequencerSettings::GetShowLayerBars

Source code excerpt:

bool USequencerSettings::GetShowLayerBars() const
{
	return bShowLayerBars;
}

void USequencerSettings::SetShowLayerBars(bool InbShowLayerBars)
{
	if (bShowLayerBars != InbShowLayerBars)
	{
		bShowLayerBars = InbShowLayerBars;
		SaveConfig();
	}
}

bool USequencerSettings::GetShowKeyBars() const
{

#Loc: <Workspace>/Engine/Source/Editor/Sequencer/Public/SequencerSettings.h:624

Scope (from outer to inner):

file
class        class USequencerSettings : public UObject

Source code excerpt:

	/** Enable or disable the layer bars to edit keyframes in bulk. */
	UPROPERTY( config, EditAnywhere, Category=Timeline )
	bool bShowLayerBars;

	/** Enable or disable key bar connections. */
	UPROPERTY( config, EditAnywhere, Category=Timeline )
	bool bShowKeyBars;

	/** Enable or disable setting key area sections as infinite by default. */