2018-12-14 13:41:00 -05:00
|
|
|
// Copyright 1998-2019 Epic Games, Inc. All Rights Reserved.
|
2014-03-14 14:13:41 -04:00
|
|
|
|
|
|
|
|
#include "SDebugConsole.h"
|
Copying //UE4/Dev-Build to //UE4/Dev-Main (Source: //UE4/Dev-Build @ 3209340)
#lockdown Nick.Penwarden
#rb none
==========================
MAJOR FEATURES + CHANGES
==========================
Change 3209340 on 2016/11/23 by Ben.Marsh
Convert UE4 codebase to an "include what you use" model - where every header just includes the dependencies it needs, rather than every source file including large monolithic headers like Engine.h and UnrealEd.h.
Measured full rebuild times around 2x faster using XGE on Windows, and improvements of 25% or more for incremental builds and full rebuilds on most other platforms.
* Every header now includes everything it needs to compile.
* There's a CoreMinimal.h header that gets you a set of ubiquitous types from Core (eg. FString, FName, TArray, FVector, etc...). Most headers now include this first.
* There's a CoreTypes.h header that sets up primitive UE4 types and build macros (int32, PLATFORM_WIN64, etc...). All headers in Core include this first, as does CoreMinimal.h.
* Every .cpp file includes its matching .h file first.
* This helps validate that each header is including everything it needs to compile.
* No engine code includes a monolithic header such as Engine.h or UnrealEd.h any more.
* You will get a warning if you try to include one of these from the engine. They still exist for compatibility with game projects and do not produce warnings when included there.
* There have only been minor changes to our internal games down to accommodate these changes. The intent is for this to be as seamless as possible.
* No engine code explicitly includes a precompiled header any more.
* We still use PCHs, but they're force-included on the compiler command line by UnrealBuildTool instead. This lets us tune what they contain without breaking any existing include dependencies.
* PCHs are generated by a tool to get a statistical amount of coverage for the source files using it, and I've seeded the new shared PCHs to contain any header included by > 15% of source files.
Tool used to generate this transform is at Engine\Source\Programs\IncludeTool.
[CL 3209342 by Ben Marsh in Main branch]
2016-11-23 15:48:37 -05:00
|
|
|
#include "SlateOptMacros.h"
|
|
|
|
|
#include "Framework/Application/SlateApplication.h"
|
|
|
|
|
#include "Widgets/Layout/SBorder.h"
|
|
|
|
|
#include "Widgets/Layout/SSpacer.h"
|
|
|
|
|
#include "Widgets/Text/STextBlock.h"
|
|
|
|
|
#include "Widgets/Layout/SBox.h"
|
|
|
|
|
#include "EditorStyleSet.h"
|
2014-09-04 16:26:20 -04:00
|
|
|
#include "SOutputLog.h"
|
2014-03-14 14:13:41 -04:00
|
|
|
|
|
|
|
|
namespace DebugConsoleDefs
|
|
|
|
|
{
|
|
|
|
|
// How many seconds to animate when console is summoned
|
|
|
|
|
static const float IntroAnimationDuration = 0.25f;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
BEGIN_SLATE_FUNCTION_BUILD_OPTIMIZATION
|
2014-09-04 10:49:55 -04:00
|
|
|
|
|
|
|
|
void SDebugConsole::Construct( const FArguments& InArgs, const EDebugConsoleStyle::Type InStyle, FOutputLogModule* OutputLogModule, const FDebugConsoleDelegates* DebugConsoleDelegates )
|
2014-03-14 14:13:41 -04:00
|
|
|
{
|
|
|
|
|
CurrentStyle = InStyle;
|
|
|
|
|
|
2014-09-04 10:49:55 -04:00
|
|
|
TSharedPtr<SConsoleInputBox> ConsoleInputBox;
|
|
|
|
|
|
2014-03-14 14:13:41 -04:00
|
|
|
check( OutputLogModule != NULL );
|
2014-07-28 06:53:40 -04:00
|
|
|
ChildSlot
|
|
|
|
|
[
|
2014-03-14 14:13:41 -04:00
|
|
|
SNew( SVerticalBox )
|
2014-07-28 06:53:40 -04:00
|
|
|
+SVerticalBox::Slot()
|
|
|
|
|
.AutoHeight()
|
|
|
|
|
[
|
|
|
|
|
SNew( SVerticalBox )
|
2017-11-21 16:14:55 -05:00
|
|
|
.Visibility( this, &SDebugConsole::MakeVisibleIfLogIsShown )
|
2014-03-14 14:13:41 -04:00
|
|
|
|
2017-11-21 16:14:55 -05:00
|
|
|
+SVerticalBox::Slot()
|
|
|
|
|
.AutoHeight()
|
|
|
|
|
.Padding( 10.0f )
|
|
|
|
|
[
|
|
|
|
|
SNew(SBox)
|
|
|
|
|
.HeightOverride( 200.0f )
|
2014-07-28 06:53:40 -04:00
|
|
|
[
|
2017-11-21 16:14:55 -05:00
|
|
|
SNew( SBorder )
|
|
|
|
|
.BorderImage( FEditorStyle::GetBrush( "ToolPanel.GroupBorder" ) )
|
|
|
|
|
.ColorAndOpacity( this, &SDebugConsole::GetAnimatedColorAndOpacity )
|
|
|
|
|
.BorderBackgroundColor( this, &SDebugConsole::GetAnimatedSlateColor )
|
2014-03-14 14:13:41 -04:00
|
|
|
[
|
2017-11-21 16:14:55 -05:00
|
|
|
SNew( SSpacer )
|
2014-07-28 06:53:40 -04:00
|
|
|
]
|
|
|
|
|
]
|
2017-11-21 16:14:55 -05:00
|
|
|
]
|
2014-07-28 06:53:40 -04:00
|
|
|
]
|
|
|
|
|
|
|
|
|
|
+SVerticalBox::Slot()
|
|
|
|
|
.AutoHeight()
|
|
|
|
|
.Padding( 10.0f )
|
|
|
|
|
[
|
|
|
|
|
SNew(SBox)
|
2017-11-21 16:14:55 -05:00
|
|
|
.WidthOverride( 400.0f )
|
|
|
|
|
.MaxDesiredHeight( 100.0f )
|
2014-07-28 06:53:40 -04:00
|
|
|
[
|
|
|
|
|
SNew( SBorder )
|
2017-11-21 16:14:55 -05:00
|
|
|
.VAlign( VAlign_Center )
|
|
|
|
|
.Padding( FMargin(5.0f, 2.0f) )
|
2014-09-04 10:49:55 -04:00
|
|
|
.BorderImage( FEditorStyle::GetBrush( "DebugConsole.Background" ) )
|
|
|
|
|
.ColorAndOpacity( this, &SDebugConsole::GetAnimatedColorAndOpacity )
|
|
|
|
|
.BorderBackgroundColor( this, &SDebugConsole::GetAnimatedSlateColor )
|
|
|
|
|
[
|
2017-11-21 16:14:55 -05:00
|
|
|
SAssignNew(ConsoleInputBox, SConsoleInputBox)
|
|
|
|
|
.OnConsoleCommandExecuted(DebugConsoleDelegates->OnConsoleCommandExecuted)
|
|
|
|
|
.OnCloseConsole(DebugConsoleDelegates->OnCloseConsole)
|
2014-09-04 10:49:55 -04:00
|
|
|
]
|
2014-03-14 14:13:41 -04:00
|
|
|
]
|
2014-07-28 06:53:40 -04:00
|
|
|
]
|
|
|
|
|
];
|
2014-03-14 14:13:41 -04:00
|
|
|
|
2014-09-04 10:49:55 -04:00
|
|
|
EditableTextBox = ConsoleInputBox->GetEditableTextBox();
|
|
|
|
|
|
2014-03-14 14:13:41 -04:00
|
|
|
// Kick off intro animation
|
2014-09-04 10:49:55 -04:00
|
|
|
AnimCurveSequence = FCurveSequence();
|
|
|
|
|
AnimCurve = AnimCurveSequence.AddCurve( 0.0f, DebugConsoleDefs::IntroAnimationDuration, ECurveEaseFunction::QuadOut );
|
|
|
|
|
FlashCurve = AnimCurveSequence.AddCurve( DebugConsoleDefs::IntroAnimationDuration, .15f, ECurveEaseFunction::QuadInOut );
|
|
|
|
|
|
---- Merging with SlateDev branch ----
Introduces the concept of "Active Ticking" to allow Slate to go to sleep when there is no need to update the UI.
While asleep, Slate will skip the Tick & Paint pass for that frame entirely.
- There are TWO ways to "wake" Slate and cause a Tick/Paint pass:
1. Provide some sort of input (mouse movement, clicks, and key presses). Slate will always tick when the user is active.
- Therefore, if the logic in a given widget's Tick is only relevant in response to user action, there is no need to register an active tick.
2. Register an Active Tick. Currently this is an all-or-nothing situation, so if a single active tick needs to execute, all of Slate will be ticked.
- The purpose of an Active Tick is to allow a widget to "drive" Slate and guarantee a Tick/Paint pass in the absence of any user action.
- Examples include animation, async operations that update periodically, progress updates, loading bars, etc.
- An empty active tick is registered for viewports when they are real-time, so game project widgets are unaffected by this change and should continue to work as before.
- An Active Tick is registered by creating an FWidgetActiveTickDelegate and passing it to SWidget::RegisterActiveTick()
- There are THREE ways to unregister an active tick:
1. Return EActiveTickReturnType::StopTicking from the active tick function
2. Pass the FActiveTickHandle returned by RegisterActiveTick() to SWidget::UnregisterActiveTick()
3. Destroy the widget responsible for the active tick
- Sleeping is currently disabled, can be enabled with Slate.AllowSlateToSleep cvar
- There is currently a little buffer time during which Slate continues to tick following any input. Long-term, this is planned to be removed.
- The duration of the buffer can be adjusted using Slate.SleepBufferPostInput cvar (defaults to 1.0f)
- The FCurveSequence API has been updated to work with the active tick system
- Playing a curve sequence now requires that you pass the widget being animated by the sequence
- The active tick will automatically be registered on behalf of the widget and unregister when the sequence is complete
- GetLerpLooping() has been removed. Instead, pass true as the second param to Play() to indicate that the animation will loop. This causes the active tick to be registered indefinitely until paused or jumped to the start/end.
[CL 2391669 by Dan Hertzka in Main branch]
2014-12-17 16:07:57 -05:00
|
|
|
AnimCurveSequence.Play(this->AsShared());
|
2014-03-14 14:13:41 -04:00
|
|
|
}
|
|
|
|
|
END_SLATE_FUNCTION_BUILD_OPTIMIZATION
|
|
|
|
|
|
|
|
|
|
SDebugConsole::SDebugConsole()
|
|
|
|
|
: CurrentStyle( EDebugConsoleStyle::Compact )
|
|
|
|
|
{
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
void SDebugConsole::SetFocusToEditableText()
|
|
|
|
|
{
|
2014-10-30 12:29:36 -04:00
|
|
|
FSlateApplication::Get().SetKeyboardFocus( EditableTextBox.ToSharedRef(), EFocusCause::SetDirectly );
|
2014-03-14 14:13:41 -04:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
EVisibility SDebugConsole::MakeVisibleIfLogIsShown() const
|
|
|
|
|
{
|
|
|
|
|
return CurrentStyle == EDebugConsoleStyle::WithLog ? EVisibility::Visible : EVisibility::Collapsed;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
FLinearColor SDebugConsole::GetAnimatedColorAndOpacity() const
|
|
|
|
|
{
|
|
|
|
|
return FLinearColor( 1.0f, 1.0f, 1.0f, AnimCurve.GetLerp() );
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
FSlateColor SDebugConsole::GetAnimatedSlateColor() const
|
|
|
|
|
{
|
|
|
|
|
return FSlateColor( GetAnimatedColorAndOpacity() );
|
|
|
|
|
}
|
2014-09-04 10:49:55 -04:00
|
|
|
|
|
|
|
|
FSlateColor SDebugConsole::GetFlashColor() const
|
|
|
|
|
{
|
|
|
|
|
float FlashAlpha = 1.0f - FlashCurve.GetLerp();
|
|
|
|
|
|
|
|
|
|
if (FlashAlpha == 1.0f)
|
|
|
|
|
{
|
|
|
|
|
FlashAlpha = 0.0f;
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
return FLinearColor(1,1,1,FlashAlpha);
|
Copying //UE4/Dev-Build to //UE4/Dev-Main (Source: //UE4/Dev-Build @ 3209340)
#lockdown Nick.Penwarden
#rb none
==========================
MAJOR FEATURES + CHANGES
==========================
Change 3209340 on 2016/11/23 by Ben.Marsh
Convert UE4 codebase to an "include what you use" model - where every header just includes the dependencies it needs, rather than every source file including large monolithic headers like Engine.h and UnrealEd.h.
Measured full rebuild times around 2x faster using XGE on Windows, and improvements of 25% or more for incremental builds and full rebuilds on most other platforms.
* Every header now includes everything it needs to compile.
* There's a CoreMinimal.h header that gets you a set of ubiquitous types from Core (eg. FString, FName, TArray, FVector, etc...). Most headers now include this first.
* There's a CoreTypes.h header that sets up primitive UE4 types and build macros (int32, PLATFORM_WIN64, etc...). All headers in Core include this first, as does CoreMinimal.h.
* Every .cpp file includes its matching .h file first.
* This helps validate that each header is including everything it needs to compile.
* No engine code includes a monolithic header such as Engine.h or UnrealEd.h any more.
* You will get a warning if you try to include one of these from the engine. They still exist for compatibility with game projects and do not produce warnings when included there.
* There have only been minor changes to our internal games down to accommodate these changes. The intent is for this to be as seamless as possible.
* No engine code explicitly includes a precompiled header any more.
* We still use PCHs, but they're force-included on the compiler command line by UnrealBuildTool instead. This lets us tune what they contain without breaking any existing include dependencies.
* PCHs are generated by a tool to get a statistical amount of coverage for the source files using it, and I've seeded the new shared PCHs to contain any header included by > 15% of source files.
Tool used to generate this transform is at Engine\Source\Programs\IncludeTool.
[CL 3209342 by Ben Marsh in Main branch]
2016-11-23 15:48:37 -05:00
|
|
|
}
|
