Sequencer 構造解説とカスタムトラック追加 (UE4.18版) – カスタムトラック編

// ActorEventTrackEditor.h
#pragma once

#include "CoreMinimal.h"

#include "Templates/SubclassOf.h"
#include "Widgets/SWidget.h"
#include "ISequencer.h"
#include "MovieSceneTrack.h"
#include "ISequencerSection.h"
#include "ISequencerTrackEditor.h"
#include "MovieSceneTrackEditor.h"

class FMenuBuilder;

class FActorEventTrackEditor : public FMovieSceneTrackEditor
{
public:

FActorEventTrackEditor(TSharedRef<ISequencer> InSequencer);
virtual ~FActorEventTrackEditor() { }

// 自分自身のインスタンスを SharedRef で返す関数。
// モジュール開始時に TrackEditor を生成する関数を登録する必要があるため、static で定義
static TSharedRef<ISequencerTrackEditor> CreateTrackEditor(TSharedRef<ISequencer> OwningSequencer);

public:

// ISequencerTrackEditor interface

// セクションの生成
virtual TSharedRef<ISequencerSection> MakeSectionInterface(UMovieSceneSection& SectionObject, UMovieSceneTrack& Track, FGuid ObjectBinding) override;
// サポートする Sequencer だったときのみ true を返す
virtual bool SupportsSequence(UMovieSceneSequence* InSequence) const override;
// サポートするトラックだったときのみ true を返す
virtual bool SupportsType(TSubclassOf<UMovieSceneTrack> Type) const override;
// アイコンを設定する場合に使う
virtual const FSlateBrush* GetIconBrush() const override;

// ObjectBinding 用のトラックメニューに項目追加したい場合に使用
virtual void BuildObjectBindingTrackMenu(FMenuBuilder& MenuBuilder, const FGuid& ObjectBinding, const UClass* ObjectClass) override;

// Master Tarck からトラックメニューを項目追加したい場合に使用
//virtual void BuildAddTrackMenu(FMenuBuilder& MenuBuilder) override;
// トラック名の上で右クリックした際に表示されるメニューを追加する場合に使用
//virtual void BuildTrackContextMenu( FMenuBuilder& MenuBuilder, UMovieSceneTrack* Track ) override;
// トラック名の横に Widget を追加するする場合に使用
//virtual TSharedPtr<SWidget> BuildOutlinerEditWidget(const FGuid& ObjectBinding, UMovieSceneTrack* Track, const FBuildEditWidgetParams& Params) override;

private:
void FindOrCreateTrack(FGuid ObjectHandle);
};

// ActorEventTrackEditor.cpp
#include "ActorEventTrackEditor.h"

#include "Misc/Guid.h"
#include "Framework/MultiBox/MultiBoxBuilder.h"
#include "EditorStyleSet.h"
#include "SequencerUtilities.h"

#include "Tracks/MovieSceneEventTrack.h"
#include "ActorEventSection.h"

#include "MovieScene.h"

#define LOCTEXT_NAMESPACE "FActorEventTrackEditor"

FActorEventTrackEditor::FActorEventTrackEditor(TSharedRef<ISequencer> InSequencer)
: FMovieSceneTrackEditor(InSequencer)
{ }

TSharedRef<ISequencerTrackEditor> FActorEventTrackEditor::CreateTrackEditor(TSharedRef<ISequencer> InSequencer)
{
  return MakeShareable(new FActorEventTrackEditor(InSequencer));
}

bool FActorEventTrackEditor::SupportsSequence(UMovieSceneSequence* InSequence) const
{
  // Level Sequence のみ許可する。
  // 他のコードをみても、こんな感じで GetName で判定している。
  // クラスで比較しないのはおそらくモジュール依存関係を増やさないためだと思われる。
  return (InSequence != nullptr) && (InSequence->GetClass()->GetName() == TEXT("LevelSequence"));
}

bool FActorEventTrackEditor::SupportsType(TSubclassOf<UMovieSceneTrack> Type) const
{
  // UMovieSceneEventTrack に対して許可
  return Type == UMovieSceneEventTrack::StaticClass();
}

