Sequencer.Outliner.RelaxedHeight

Sequencer.Outliner.RelaxedHeight

#Overview

name: Sequencer.Outliner.RelaxedHeight

This variable is created as a Console Variable (cvar).

It is referenced in 3 C++ source files.

#Summary

#Usage in the C++ source code

The purpose of Sequencer.Outliner.RelaxedHeight is to define the height of outliner items in the Unreal Engine Sequencer when it’s in relaxed mode. This setting is part of the Sequencer’s user interface customization.

This setting variable is primarily used in the Sequencer module of Unreal Engine, which is part of the editor’s cinematic tool suite. It’s specifically used in the Sequencer’s outliner, which displays the hierarchical structure of the sequence.

The value of this variable is set through a console variable (CVar) system. It’s initialized with a default value of 28.0f and can be modified at runtime through console commands or configuration files.

The associated variable GSequencerOutlinerRelaxedHeight directly interacts with Sequencer.Outliner.RelaxedHeight. They share the same value, with GSequencerOutlinerRelaxedHeight being the actual global variable used in the C++ code.

Developers should be aware that this variable affects the UI layout of the Sequencer outliner. Changing its value will impact the vertical spacing of items in the outliner when it’s in relaxed mode. This could affect readability and user experience, especially for projects with complex sequences.

Best practices when using this variable include:

  1. Consider the overall UI design and consistency when modifying this value.
  2. Test changes thoroughly to ensure they don’t negatively impact usability, especially for sequences with many items.
  3. Document any custom values used in your project to maintain consistency across the development team.

Regarding the associated variable GSequencerOutlinerRelaxedHeight:

The purpose of GSequencerOutlinerRelaxedHeight is to store the actual value used by the engine for the relaxed height of Sequencer outliner items. It’s a global variable that directly corresponds to the Sequencer.Outliner.RelaxedHeight console variable.

This variable is used in the Sequencer module, specifically in the ViewDensity functionality which controls the display density of the Sequencer outliner.

The value of GSequencerOutlinerRelaxedHeight is set when the Sequencer.Outliner.RelaxedHeight console variable is initialized or modified.

It interacts with other view density settings, such as GSequencerOutlinerCompactHeight, to provide different display modes for the Sequencer outliner.

Developers should be aware that modifying GSequencerOutlinerRelaxedHeight directly in code will not persist changes across sessions or reflect in the console variable system. Always use the Sequencer.Outliner.RelaxedHeight console variable to ensure consistent behavior.

Best practices include using the provided console variable system to modify this value rather than changing the global variable directly, and considering the impact on different screen resolutions and UI scales when adjusting this value.

#References in C++ code

#Callsites

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

#Loc: <Workspace>/Engine/Source/Editor/SequencerCore/Private/MVVM/ViewModels/ViewDensity.cpp:14

Scope (from outer to inner):

file
namespace    UE::Sequencer

Source code excerpt:

float GSequencerOutlinerRelaxedHeight = 28.f;
FAutoConsoleVariableRef CVarSequencerOutlinerRelaxedHeight(
	TEXT("Sequencer.Outliner.RelaxedHeight"),
	GSequencerOutlinerRelaxedHeight,
	TEXT("(Default: 28.f. Defines the height of outliner items when in relaxed mode.")
	);


FViewDensityInfo::FViewDensityInfo()

#Associated Variable and Callsites

This variable is associated with another variable named GSequencerOutlinerRelaxedHeight. They share the same value. See the following C++ source code.

#Loc: <Workspace>/Engine/Source/Editor/SequencerCore/Private/MVVM/ViewModels/ViewDensity.cpp:12

Scope (from outer to inner):

file
namespace    UE::Sequencer

Source code excerpt:

	TEXT("(Default: 22.f. Defines the height of outliner items when in compact mode.")
	);
float GSequencerOutlinerRelaxedHeight = 28.f;
FAutoConsoleVariableRef CVarSequencerOutlinerRelaxedHeight(
	TEXT("Sequencer.Outliner.RelaxedHeight"),
	GSequencerOutlinerRelaxedHeight,
	TEXT("(Default: 28.f. Defines the height of outliner items when in relaxed mode.")
	);


FViewDensityInfo::FViewDensityInfo()
	: UniformHeight(GetUniformHeight(EViewDensity::Compact))

#Loc: <Workspace>/Engine/Source/Editor/SequencerCore/Private/MVVM/ViewModels/ViewDensity.cpp:35

Scope (from outer to inner):

file
namespace    UE::Sequencer
function     TOptional<float> FViewDensityInfo::GetUniformHeight

Source code excerpt:

	{
		case EViewDensity::Compact:  return GSequencerOutlinerCompactHeight;
		case EViewDensity::Relaxed:  return GSequencerOutlinerRelaxedHeight;
		default:                     return TOptional<float>();
	}
}


} // namespace UE::Sequencer