MovieScenePossessable.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/Array.h"
#include "Containers/UnrealString.h"
#include "CoreMinimal.h"
#include "CoreTypes.h"
#include "Misc/Guid.h"
#include "MovieSceneDynamicBinding.h"
#include "MovieSceneObjectBindingID.h"
#include "MovieSceneSequenceID.h"
#include "UObject/NameTypes.h"
#include "UObject/Object.h"
#include "UObject/ObjectMacros.h"
#include "UObject/SoftObjectPtr.h"
 
#include "MovieScenePossessable.generated.h"
 
class IMovieScenePlayer;
class UClass;
class UMovieScene;
struct FMovieSceneSequenceID;
 
namespace UE::MovieScene
{
    struct FSharedPlaybackState;
}
 
USTRUCT()
struct FMovieScenePossessable
{
    GENERATED_USTRUCT_BODY(FMovieScenePossessable)
 
public:
 
    FMovieScenePossessable() { }
 
    FMovieScenePossessable(const FString& InitName, UClass* InitPossessedObjectClass)
        : Guid(FGuid::NewGuid())
        , Name(InitName)
#if WITH_EDITORONLY_DATA
        , PossessedObjectClass(InitPossessedObjectClass)
#endif
    { }
 
public:
 
    const FGuid& GetGuid() const
    {
        return Guid;
    }
 
    void SetGuid(const FGuid& InGuid)
    {
        Guid = InGuid;
    }
 
    const FString& GetName() const
    {
        return Name;
    }
 
    void SetName(const FString& InName)
    {
        Name = InName;
    }
 
#if WITH_EDITORONLY_DATA
 
    const UClass* GetPossessedObjectClass() const
    {
        if (PossessedObjectClass.ToSoftObjectPath().IsNull())
        {
            return nullptr;
        }
 
        return LoadObject<UClass>(nullptr, *PossessedObjectClass.ToSoftObjectPath().ToString(), nullptr, LOAD_EditorOnly);
    }
 
    const UClass* GetLoadedPossessedObjectClass() const
    {
        return (const UClass*)(PossessedObjectClass.Get());
    }
 
    void SetPossessedObjectClass(UClass* InClass)
    {
        PossessedObjectClass = InClass;
    }
 
    MOVIESCENE_API void FixupPossessedObjectClass(UMovieSceneSequence* InSequence, UObject* Context);
 
#endif
 
    const FGuid& GetParent() const
    {
        return ParentGuid;
    }
 
    UE_DEPRECATED(5.1, "Please use the overload that takes a UMovieScene* to ensure that events are triggered correctly")
    MOVIESCENE_API void SetParent(const FGuid& InParentGuid);
 
    MOVIESCENE_API void SetParent(const FGuid& InParentGuid, UMovieScene* Owner);
 
    UPROPERTY(EditAnywhere, AdvancedDisplay, Category=Actor)
    TArray<FName> Tags;
 
    // Property has been deprecated- 'Dynamic Bindings' are now handled by UMovieSceneReplaceableDirectorBlueprintBinding and the custom binding system
    UPROPERTY()
    FMovieSceneDynamicBinding DynamicBinding_DEPRECATED;
 
    /* Get the optional binding id for binding to a spawnable */
    const FMovieSceneObjectBindingID& GetSpawnableObjectBindingID() const 
    {
        return SpawnableObjectBindingID;
    }
 
    /* Set the optional binding id for binding to a spawnable */
    void SetSpawnableObjectBindingID(const FMovieSceneObjectBindingID& InSpawnableObjectBindingID)
    {
        SpawnableObjectBindingID = InSpawnableObjectBindingID;
    }
 
    /* Bind the potential spawnable object to this possessable by setting the ObjectBindingID */
    MOVIESCENE_API bool BindSpawnableObject(FMovieSceneSequenceID SequenceID, UObject* Object, TSharedRef<const UE::MovieScene::FSharedPlaybackState> SharedPlaybackState);
 
    UE_DEPRECATED(5.4, "Please use the FSharedPlaybackState version of this method")
    MOVIESCENE_API bool BindSpawnableObject(FMovieSceneSequenceID SequenceID, UObject* Object, IMovieScenePlayer* Player);
 
    /* For sorts so we can search quickly by Guid */
    inline bool operator<(const FMovieScenePossessable& RHS) const { return Guid < RHS.Guid; }
    inline friend bool operator<(const FGuid& InGuid, const FMovieScenePossessable& RHS) { return InGuid < RHS.GetGuid(); }
    inline bool operator<(const FGuid& InGuid) const { return Guid < InGuid; }
 
private:
 
    // @todo sequencer: Guids need to be handled carefully when the asset is duplicated (or loaded after being copied on disk).
    //                  Sometimes we'll need to generate fresh Guids.
    UPROPERTY()
    FGuid Guid;
 
    // @todo sequencer: Should be editor-only probably
    UPROPERTY()
    FString Name;
 
#if WITH_EDITORONLY_DATA
 
    UPROPERTY()
    TSoftClassPtr<UObject> PossessedObjectClass;
 
#endif
 
    UPROPERTY()
    FGuid ParentGuid;
 
    UPROPERTY()
    FMovieSceneObjectBindingID SpawnableObjectBindingID;
};