TSharedRef<ISequencerSection> FActorEventTrackEditor::MakeSectionInterface(UMovieSceneSection& SectionObject, UMovieSceneTrack& Track, FGuid ObjectBinding)
{
  // Editor 用 Section の作成 Event Track の ISequencerSection は直接使えないので自作する。
  // 中身は FEventTrackSection のコピーで構わない
  return MakeShareable(new FActorEventSection(SectionObject, GetSequencer()));
}

const FSlateBrush* FActorEventTrackEditor::GetIconBrush() const
{
  // イベントトラックと同じアイコンにしておく
  return FEditorStyle::GetBrush("Sequencer.Tracks.Event");
}

void FActorEventTrackEditor::BuildObjectBindingTrackMenu(FMenuBuilder& MenuBuilder, const FGuid& ObjectBinding, const UClass* ObjectClass)
{
  // 念のためアクター限定としておく
  if (ObjectClass->IsChildOf(AActor::StaticClass()))
  {
    MenuBuilder.AddMenuEntry(
      NSLOCTEXT("Sequencer", "AddActorEvent", "Actor Event"),
      NSLOCTEXT("Sequencer", "AddActorEventTooltip", "アクター用 Event Track を追加する"),
      FSlateIcon(),
      FUIAction(
        FExecuteAction::CreateSP(this, &FActorEventTrackEditor::FindOrCreateTrack, ObjectBinding)
      )
    );
  }
}

void FActorEventTrackEditor::FindOrCreateTrack(FGuid ObjectHandle)
{
  // トラックがなかったら作成する
  FFindOrCreateTrackResult TrackResult = FindOrCreateTrackForObject(ObjectHandle, UMovieSceneEventTrack::StaticClass(), TEXT("Actor Event"));
  auto* NewTrack = CastChecked<UMovieSceneEventTrack>(TrackResult.Track, ECastCheckedType::NullAllowed);

  if (TrackResult.bWasCreated)
  {
    // トラック作成成功

    // トラック側に BindingID をセット
    FMovieSceneObjectBindingID BindingID(ObjectHandle, GetSequencer()->GetFocusedTemplateID());
    NewTrack->EventReceivers.Add(BindingID);

    // セクション作成
    UMovieSceneSection* NewSection = NewTrack->CreateNewSection();
    check(NewSection);

    // セクション追加
    NewTrack->AddSection(*NewSection);
    NewTrack->SetDisplayName(LOCTEXT("TrackName", "Actor Events"));
  }

  // 構成に変更が起きたことを Sequencer に伝える(トラックが再描画される）
  GetSequencer()->NotifyMovieSceneDataChanged(EMovieSceneDataChangeType::MovieSceneStructureItemAdded);
}

#undef LOCTEXT_NAMESPACE

// CustomTrackEditor.h
#pragma once

#include "CoreMinimal.h"

#include "UnrealEd.h"

class FCustomTrackEditor: public IModuleInterface
{
public:

  void StartupModule() override;
  void ShutdownModule() override;

private:

  FDelegateHandle ActorEventTrackEditorHandle;
};

// CustomTrackEditor.cpp
#include "CustomTrackEditor.h"
#include "Modules/ModuleManager.h"

#include "ISequencerModule.h"

#include "ActorEventTrackEditor.h"

void FCustomTrackEditor::StartupModule()
{
  ISequencerModule& SequencerModule = FModuleManager::Get().LoadModuleChecked<ISequencerModule>("Sequencer");
  ActorEventTrackEditorHandle = SequencerModule.RegisterTrackEditor(
  FOnCreateTrackEditor::CreateStatic(&FActorEventTrackEditor::CreateTrackEditor));
}

void FCustomTrackEditor::ShutdownModule()
{
  if (!FModuleManager::Get().IsModuleLoaded("Sequencer"))
  {
    return;
  }

  ISequencerModule& SequencerModule = FModuleManager::Get().GetModuleChecked<ISequencerModule>("Sequencer");
  SequencerModule.UnRegisterTrackEditor(ActorEventTrackEditorHandle);
}

IMPLEMENT_PRIMARY_GAME_MODULE(FCustomTrackEditor, CustomTrackEditor, "CustomTrackEditor" );