bUseSlimCascadeDraw

bUseSlimCascadeDraw

#Overview

name: bUseSlimCascadeDraw

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 bUseSlimCascadeDraw is to control the visual appearance of modules in the Cascade particle system editor within Unreal Engine 5. It specifically toggles between a standard and a “slimline” drawing method for modules.

This setting variable is primarily used by the Cascade module, which is part of the Unreal Engine’s particle system editor. Based on the callsites, it’s clear that this variable affects the rendering of modules in the Cascade editor interface.

The value of this variable is set in the UCascadeOptions class, which is likely configurable through the editor’s preferences or project settings.

Other variables that interact with bUseSlimCascadeDraw include:

1. SlimCascadeDrawHeight: Determines the height of modules when slim drawing is enabled.
2. bCenterCascadeModuleText: Is set to false when slim drawing is disabled.

Developers should be aware that:

1. This variable affects the visual layout and potentially the usability of the Cascade editor.
2. It may impact the visibility of certain UI elements, such as the 3D draw mode button.
3. Changing this setting will affect all users of the project, as it’s stored in the project’s configuration.

Best practices when using this variable:

1. Consider the team’s preference for module visualization when setting this option.
2. Ensure that the SlimCascadeDrawHeight is set to an appropriate value when enabling slim drawing.
3. Be consistent across the project to maintain a uniform editing experience for all team members.
4. Document any changes to this setting in the project guidelines to ensure all team members are aware of the current visualization mode.

#Setting Variables

#References In INI files

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

• INI Section: /Script/UnrealEd.CascadeOptions
• Raw value: true
• Is Array: False

#References in C++ code

#Callsites

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

#Loc: <Workspace>/Engine/Source/Editor/Cascade/Private/CascadeEmitterCanvasClient.cpp:63

Scope (from outer to inner):

file
function     FCascadeEmitterCanvasClient::FCascadeEmitterCanvasClient

Source code excerpt:

	UCascadeOptions* EditorOptions = CascadePtr.Pin()->GetEditorOptions();

	if (EditorOptions->bUseSlimCascadeDraw == true)
	{
		ModuleHeight = FMath::Max<int32>(EditorOptions->SlimCascadeDrawHeight, 20);
	}
	else
	{
		EditorOptions->bCenterCascadeModuleText = false;

#Loc: <Workspace>/Engine/Source/Editor/Cascade/Private/CascadeEmitterCanvasClient.cpp:1403

Scope (from outer to inner):

file
function     void FCascadeEmitterCanvasClient::DrawModule

Source code excerpt:

	// Draw button for 3DDrawMode.
	if (CascadePtr.Pin()->GetEditorOptions()->bUseSlimCascadeDraw == false)
	{
		if (Module->bSupported3DDrawMode)
		{
			Draw3DDrawButton(Emitter, Module, bCanvasHitTesting, Canvas);
		}
	}

#Loc: <Workspace>/Engine/Source/Editor/Cascade/Private/CascadeEmitterCanvasClient.cpp:1600

Scope (from outer to inner):

file
function     void FCascadeEmitterCanvasClient::DrawEnableButton

Source code excerpt:

	if (bHitTesting)
		Canvas->SetHitProxy(new HCascadeEdEnableButtonProxy(Emitter, Module));
 	if (CascadePtr.Pin()->GetEditorOptions()->bUseSlimCascadeDraw == false)
	{
		if (Module->bEnabled)
		{
			Canvas->DrawTile(EmitterWidth - 20, 21, 16, 16, 0.f, 0.f, 1.f, 1.f, FLinearColor::White, GetIconTexture(Icon_ModuleEnabled));
		}
		else

#Loc: <Workspace>/Engine/Source/Editor/UnrealEd/Classes/Preferences/CascadeOptions.h:153

Scope (from outer to inner):

file
class        class UCascadeOptions : public UObject

Source code excerpt:

	/** If true, use the 'slimline' module drawing method in cascade. */
	UPROPERTY(EditAnywhere, config, Category=Options)
	uint32 bUseSlimCascadeDraw:1;

	/** The height to use for the 'slimline' module drawing method in cascade. */
	UPROPERTY(EditAnywhere, config, Category=Options)
	int32 SlimCascadeDrawHeight;

	/** If true, center the module name and buttons in the module box. */