// Copyright 1998-2017 Epic Games, Inc. All Rights Reserved. #include "SAnimationSequenceBrowser.h" #include "Framework/Commands/UIAction.h" #include "Framework/Commands/UICommandList.h" #include "Widgets/Layout/SBorder.h" #include "Widgets/SBoxPanel.h" #include "Widgets/Text/STextBlock.h" #include "Widgets/Input/SMenuAnchor.h" #include "Framework/MultiBox/MultiBoxBuilder.h" #include "Animation/AnimationAsset.h" #include "Animation/AnimSequenceBase.h" #include "Animation/AnimSequence.h" #include "Toolkits/AssetEditorManager.h" #include "EditorStyleSet.h" #include "Animation/DebugSkelMeshComponent.h" #include "IPersonaPreviewScene.h" #include "PersonaModule.h" #include "Widgets/Layout/SBox.h" #include "Widgets/Input/SButton.h" #include "Widgets/SViewport.h" #include "EditorReimportHandler.h" #include "Settings/DestructableMeshEditorSettings.h" #include "FileHelpers.h" #include "IContentBrowserSingleton.h" #include "ContentBrowserModule.h" #include "AssetRegistryModule.h" #include "SSkeletonWidget.h" #include "Toolkits/GlobalEditorCommonCommands.h" #include "FrontendFilterBase.h" #include "Slate/SceneViewport.h" #include "AnimPreviewInstance.h" #include "ObjectEditorUtils.h" #include "IPersonaToolkit.h" #include "IAnimationEditorModule.h" #include "Sound/SoundWave.h" #include "Components/AudioComponent.h" #define LOCTEXT_NAMESPACE "SequenceBrowser" const FString SAnimationSequenceBrowser::SettingsIniSection = TEXT("SequenceBrowser"); /** A filter that displays animations that are additive */ class FFrontendFilter_AdditiveAnimAssets : public FFrontendFilter { public: FFrontendFilter_AdditiveAnimAssets(TSharedPtr InCategory) : FFrontendFilter(InCategory) {} // FFrontendFilter implementation virtual FString GetName() const override { return TEXT("AdditiveAnimAssets"); } virtual FText GetDisplayName() const override { return LOCTEXT("FFrontendFilter_AdditiveAnimAssets", "Additive Animations"); } virtual FText GetToolTipText() const override { return LOCTEXT("FFrontendFilter_AdditiveAnimAssetsToolTip", "Show only animations that are additive."); } // IFilter implementation virtual bool PassesFilter(FAssetFilterType InItem) const override { const FString TagValue = InItem.GetTagValueRef(GET_MEMBER_NAME_CHECKED(UAnimSequence, AdditiveAnimType)); return !TagValue.IsEmpty() && !TagValue.Equals(TEXT("AAT_None")); } }; /** A filter that displays sound waves */ class FFrontendFilter_SoundWaves : public FFrontendFilter { public: FFrontendFilter_SoundWaves(TSharedPtr InCategory) : FFrontendFilter(InCategory) {} // FFrontendFilter implementation virtual FString GetName() const override { return TEXT("ShowSoundWaves"); } virtual FText GetDisplayName() const override { return LOCTEXT("FFrontendFilter_SoundWaves", "Show Sound Waves"); } virtual FText GetToolTipText() const override { return LOCTEXT("FFrontendFilter_SoundWavesToolTip", "Show sound waves."); } virtual bool IsInverseFilter() const override { return true; } // IFilter implementation virtual bool PassesFilter(FAssetFilterType InItem) const override { return !InItem.GetClass()->IsChildOf(USoundWave::StaticClass()); } }; //////////////////////////////////////////////////// const int32 SAnimationSequenceBrowser::MaxAssetsHistory = 10; SAnimationSequenceBrowser::~SAnimationSequenceBrowser() { if(PreviewComponent) { for(int32 ComponentIdx = PreviewComponent->GetAttachChildren().Num() - 1 ; ComponentIdx >= 0 ; --ComponentIdx) { USceneComponent* Component = PreviewComponent->GetAttachChildren()[ComponentIdx]; if(Component) { CleanupPreviewSceneComponent(Component); } } check(PreviewComponent->GetAttachChildren().Num() == 0); } if(ViewportClient.IsValid()) { ViewportClient->Viewport = NULL; } } void SAnimationSequenceBrowser::OnRequestOpenAsset(const FAssetData& AssetData, bool bFromHistory) { if (UObject* RawAsset = AssetData.GetAsset()) { if (UAnimationAsset* AnimationAsset = Cast(RawAsset)) { if (!bFromHistory) { AddAssetToHistory(AssetData); } OnOpenNewAsset.ExecuteIfBound(AnimationAsset); } else if (USoundWave* SoundWave = Cast(RawAsset)) { PlayPreviewAudio(SoundWave); } } } TSharedPtr SAnimationSequenceBrowser::OnGetAssetContextMenu(const TArray& SelectedAssets) { bool bHasSelectedAnimSequence = false; bool bHasSelectedAnimAsset = false; if ( SelectedAssets.Num() ) { for(auto Iter = SelectedAssets.CreateConstIterator(); Iter; ++Iter) { UObject* Asset = Iter->GetAsset(); if(Cast(Asset)) { bHasSelectedAnimSequence = true; } if (Cast(Asset)) { bHasSelectedAnimAsset = true; } } } FMenuBuilder MenuBuilder(/*bInShouldCloseWindowAfterMenuSelection=*/ true, Commands); if(bHasSelectedAnimSequence) { MenuBuilder.BeginSection("AnimationSequenceOptions", LOCTEXT("AnimationHeading", "Animation")); { MenuBuilder.AddMenuEntry( LOCTEXT("RunCompressionOnAnimations", "Apply Compression"), LOCTEXT("RunCompressionOnAnimations_ToolTip", "Apply a compression scheme from the options given to the selected animations"), FSlateIcon(), FUIAction( FExecuteAction::CreateSP(this, &SAnimationSequenceBrowser::OnApplyCompression, SelectedAssets), FCanExecuteAction() ) ); MenuBuilder.AddMenuEntry( LOCTEXT("ExportAnimationsToFBX", "Export to FBX"), LOCTEXT("ExportAnimationsToFBX_ToolTip", "Export Animation(s) To FBX"), FSlateIcon(), FUIAction( FExecuteAction::CreateSP(this, &SAnimationSequenceBrowser::OnExportToFBX, SelectedAssets), FCanExecuteAction() ) ); MenuBuilder.AddMenuEntry( LOCTEXT("AddLoopingInterpolation", "Add Looping Interpolation"), LOCTEXT("AddLoopingInterpolation_ToolTip", "Add an extra frame at the end of the animation to create better looping"), FSlateIcon(), FUIAction( FExecuteAction::CreateSP(this, &SAnimationSequenceBrowser::OnAddLoopingInterpolation, SelectedAssets), FCanExecuteAction() ) ); MenuBuilder.AddMenuEntry( LOCTEXT("ReimportAnimation", "Reimport Animation"), LOCTEXT("ReimportAnimation_ToolTip", "Reimport current animaion."), FSlateIcon(), FUIAction( FExecuteAction::CreateSP(this, &SAnimationSequenceBrowser::OnReimportAnimation, SelectedAssets), FCanExecuteAction() ) ); MenuBuilder.AddMenuEntry( LOCTEXT("SetCurrentPreviewMesh", "Set Current Preview Mesh"), LOCTEXT("SetCurrentPreviewMesh_ToolTip", "Set current preview mesh to be used when previewed by this asset. This only applies when you open Persona using this asset."), FSlateIcon(), FUIAction( FExecuteAction::CreateSP(this, &SAnimationSequenceBrowser::OnSetCurrentPreviewMesh, SelectedAssets), FCanExecuteAction() ) ); } MenuBuilder.EndSection(); } if (SelectedAssets.Num() == 1 && SelectedAssets[0].GetClass()->IsChildOf(USoundWave::StaticClass())) { MenuBuilder.BeginSection("AnimationSequenceAudioOptions", LOCTEXT("AudioOptionsHeading", "Audio")); { MenuBuilder.AddMenuEntry( LOCTEXT("PlayAudio", "Play Audio"), LOCTEXT("PlayAudio_ToolTip", "Play this audio asset as a preview"), FSlateIcon(), FUIAction( FExecuteAction::CreateSP(this, &SAnimationSequenceBrowser::HandlePlayAudio, SelectedAssets[0]), FCanExecuteAction() ) ); UAudioComponent* AudioComponent = PersonaToolkitPtr.Pin()->GetPreviewScene()->GetActor()->FindComponentByClass(); if (AudioComponent) { if (AudioComponent->IsPlaying()) { MenuBuilder.AddMenuEntry( LOCTEXT("StopAudio", "Stop Audio"), LOCTEXT("StopAudio_ToolTip", "Stop the currently playing preview audio"), FSlateIcon(), FUIAction( FExecuteAction::CreateSP(this, &SAnimationSequenceBrowser::HandleStopAudio), FCanExecuteAction() ) ); } } } MenuBuilder.EndSection(); } MenuBuilder.BeginSection("AnimationSequenceOptions", LOCTEXT("OptionsHeading", "Options") ); { MenuBuilder.AddMenuEntry( LOCTEXT("SaveSelectedAssets", "Save"), LOCTEXT("SaveSelectedAssets_ToolTip", "Save the selected assets"), FSlateIcon(FEditorStyle::GetStyleSetName(), "Level.SaveIcon16x"), FUIAction( FExecuteAction::CreateSP( this, &SAnimationSequenceBrowser::SaveSelectedAssets, SelectedAssets), FCanExecuteAction::CreateSP( this, &SAnimationSequenceBrowser::CanSaveSelectedAssets, SelectedAssets) ) ); MenuBuilder.AddMenuEntry(FGlobalEditorCommonCommands::Get().FindInContentBrowser); } MenuBuilder.EndSection(); if (bHasSelectedAnimAsset) { MenuBuilder.BeginSection("AnimationSequenceAdvancedOptions", LOCTEXT("AdvancedOptionsHeading", "Advanced") ); { MenuBuilder.AddMenuEntry( LOCTEXT("ChangeSkeleton", "Create a copy for another Skeleton..."), LOCTEXT("ChangeSkeleton_ToolTip", "Create a copy for different skeleton"), FSlateIcon(), FUIAction( FExecuteAction::CreateSP( this, &SAnimationSequenceBrowser::OnCreateCopy, SelectedAssets ), FCanExecuteAction() ) ); } MenuBuilder.EndSection(); } return MenuBuilder.MakeWidget(); } void SAnimationSequenceBrowser::FindInContentBrowser() { TArray CurrentSelection = GetCurrentSelectionDelegate.Execute(); if (CurrentSelection.Num() > 0) { FContentBrowserModule& ContentBrowserModule = FModuleManager::Get().LoadModuleChecked("ContentBrowser"); ContentBrowserModule.Get().SyncBrowserToAssets(CurrentSelection); } } bool SAnimationSequenceBrowser::CanFindInContentBrowser() const { TArray CurrentSelection = GetCurrentSelectionDelegate.Execute(); return CurrentSelection.Num() > 0; } void SAnimationSequenceBrowser::GetSelectedPackages(const TArray& Assets, TArray& OutPackages) const { for (int32 AssetIdx = 0; AssetIdx < Assets.Num(); ++AssetIdx) { UPackage* Package = FindPackage(NULL, *Assets[AssetIdx].PackageName.ToString()); if ( Package ) { OutPackages.Add(Package); } } } void SAnimationSequenceBrowser::SaveSelectedAssets(TArray ObjectsToSave) const { TArray PackagesToSave; GetSelectedPackages(ObjectsToSave, PackagesToSave); const bool bCheckDirty = false; const bool bPromptToSave = false; const FEditorFileUtils::EPromptReturnCode Return = FEditorFileUtils::PromptForCheckoutAndSave(PackagesToSave, bCheckDirty, bPromptToSave); } bool SAnimationSequenceBrowser::CanSaveSelectedAssets(TArray ObjectsToSave) const { TArray Packages; GetSelectedPackages(ObjectsToSave, Packages); // Don't offer save option if none of the packages are loaded return Packages.Num() > 0; } void SAnimationSequenceBrowser::OnApplyCompression(TArray SelectedAssets) { if ( SelectedAssets.Num() > 0 ) { TArray> AnimSequences; for(auto Iter = SelectedAssets.CreateIterator(); Iter; ++Iter) { if(UAnimSequence* AnimSequence = Cast(Iter->GetAsset()) ) { AnimSequences.Add( TWeakObjectPtr(AnimSequence) ); } } FPersonaModule& PersonaModule = FModuleManager::GetModuleChecked("Persona"); PersonaModule.ApplyCompression(AnimSequences); } } void SAnimationSequenceBrowser::OnExportToFBX(TArray SelectedAssets) { if (SelectedAssets.Num() > 0) { TArray> AnimSequences; for(auto Iter = SelectedAssets.CreateIterator(); Iter; ++Iter) { if(UAnimSequence* AnimSequence = Cast(Iter->GetAsset())) { // we only shows anim sequence that belong to this skeleton AnimSequences.Add(TWeakObjectPtr(AnimSequence)); } } FPersonaModule& PersonaModule = FModuleManager::GetModuleChecked("Persona"); PersonaModule.ExportToFBX(AnimSequences, PersonaToolkitPtr.Pin()->GetPreviewScene()->GetPreviewMeshComponent()->SkeletalMesh); } } void SAnimationSequenceBrowser::OnSetCurrentPreviewMesh(TArray SelectedAssets) { if(SelectedAssets.Num() > 0) { USkeletalMesh* PreviewMesh = PersonaToolkitPtr.Pin()->GetPreviewScene()->GetPreviewMeshComponent()->SkeletalMesh; if (PreviewMesh) { TArray> AnimSequences; for(auto Iter = SelectedAssets.CreateIterator(); Iter; ++Iter) { UAnimationAsset * AnimAsset = Cast(Iter->GetAsset()); if (AnimAsset) { AnimAsset->SetPreviewMesh(PreviewMesh); } } } } } void SAnimationSequenceBrowser::OnAddLoopingInterpolation(TArray SelectedAssets) { if(SelectedAssets.Num() > 0) { TArray> AnimSequences; for(auto Iter = SelectedAssets.CreateIterator(); Iter; ++Iter) { if(UAnimSequence* AnimSequence = Cast(Iter->GetAsset())) { // we only shows anim sequence that belong to this skeleton AnimSequences.Add(TWeakObjectPtr(AnimSequence)); } } FPersonaModule& PersonaModule = FModuleManager::GetModuleChecked("Persona"); PersonaModule.AddLoopingInterpolation(AnimSequences); } } void SAnimationSequenceBrowser::OnReimportAnimation(TArray SelectedAssets) { if (SelectedAssets.Num() > 0) { TArray CopyOfSelectedAssets; for (auto Iter = SelectedAssets.CreateIterator(); Iter; ++Iter) { if (UAnimSequence* AnimSequence = Cast(Iter->GetAsset())) { CopyOfSelectedAssets.Add(AnimSequence); } } FReimportManager::Instance()->ValidateAllSourceFileAndReimport(CopyOfSelectedAssets); } } void SAnimationSequenceBrowser::RetargetAnimationHandler(USkeleton* OldSkeleton, USkeleton* NewSkeleton, bool bRemapReferencedAssets, bool bAllowRemapToExisting, bool bConvertSpaces, const EditorAnimUtils::FNameDuplicationRule* NameRule, TArray> InAnimAssets) { UObject* AssetToOpen = EditorAnimUtils::RetargetAnimations(OldSkeleton, NewSkeleton, InAnimAssets, bRemapReferencedAssets, NameRule, bConvertSpaces); if(UAnimationAsset* AnimAsset = Cast(AssetToOpen)) { FAssetRegistryModule::AssetCreated(AssetToOpen); // once all success, attempt to open new editor with new skeleton FAssetEditorManager::Get().OpenEditorForAsset(AssetToOpen); } } void SAnimationSequenceBrowser::OnCreateCopy(TArray Selected) { if ( Selected.Num() > 0 ) { // ask which skeleton users would like to choose USkeleton* OldSkeleton = PersonaToolkitPtr.Pin()->GetSkeleton(); USkeleton* NewSkeleton = NULL; bool bDuplicateAssets = true; const FText Message = LOCTEXT("RemapSkeleton_Warning", "This will duplicate the asset and convert to new skeleton."); TArray AnimAssets; for ( auto SelectedAsset : Selected ) { UAnimationAsset* Asset = Cast(SelectedAsset.GetAsset()); if (Asset) { AnimAssets.Add(Asset); } } if (AnimAssets.Num() > 0) { auto AnimAssetsToConvert = FObjectEditorUtils::GetTypedWeakObjectPtrs(AnimAssets); // ask user what they'd like to change to SAnimationRemapSkeleton::ShowWindow(OldSkeleton, Message, true, FOnRetargetAnimation::CreateSP(this, &SAnimationSequenceBrowser::RetargetAnimationHandler, AnimAssetsToConvert)); } } } bool SAnimationSequenceBrowser::CanShowColumnForAssetRegistryTag(FName AssetType, FName TagName) const { return !AssetRegistryTagsToIgnore.Contains(TagName); } void SAnimationSequenceBrowser::Construct(const FArguments& InArgs, const TSharedRef& InPersonaToolkit) { PersonaToolkitPtr = InPersonaToolkit; OnOpenNewAsset = InArgs._OnOpenNewAsset; bShowHistory = InArgs._ShowHistory; Commands = MakeShareable(new FUICommandList()); Commands->MapAction(FGlobalEditorCommonCommands::Get().FindInContentBrowser, FUIAction( FExecuteAction::CreateSP(this, &SAnimationSequenceBrowser::FindInContentBrowser), FCanExecuteAction::CreateSP(this, &SAnimationSequenceBrowser::CanFindInContentBrowser) )); CurrentAssetHistoryIndex = INDEX_NONE; bTriedToCacheOrginalAsset = false; bIsActiveTimerRegistered = false; bToolTipVisualizedThisFrame = false; bToolTipClosedThisFrame = false; FContentBrowserModule& ContentBrowserModule = FModuleManager::Get().LoadModuleChecked(TEXT("ContentBrowser")); CreateAssetTooltipResources(); // Configure filter for asset picker FAssetPickerConfig Config; Config.Filter.bRecursiveClasses = true; Config.Filter.ClassNames.Add(UAnimationAsset::StaticClass()->GetFName()); Config.Filter.ClassNames.Add(USoundWave::StaticClass()->GetFName()); Config.InitialAssetViewType = EAssetViewType::Column; Config.bAddFilterUI = true; Config.bShowPathInColumnView = true; Config.bSortByPathInColumnView = true; // Configure response to click and double-click Config.OnAssetDoubleClicked = FOnAssetDoubleClicked::CreateSP(this, &SAnimationSequenceBrowser::OnRequestOpenAsset, false); Config.OnGetAssetContextMenu = FOnGetAssetContextMenu::CreateSP(this, &SAnimationSequenceBrowser::OnGetAssetContextMenu); Config.OnAssetTagWantsToBeDisplayed = FOnShouldDisplayAssetTag::CreateSP(this, &SAnimationSequenceBrowser::CanShowColumnForAssetRegistryTag); Config.SyncToAssetsDelegates.Add(&SyncToAssetsDelegate); Config.OnShouldFilterAsset = FOnShouldFilterAsset::CreateSP(this, &SAnimationSequenceBrowser::HandleFilterAsset); Config.GetCurrentSelectionDelegates.Add(&GetCurrentSelectionDelegate); Config.bFocusSearchBoxWhenOpened = false; Config.DefaultFilterMenuExpansion = EAssetTypeCategories::Animation; Config.SaveSettingsName = SettingsIniSection; TSharedPtr AnimCategory = MakeShareable( new FFrontendFilterCategory(LOCTEXT("ExtraAnimationFilters", "Anim Filters"), LOCTEXT("ExtraAnimationFiltersTooltip", "Filter assets by all filters in this category.")) ); Config.ExtraFrontendFilters.Add( MakeShareable(new FFrontendFilter_AdditiveAnimAssets(AnimCategory)) ); TSharedPtr AudioCategory = MakeShareable(new FFrontendFilterCategory(LOCTEXT("AudioFilters", "Audio Filters"), LOCTEXT("AudioFiltersTooltip", "Filter audio assets."))); Config.ExtraFrontendFilters.Add( MakeShareable(new FFrontendFilter_SoundWaves(AudioCategory)) ); Config.OnGetCustomAssetToolTip = FOnGetCustomAssetToolTip::CreateSP(this, &SAnimationSequenceBrowser::CreateCustomAssetToolTip); Config.OnVisualizeAssetToolTip = FOnVisualizeAssetToolTip::CreateSP(this, &SAnimationSequenceBrowser::OnVisualizeAssetToolTip); Config.OnAssetToolTipClosing = FOnAssetToolTipClosing::CreateSP( this, &SAnimationSequenceBrowser::OnAssetToolTipClosing ); // hide all asset registry columns by default (we only really want the name and path) TArray AssetRegistryTags; UAnimSequence::StaticClass()->GetDefaultObject()->GetAssetRegistryTags(AssetRegistryTags); for(UObject::FAssetRegistryTag& AssetRegistryTag : AssetRegistryTags) { Config.HiddenColumnNames.Add(AssetRegistryTag.Name.ToString()); } // Also hide the type column by default (but allow users to enable it, so don't use bShowTypeInColumnView) Config.HiddenColumnNames.Add(TEXT("Class")); static const FName DefaultForegroundName("DefaultForeground"); TSharedRef< SMenuAnchor > BackMenuAnchorPtr = SNew(SMenuAnchor) .Placement(MenuPlacement_BelowAnchor) .OnGetMenuContent(this, &SAnimationSequenceBrowser::CreateHistoryMenu, true) [ SNew(SButton) .OnClicked(this, &SAnimationSequenceBrowser::OnGoBackInHistory) .ForegroundColor(FEditorStyle::GetSlateColor(DefaultForegroundName)) .ButtonStyle(FEditorStyle::Get(), "FlatButton") .ContentPadding(FMargin(1, 0)) .IsEnabled(this, &SAnimationSequenceBrowser::CanStepBackwardInHistory) .ToolTipText(LOCTEXT("Backward_Tooltip", "Step backward in the asset history. Right click to see full history.")) [ SNew(STextBlock) .TextStyle(FEditorStyle::Get(), "ContentBrowser.TopBar.Font") .Font(FEditorStyle::Get().GetFontStyle("FontAwesome.11")) .Text(FText::FromString(FString(TEXT("\xf060"))) /*fa-arrow-left*/) ] ]; TSharedRef< SMenuAnchor > FwdMenuAnchorPtr = SNew(SMenuAnchor) .Placement(MenuPlacement_BelowAnchor) .OnGetMenuContent(this, &SAnimationSequenceBrowser::CreateHistoryMenu, false) [ SNew(SButton) .OnClicked(this, &SAnimationSequenceBrowser::OnGoForwardInHistory) .ForegroundColor(FEditorStyle::GetSlateColor(DefaultForegroundName)) .ButtonStyle(FEditorStyle::Get(), "FlatButton") .ContentPadding(FMargin(1, 0)) .IsEnabled(this, &SAnimationSequenceBrowser::CanStepForwardInHistory) .ToolTipText(LOCTEXT("Forward_Tooltip", "Step forward in the asset history. Right click to see full history.")) [ SNew(STextBlock) .TextStyle(FEditorStyle::Get(), "ContentBrowser.TopBar.Font") .Font(FEditorStyle::Get().GetFontStyle("FontAwesome.11")) .Text(FText::FromString(FString(TEXT("\xf061"))) /*fa-arrow-right*/) ] ]; this->ChildSlot [ SNew(SVerticalBox) +SVerticalBox::Slot() .AutoHeight() [ SNew(SBorder) .Visibility(this, &SAnimationSequenceBrowser::GetHistoryVisibility) .Padding(FMargin(3)) .BorderImage( FEditorStyle::GetBrush("ToolPanel.GroupBorder") ) [ SNew(SHorizontalBox) +SHorizontalBox::Slot() .HAlign(HAlign_Left) [ SNew(SHorizontalBox) + SHorizontalBox::Slot() .AutoWidth() [ SNew(SBorder) .OnMouseButtonDown(this, &SAnimationSequenceBrowser::OnMouseDownHistory, TWeakPtr(BackMenuAnchorPtr)) .BorderImage( FEditorStyle::GetBrush("NoBorder") ) [ BackMenuAnchorPtr ] ] +SHorizontalBox::Slot() .AutoWidth() [ SNew(SBorder) .OnMouseButtonDown(this, &SAnimationSequenceBrowser::OnMouseDownHistory, TWeakPtr(FwdMenuAnchorPtr)) .BorderImage( FEditorStyle::GetBrush("NoBorder") ) [ FwdMenuAnchorPtr ] ] ] ] ] +SVerticalBox::Slot() .FillHeight(1.f) [ SNew(SBorder) .Padding(FMargin(3)) .BorderImage(FEditorStyle::GetBrush("ToolPanel.GroupBorder")) [ ContentBrowserModule.Get().CreateAssetPicker(Config) ] ] ]; // Create the ignore set for asset registry tags // Making Skeleton to be private, and now GET_MEMBER_NAME_CHECKED doesn't work AssetRegistryTagsToIgnore.Add(TEXT("Skeleton")); AssetRegistryTagsToIgnore.Add(GET_MEMBER_NAME_CHECKED(UAnimSequenceBase, SequenceLength)); AssetRegistryTagsToIgnore.Add(GET_MEMBER_NAME_CHECKED(UAnimSequenceBase, RateScale)); } FReply SAnimationSequenceBrowser::OnKeyDown(const FGeometry& MyGeometry, const FKeyEvent& InKeyEvent) { if (Commands->ProcessCommandBindings(InKeyEvent)) { return FReply::Handled(); } return FReply::Unhandled(); } void SAnimationSequenceBrowser::AddAssetToHistory(const FAssetData& AssetData) { CacheOriginalAnimAssetHistory(); if (CurrentAssetHistoryIndex == AssetHistory.Num() - 1) { // History added to the end if (AssetHistory.Num() == MaxAssetsHistory) { // If max history entries has been reached // remove the oldest history AssetHistory.RemoveAt(0); } } else { // Clear out any history that is in front of the current location in the history list AssetHistory.RemoveAt(CurrentAssetHistoryIndex + 1, AssetHistory.Num() - (CurrentAssetHistoryIndex + 1), true); } AssetHistory.Add(AssetData); CurrentAssetHistoryIndex = AssetHistory.Num() - 1; } FReply SAnimationSequenceBrowser::OnMouseDownHistory( const FGeometry& MyGeometry, const FPointerEvent& MouseEvent, TWeakPtr< SMenuAnchor > InMenuAnchor ) { if(MouseEvent.GetEffectingButton() == EKeys::RightMouseButton) { InMenuAnchor.Pin()->SetIsOpen(true); return FReply::Handled(); } return FReply::Unhandled(); } TSharedRef SAnimationSequenceBrowser::CreateHistoryMenu(bool bInBackHistory) const { FMenuBuilder MenuBuilder(true, NULL); if(bInBackHistory) { int32 HistoryIdx = CurrentAssetHistoryIndex - 1; while( HistoryIdx >= 0 ) { const FAssetData& AssetData = AssetHistory[ HistoryIdx ]; if(AssetData.IsValid()) { const FText DisplayName = FText::FromName(AssetData.AssetName); const FText Tooltip = FText::FromString( AssetData.ObjectPath.ToString() ); MenuBuilder.AddMenuEntry(DisplayName, Tooltip, FSlateIcon(), FUIAction( FExecuteAction::CreateRaw(this, &SAnimationSequenceBrowser::GoToHistoryIndex, HistoryIdx) ), NAME_None, EUserInterfaceActionType::Button); } --HistoryIdx; } } else { int32 HistoryIdx = CurrentAssetHistoryIndex + 1; while( HistoryIdx < AssetHistory.Num() ) { const FAssetData& AssetData = AssetHistory[ HistoryIdx ]; if(AssetData.IsValid()) { const FText DisplayName = FText::FromName(AssetData.AssetName); const FText Tooltip = FText::FromString( AssetData.ObjectPath.ToString() ); MenuBuilder.AddMenuEntry(DisplayName, Tooltip, FSlateIcon(), FUIAction( FExecuteAction::CreateRaw(this, &SAnimationSequenceBrowser::GoToHistoryIndex, HistoryIdx) ), NAME_None, EUserInterfaceActionType::Button); } ++HistoryIdx; } } return MenuBuilder.MakeWidget(); } bool SAnimationSequenceBrowser::CanStepBackwardInHistory() const { int32 HistoryIdx = CurrentAssetHistoryIndex - 1; while( HistoryIdx >= 0 ) { if(AssetHistory[HistoryIdx].IsValid()) { return true; } --HistoryIdx; } return false; } bool SAnimationSequenceBrowser::CanStepForwardInHistory() const { int32 HistoryIdx = CurrentAssetHistoryIndex + 1; while( HistoryIdx < AssetHistory.Num() ) { if(AssetHistory[HistoryIdx].IsValid()) { return true; } ++HistoryIdx; } return false; } FReply SAnimationSequenceBrowser::OnGoForwardInHistory() { while( CurrentAssetHistoryIndex < AssetHistory.Num() - 1) { ++CurrentAssetHistoryIndex; if( AssetHistory[CurrentAssetHistoryIndex].IsValid() ) { GoToHistoryIndex(CurrentAssetHistoryIndex); break; } } return FReply::Handled(); } FReply SAnimationSequenceBrowser::OnGoBackInHistory() { while( CurrentAssetHistoryIndex > 0 ) { --CurrentAssetHistoryIndex; if( AssetHistory[CurrentAssetHistoryIndex].IsValid() ) { GoToHistoryIndex(CurrentAssetHistoryIndex); break; } } return FReply::Handled(); } void SAnimationSequenceBrowser::GoToHistoryIndex(int32 InHistoryIdx) { if(AssetHistory[InHistoryIdx].IsValid()) { CurrentAssetHistoryIndex = InHistoryIdx; OnRequestOpenAsset(AssetHistory[InHistoryIdx], /**bFromHistory=*/true); } } void SAnimationSequenceBrowser::CacheOriginalAnimAssetHistory() { /** If we have nothing in the AssetHistory see if we can store anything for where we currently are as we can't do this on construction */ if (!bTriedToCacheOrginalAsset) { bTriedToCacheOrginalAsset = true; if(AssetHistory.Num() == 0) { USkeleton* DesiredSkeleton = PersonaToolkitPtr.Pin()->GetSkeleton(); if(UObject* PreviewAsset = PersonaToolkitPtr.Pin()->GetPreviewScene()->GetPreviewAnimationAsset()) { FAssetRegistryModule& AssetRegistryModule = FModuleManager::LoadModuleChecked("AssetRegistry"); FAssetData AssetData = AssetRegistryModule.Get().GetAssetByObjectPath(FName(*PreviewAsset->GetPathName())); AssetHistory.Add(AssetData); CurrentAssetHistoryIndex = AssetHistory.Num() - 1; } } } } void SAnimationSequenceBrowser::SelectAsset(UAnimationAsset * AnimAsset) { FAssetData AssetData(AnimAsset); if (AssetData.IsValid()) { TArray CurrentSelection = GetCurrentSelectionDelegate.Execute(); if ( !CurrentSelection.Contains(AssetData) ) { TArray AssetsToSelect; AssetsToSelect.Add(AssetData); SyncToAssetsDelegate.Execute(AssetsToSelect); } } } void SAnimationSequenceBrowser::AddToHistory(UAnimationAsset * AnimAsset) { if (AnimAsset) { FAssetData AssetData(AnimAsset); AddAssetToHistory(AssetData); } } TSharedRef SAnimationSequenceBrowser::CreateCustomAssetToolTip(FAssetData& AssetData) { // Make a list of tags to show TArray Tags; UClass* AssetClass = FindObject(ANY_PACKAGE, *AssetData.AssetClass.ToString()); check(AssetClass); AssetClass->GetDefaultObject()->GetAssetRegistryTags(Tags); TArray TagsToShow; for(UObject::FAssetRegistryTag& TagEntry : Tags) { if(TagEntry.Name != FName(TEXT("Skeleton")) && TagEntry.Type != UObject::FAssetRegistryTag::TT_Hidden) { TagsToShow.Add(TagEntry.Name); } } // Add asset registry tags to a text list; except skeleton as that is implied in Persona TSharedRef DescriptionBox = SNew(SVerticalBox); for(TPair TagPair : AssetData.TagsAndValues) { if(TagsToShow.Contains(TagPair.Key)) { // Check for DisplayName metadata FText DisplayName; if (UProperty* Field = FindField(AssetClass, TagPair.Key)) { DisplayName = Field->GetDisplayNameText(); } else { DisplayName = FText::FromName(TagPair.Key); } DescriptionBox->AddSlot() .AutoHeight() .Padding(0,0,5,0) [ SNew(SHorizontalBox) + SHorizontalBox::Slot() .AutoWidth() [ SNew(STextBlock) .Text(FText::Format(LOCTEXT("AssetTagKey", "{0}: "), DisplayName)) .ColorAndOpacity(FSlateColor::UseSubduedForeground()) ] + SHorizontalBox::Slot() .AutoWidth() [ SNew(STextBlock) .Text(FText::FromString(TagPair.Value)) .ColorAndOpacity(FSlateColor::UseForeground()) ] ]; } } DescriptionBox->AddSlot() .AutoHeight() .Padding(0,0,5,0) [ SNew(SHorizontalBox) + SHorizontalBox::Slot() .AutoWidth() [ SNew(STextBlock) .Text(LOCTEXT("AssetBrowser_FolderPathLabel", "Folder :")) .ColorAndOpacity(FSlateColor::UseSubduedForeground()) ] + SHorizontalBox::Slot() .AutoWidth() [ SNew(STextBlock) .Text(FText::FromName(AssetData.PackagePath)) .ColorAndOpacity(FSlateColor::UseForeground()) .WrapTextAt(300.f) ] ]; TSharedPtr ContentBox = nullptr; TSharedRef ToolTipWidget = SNew(SToolTip) .TextMargin(1) .BorderImage(FEditorStyle::GetBrush("ContentBrowser.TileViewTooltip.ToolTipBorder")) [ SNew(SBorder) .Padding(6) .BorderImage(FEditorStyle::GetBrush("ContentBrowser.TileViewTooltip.NonContentBorder")) [ SNew(SVerticalBox) +SVerticalBox::Slot() .AutoHeight() .Padding(0,0,0,4) [ SNew(SBorder) .Padding(6) .BorderImage(FEditorStyle::GetBrush("ContentBrowser.TileViewTooltip.ContentBorder")) [ SNew(SBox) .HAlign(HAlign_Left) [ SNew(STextBlock) .Text(FText::FromName(AssetData.AssetName)) .Font(FEditorStyle::GetFontStyle("ContentBrowser.TileViewTooltip.NameFont")) ] ] ] + SVerticalBox::Slot() [ SAssignNew(ContentBox, SHorizontalBox) +SHorizontalBox::Slot() .AutoWidth() [ SNew(SBorder) .Padding(6) .Visibility(AssetClass->IsChildOf() ? EVisibility::Visible : EVisibility::Collapsed) .BorderImage(FEditorStyle::GetBrush("ContentBrowser.TileViewTooltip.ContentBorder")) [ SNew(SOverlay) +SOverlay::Slot() .VAlign(VAlign_Center) .HAlign(HAlign_Center) [ SNew(STextBlock) .Text(LOCTEXT("NoPreviewMesh", "No Preview Mesh")) ] + SOverlay::Slot() .VAlign(VAlign_Center) .HAlign(HAlign_Center) [ ViewportWidget.ToSharedRef() ] ] ] ] ] ]; // add an extra section to the tooltip for it. ContentBox->AddSlot() .Padding(AssetClass->IsChildOf() ? 4 : 0, 0, 0, 0) [ SNew(SBorder) .Padding(6) .BorderImage(FEditorStyle::GetBrush("ContentBrowser.TileViewTooltip.ContentBorder")) [ DescriptionBox ] ]; return ToolTipWidget; } void SAnimationSequenceBrowser::CreateAssetTooltipResources() { SAssignNew(ViewportWidget, SViewport) .EnableGammaCorrection(false) .ViewportSize(FVector2D(128, 128)); ViewportClient = MakeShareable(new FAnimationAssetViewportClient(PreviewScene)); SceneViewport = MakeShareable(new FSceneViewport(ViewportClient.Get(), ViewportWidget)); PreviewComponent = NewObject(); // Client options ViewportClient->ViewportType = LVT_Perspective; ViewportClient->bSetListenerPosition = false; // Default view until we need to show the viewport ViewportClient->SetViewLocation(EditorViewportDefs::DefaultPerspectiveViewLocation); ViewportClient->SetViewRotation(EditorViewportDefs::DefaultPerspectiveViewRotation); ViewportClient->Viewport = SceneViewport.Get(); ViewportClient->SetRealtime(true); ViewportClient->SetViewMode(VMI_Lit); ViewportClient->ToggleOrbitCamera(true); ViewportClient->VisibilityDelegate.BindSP(this, &SAnimationSequenceBrowser::IsToolTipPreviewVisible); // Add the scene viewport ViewportWidget->SetViewportInterface(SceneViewport.ToSharedRef()); // Setup the preview component to ensure an animation will update when requested PreviewComponent->MeshComponentUpdateFlag = EMeshComponentUpdateFlag::AlwaysTickPoseAndRefreshBones; PreviewScene.AddComponent(PreviewComponent, FTransform::Identity); const UDestructableMeshEditorSettings* Options = GetDefault(); PreviewScene.SetLightDirection(Options->AnimPreviewLightingDirection); PreviewScene.SetLightColor(Options->AnimPreviewDirectionalColor); PreviewScene.SetLightBrightness(Options->AnimPreviewLightBrightness); } bool SAnimationSequenceBrowser::OnVisualizeAssetToolTip(const TSharedPtr& TooltipContent, FAssetData& AssetData) { // Resolve the asset USkeletalMesh* MeshToUse = nullptr; UClass* AssetClass = FindObject(ANY_PACKAGE, *AssetData.AssetClass.ToString()); if(AssetClass->IsChildOf(UAnimationAsset::StaticClass()) && AssetData.GetAsset()) { // Set up the viewport to show the asset. Catching the visualize allows us to use // one viewport between all of the assets in the sequence browser. UAnimationAsset* Asset = StaticCast(AssetData.GetAsset()); USkeleton* Skeleton = Asset->GetSkeleton(); MeshToUse = Skeleton->GetAssetPreviewMesh(Asset); if(MeshToUse) { if(PreviewComponent->SkeletalMesh != MeshToUse) { PreviewComponent->SetSkeletalMesh(MeshToUse); } PreviewComponent->EnablePreview(true, Asset); PreviewComponent->PreviewInstance->PlayAnim(true); FBoxSphereBounds MeshImportedBounds = MeshToUse->GetImportedBounds(); float HalfFov = FMath::DegreesToRadians(ViewportClient->ViewFOV) / 2.0f; float TargetDist = MeshImportedBounds.SphereRadius / FMath::Tan(HalfFov); ViewportClient->SetViewRotation(FRotator(0.0f, -45.0f, 0.0f)); ViewportClient->SetViewLocationForOrbiting(FVector(0.0f, 0.0f, MeshImportedBounds.BoxExtent.Z / 2.0f), TargetDist); ViewportWidget->SetVisibility(EVisibility::Visible); // Update the preview as long as the tooltip is visible if ( !bIsActiveTimerRegistered ) { bIsActiveTimerRegistered = true; RegisterActiveTimer(0.f, FWidgetActiveTimerDelegate::CreateSP(this, &SAnimationSequenceBrowser::UpdateTootipPreview)); } bToolTipVisualizedThisFrame = true; } else { ViewportWidget->SetVisibility(EVisibility::Hidden); } } // We return false here as we aren't visualizing the tooltip - just detecting when it is about to be shown. // We still want slate to draw it. return false; } void SAnimationSequenceBrowser::OnAssetToolTipClosing() { // Make sure that the tooltip isn't about to preview another animation if (!bToolTipVisualizedThisFrame) { ViewportWidget->SetVisibility(EVisibility::Hidden); } } void SAnimationSequenceBrowser::CleanupPreviewSceneComponent(USceneComponent* Component) { if(Component) { for(int32 ComponentIdx = Component->GetAttachChildren().Num() - 1 ; ComponentIdx >= 0 ; --ComponentIdx) { USceneComponent* ChildComponent = Component->GetAttachChildren()[ComponentIdx]; CleanupPreviewSceneComponent(ChildComponent); } check(Component->GetAttachChildren().Num() == 0); Component->DestroyComponent(); } } EActiveTimerReturnType SAnimationSequenceBrowser::UpdateTootipPreview( double InCurrentTime, float InDeltaTime ) { bToolTipVisualizedThisFrame = false; if ( PreviewComponent && IsToolTipPreviewVisible() ) { // Tick the world to update preview viewport for tooltips PreviewComponent->GetScene()->GetWorld()->Tick( LEVELTICK_All, InDeltaTime ); } else { bIsActiveTimerRegistered = false; return EActiveTimerReturnType::Stop; } return EActiveTimerReturnType::Continue; } bool SAnimationSequenceBrowser::IsToolTipPreviewVisible() { bool bVisible = false; if(ViewportWidget.IsValid()) { bVisible = ViewportWidget->GetVisibility() == EVisibility::Visible; } return bVisible; } EVisibility SAnimationSequenceBrowser::GetHistoryVisibility() const { return bShowHistory ? EVisibility::Visible : EVisibility::Collapsed; } bool SAnimationSequenceBrowser::HandleFilterAsset(const FAssetData& InAssetData) const { if (InAssetData.GetClass()->IsChildOf(UAnimationAsset::StaticClass())) { USkeleton* DesiredSkeleton = PersonaToolkitPtr.Pin()->GetSkeleton(); if (DesiredSkeleton) { FString SkeletonString = FAssetData(DesiredSkeleton).GetExportTextName(); return (InAssetData.TagsAndValues.FindRef(TEXT("Skeleton")) != SkeletonString); } } return false; } void SAnimationSequenceBrowser::HandlePlayAudio(FAssetData InAssetData) { PlayPreviewAudio(Cast(InAssetData.GetAsset())); } void SAnimationSequenceBrowser::HandleStopAudio() { UAudioComponent* AudioComponent = PersonaToolkitPtr.Pin()->GetPreviewScene()->GetActor()->FindComponentByClass(); if (AudioComponent) { AudioComponent->Stop(); } } void SAnimationSequenceBrowser::PlayPreviewAudio(USoundWave* InSoundWave) { if (InSoundWave) { UAudioComponent* AudioComponent = PersonaToolkitPtr.Pin()->GetPreviewScene()->GetActor()->FindComponentByClass(); if (AudioComponent) { // If we are playing this soundwave, stop if (AudioComponent->IsPlaying() && AudioComponent->Sound == InSoundWave) { AudioComponent->Stop(); } else { AudioComponent->Stop(); AudioComponent->SetSound(InSoundWave); AudioComponent->Play(); } } } } FAnimationAssetViewportClient::FAnimationAssetViewportClient(FPreviewScene& InPreviewScene) : FEditorViewportClient(nullptr, &InPreviewScene) { SetViewMode(VMI_Lit); // Always composite editor objects after post processing in the editor EngineShowFlags.SetCompositeEditorPrimitives(true); EngineShowFlags.DisableAdvancedFeatures(); // Setup defaults for the common draw helper. DrawHelper.bDrawPivot = false; DrawHelper.bDrawWorldBox = false; DrawHelper.bDrawKillZ = false; DrawHelper.bDrawGrid = true; DrawHelper.GridColorAxis = FColor(70, 70, 70); DrawHelper.GridColorMajor = FColor(40, 40, 40); DrawHelper.GridColorMinor = FColor(20, 20, 20); DrawHelper.PerspectiveGridSize = HALF_WORLD_MAX1; bDrawAxes = false; } FSceneInterface* FAnimationAssetViewportClient::GetScene() const { return PreviewScene->GetScene(); } FLinearColor FAnimationAssetViewportClient::GetBackgroundColor() const { return FLinearColor(0.8f, 0.85f, 0.85f); } #undef LOCTEXT_NAMESPACE