UnrealEngineUWP/Engine/Source/Runtime/MovieScene/Private/MovieSceneObjectBindingID.cpp

// Copyright Epic Games, Inc. All Rights Reserved.

#include "MovieSceneObjectBindingID.h"
#include "Evaluation/MovieSceneSequenceHierarchy.h"
#include "Evaluation/MovieSceneEvaluationTemplateInstance.h"
#include "Compilation/MovieSceneCompiledDataManager.h"
#include "EntitySystem/MovieSceneSequenceInstance.h"
#include "IMovieScenePlayer.h"



namespace UE
{
namespace MovieScene
{


FMovieSceneSequenceID ResolveExternalSequenceID(FMovieSceneSequenceID SourceSequenceID, int32 RemapSourceParentIndex, FMovieSceneSequenceID TargetSequenceID, IMovieScenePlayer& Player)
{
	ensureMsgf(RemapSourceParentIndex >= 0, TEXT("Invalid parent index specified"));

	if (SourceSequenceID == MovieSceneSequenceID::Root)
	{
		return TargetSequenceID;
	}

	const FMovieSceneSequenceHierarchy* Hierarchy = Player.GetEvaluationTemplate().GetHierarchy();
	if (!ensureMsgf(Hierarchy, TEXT("Sequence being evaluated as a sub sequence without any hierarchy. This indicates a bug with either the player or the compiled data.")))
	{
		return TargetSequenceID;
	}

	using namespace UE::MovieScene;

	FSubSequencePath PathFromSource(SourceSequenceID, Hierarchy);
	PathFromSource.PopGenerations(RemapSourceParentIndex);
	return PathFromSource.ResolveChildSequenceID(TargetSequenceID);
}


FMovieSceneSequenceID ResolveExternalSequenceID(FMovieSceneSequenceID SourceSequenceID, int32 RemapSourceParentIndex, FMovieSceneSequenceID TargetSequenceID, const FMovieSceneSequenceHierarchy* Hierarchy)
{
	ensureMsgf(RemapSourceParentIndex >= 0, TEXT("Invalid parent index specified"));

	if (SourceSequenceID == MovieSceneSequenceID::Root)
	{
		return TargetSequenceID;
	}

	if (!ensureMsgf(Hierarchy, TEXT("Sequence being evaluated as a sub sequence without any hierarchy. This indicates a bug with either the player or the compiled data.")))
	{
		return TargetSequenceID;
	}

	using namespace UE::MovieScene;

	FSubSequencePath PathFromSource(SourceSequenceID, Hierarchy);
	PathFromSource.PopGenerations(RemapSourceParentIndex);
	return PathFromSource.ResolveChildSequenceID(TargetSequenceID);
}


FRelativeObjectBindingID::FRelativeObjectBindingID(FMovieSceneSequenceID SourceSequenceID, FMovieSceneSequenceID TargetSequenceID, const FGuid& TargetGuid, UMovieSceneSequence* MasterSequence)
{
	UMovieSceneCompiledDataManager* CompiledDataManager = UMovieSceneCompiledDataManager::GetPrecompiledData();

	FMovieSceneSequenceHierarchy TempHierarchy;
	UMovieSceneCompiledDataManager::CompileHierarchy(MasterSequence, &TempHierarchy, EMovieSceneServerClientMask::All);

	ConstructInternal(SourceSequenceID, TargetSequenceID, TargetGuid, &TempHierarchy);
}


FRelativeObjectBindingID::FRelativeObjectBindingID(FMovieSceneSequenceID SourceSequenceID, FMovieSceneSequenceID TargetSequenceID, const FGuid& TargetGuid, IMovieScenePlayer& Player)
{
	ConstructInternal(SourceSequenceID, TargetSequenceID, TargetGuid, Player.GetEvaluationTemplate().GetHierarchy());
}


FRelativeObjectBindingID::FRelativeObjectBindingID(FMovieSceneSequenceID SourceSequenceID, FMovieSceneSequenceID TargetSequenceID, const FGuid& TargetGuid, const FMovieSceneSequenceHierarchy* Hierarchy)
{
	ConstructInternal(SourceSequenceID, TargetSequenceID, TargetGuid, Hierarchy);
}

void FRelativeObjectBindingID::ConstructInternal(FMovieSceneSequenceID SourceSequenceID, FMovieSceneSequenceID TargetSequenceID, const FGuid& TargetGuid, const FMovieSceneSequenceHierarchy* Hierarchy)
{
	FSubSequencePath PathFromOwner(SourceSequenceID, Hierarchy);
	FSubSequencePath PathFromTarget(TargetSequenceID, Hierarchy);

	FMovieSceneSequenceID CommonParent = FSubSequencePath::FindCommonParent(PathFromOwner, PathFromTarget);

	Guid = TargetGuid;
	SequenceID = PathFromTarget.MakeLocalSequenceID(CommonParent);
	ResolveParentIndex = PathFromOwner.NumGenerationsFromLeaf(CommonParent);
}

FRelativeObjectBindingID FFixedObjectBindingID::ConvertToRelative(FMovieSceneSequenceID SourceSequenceID, IMovieScenePlayer& InPlayer) const
{
	return FRelativeObjectBindingID(SourceSequenceID, SequenceID, Guid, InPlayer);
}

FRelativeObjectBindingID FFixedObjectBindingID::ConvertToRelative(FMovieSceneSequenceID SourceSequenceID, const FMovieSceneSequenceHierarchy* Hierarchy) const
{
	return FRelativeObjectBindingID(SourceSequenceID, SequenceID, Guid, Hierarchy);
}


} // namespace MovieScene
} // namespace UE




