Sequencer.Outliner.CompactHeight

Sequencer.Outliner.CompactHeight

#Overview

name: Sequencer.Outliner.CompactHeight

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.CompactHeight is to define the height of outliner items in the Sequencer when it is in compact mode. This setting is specifically for the user interface of the Sequencer tool in Unreal Engine’s editor.

This setting variable is primarily used by the Sequencer module, which is part of Unreal Engine’s editor tools for creating and editing cinematics and animations.

The value of this variable is set in the C++ code, with a default value of 22.f. It’s defined as a global variable (GSequencerOutlinerCompactHeight) and is associated with a console variable (CVarSequencerOutlinerCompactHeight) for runtime configuration.

This variable interacts with another variable called GSequencerOutlinerRelaxedHeight, which defines the height for the relaxed mode of the Sequencer outliner. They are used together to determine the appropriate height based on the current view density mode.

Developers should be aware that changing this value will affect the visual layout of the Sequencer outliner in compact mode. It’s important to choose a value that balances between compactness and readability.

Best practices when using this variable include:

  1. Keeping the value reasonable to maintain usability (not too small or too large).
  2. Considering the relationship with the relaxed height to ensure a noticeable difference between modes.
  3. Testing any changes thoroughly to ensure they don’t negatively impact the user experience.

Regarding the associated variable GSequencerOutlinerCompactHeight:

The purpose of GSequencerOutlinerCompactHeight is to store the actual value used for the compact height of the Sequencer outliner items. It’s the implementation variable that the Sequencer.Outliner.CompactHeight setting controls.

This variable is used directly in the Sequencer module’s view model logic, specifically in the FViewDensityInfo::GetUniformHeight function, to determine the height of outliner items when in compact mode.

The value of this variable is set initially in the C++ code to 22.f, but can be modified at runtime through the associated console variable.

It interacts directly with the Sequencer.Outliner.CompactHeight console variable and is used in comparison with GSequencerOutlinerRelaxedHeight to provide different view densities.

Developers should be aware that this is the actual variable used in the code, so any runtime changes to Sequencer.Outliner.CompactHeight will affect this variable.

Best practices include ensuring that any code that needs to access this height value uses this variable rather than hardcoding values, to maintain consistency with user settings.

#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:8

Scope (from outer to inner):

file
namespace    UE::Sequencer

Source code excerpt:

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

#Associated Variable and Callsites

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

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

Scope (from outer to inner):

file
namespace    UE::Sequencer

Source code excerpt:

{

float GSequencerOutlinerCompactHeight = 22.f;
FAutoConsoleVariableRef CVarSequencerOutlinerCompactHeight(
	TEXT("Sequencer.Outliner.CompactHeight"),
	GSequencerOutlinerCompactHeight,
	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,

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

Scope (from outer to inner):

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

Source code excerpt:

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