#if WITH_EDITORONLY_DATA

void FMovieSceneObjectBindingID::PostSerialize(const FArchive& Ar)
{
	if (Space_DEPRECATED != EMovieSceneObjectBindingSpace::Unused)
	{
		ResolveParentIndex = (Space_DEPRECATED == EMovieSceneObjectBindingSpace::Local) ? 0 : FixedRootSequenceParentIndex;
		Space_DEPRECATED = EMovieSceneObjectBindingSpace::Unused;
	}
}

#endif // WITH_EDITORONLY_DATA

FMovieSceneSequenceID FMovieSceneObjectBindingID::ResolveSequenceID(FMovieSceneSequenceID LocalSequenceID, IMovieScenePlayer& Player) const
{
	FMovieSceneSequenceID TargetSequenceID = FMovieSceneSequenceID(SequenceID);

	if (ResolveParentIndex == FixedRootSequenceParentIndex)
	{
		return TargetSequenceID;
	}
	
	return UE::MovieScene::ResolveExternalSequenceID(LocalSequenceID, ResolveParentIndex, TargetSequenceID, Player);
}

FMovieSceneSequenceID FMovieSceneObjectBindingID::ResolveSequenceID(FMovieSceneSequenceID LocalSequenceID, const FMovieSceneSequenceHierarchy* Hierarchy) const
{
	FMovieSceneSequenceID TargetSequenceID = FMovieSceneSequenceID(SequenceID);

	if (ResolveParentIndex == FixedRootSequenceParentIndex)
	{
		return TargetSequenceID;
	}

	return UE::MovieScene::ResolveExternalSequenceID(LocalSequenceID, ResolveParentIndex, TargetSequenceID, Hierarchy);

}
UE::MovieScene::FFixedObjectBindingID FMovieSceneObjectBindingID::ResolveToFixed(FMovieSceneSequenceID RuntimeSequenceID, IMovieScenePlayer& Player) const
{
	FMovieSceneSequenceID ThisSequenceID = FMovieSceneSequenceID(SequenceID);

	if (ResolveParentIndex == FixedRootSequenceParentIndex)
	{
		return UE::MovieScene::FFixedObjectBindingID(Guid, ThisSequenceID);
	}
	else if (ensure(RuntimeSequenceID != MovieSceneSequenceID::Invalid))
	{
		ThisSequenceID = UE::MovieScene::ResolveExternalSequenceID(RuntimeSequenceID, ResolveParentIndex, ThisSequenceID, Player);

		return UE::MovieScene::FFixedObjectBindingID(Guid, ThisSequenceID);
	}

	return UE::MovieScene::FFixedObjectBindingID(Guid, MovieSceneSequenceID::Invalid);
}

TArrayView<TWeakObjectPtr<>> FMovieSceneObjectBindingID::ResolveBoundObjects(FMovieSceneSequenceID LocalSequenceID, IMovieScenePlayer& Player) const
{
	if (!IsValid())
	{
		return TArrayView<TWeakObjectPtr<>>();
	}

	FMovieSceneSequenceID ResolvedSequenceID = ResolveSequenceID(LocalSequenceID, Player);
	return Player.FindBoundObjects(Guid, ResolvedSequenceID);
}

TArrayView<TWeakObjectPtr<>> FMovieSceneObjectBindingID::ResolveBoundObjects(const UE::MovieScene::FSequenceInstance& SequenceInstance) const
{
	if (!IsValid())
	{
		return TArrayView<TWeakObjectPtr<>>();
	}

	return ResolveBoundObjects(SequenceInstance.GetSequenceID(), *SequenceInstance.GetPlayer());
}