MovieSceneChannelHandle.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "HAL/Platform.h"
#include "Misc/AssertionMacros.h"
#include "Templates/SharedPointer.h"
#include "UObject/NameTypes.h"
 
struct FMovieSceneChannel;
struct FMovieSceneChannelMetaData;
struct FMovieSceneChannelProxy;
template<typename> struct TMovieSceneChannelHandle;
template<typename> struct TMovieSceneChannelTraits;
 
struct FMovieSceneChannelHandle
{
    MOVIESCENE_API FMovieSceneChannelHandle();
 
    MOVIESCENE_API FMovieSceneChannelHandle(TWeakPtr<FMovieSceneChannelProxy> InWeakChannelProxy, FName InChannelTypeName, int32 InChannelIndex);
 
public:
 
    friend bool operator==(const FMovieSceneChannelHandle& A, const FMovieSceneChannelHandle& B)
    {
        if (A.ChannelIndex == B.ChannelIndex && A.ChannelTypeName == B.ChannelTypeName)
        {
            FMovieSceneChannelProxy* ProxyA = A.WeakChannelProxy.Pin().Get();
            FMovieSceneChannelProxy* ProxyB = B.WeakChannelProxy.Pin().Get();
 
            // Cannot be equal if either handle is expired
            return ProxyA && ProxyA == ProxyB;
        }
        return false;
    }
 
    friend bool operator!=(const FMovieSceneChannelHandle& A, const FMovieSceneChannelHandle& B)
    {
        return !(A == B);
    }
 
    template<typename ChannelType>
    static void TrackChannelTypeName()
    {
#if DO_CHECK
        TrackChannelTypeNameInternal(ChannelType::StaticStruct());
#endif
    }
 
public:
 
    template<typename OtherChannelType>
    TMovieSceneChannelHandle<OtherChannelType> Cast() const;
 
    MOVIESCENE_API FName GetChannelTypeName() const;
 
    MOVIESCENE_API int32 GetChannelIndex() const;
 
    MOVIESCENE_API FMovieSceneChannel* Get() const;
 
    FMovieSceneChannelProxy* GetChannelProxy() const
    {
        return WeakChannelProxy.Pin().Get();
    }
 
#if WITH_EDITOR
 
    MOVIESCENE_API const FMovieSceneChannelMetaData* GetMetaData() const;
 
    MOVIESCENE_API const void* GetExtendedEditorData() const;
 
#endif // WITH_EDITOR
 
private:
 
#if DO_CHECK
    MOVIESCENE_API static void TrackChannelTypeNameInternal(UStruct* ChannelType);
    MOVIESCENE_API static UStruct* GetChannelTypeByName(FName ChannelName);
    MOVIESCENE_API bool IsCastValidInternal(UStruct* OtherType) const;
 
    template<typename OtherChannelType>
    bool IsCastValid() const
    {
        return IsCastValidInternal(OtherChannelType::StaticStruct());
    }
#endif // DO_CHECK
 
private:
 
    TWeakPtr<FMovieSceneChannelProxy> WeakChannelProxy;
 
    FName ChannelTypeName;
 
    int32 ChannelIndex;
};
 
 
template<typename ChannelType> struct TMovieSceneChannelHandle;
 
template<> struct TMovieSceneChannelHandle<FMovieSceneChannel> : FMovieSceneChannelHandle
{
protected:
    TMovieSceneChannelHandle()
    {}
 
    TMovieSceneChannelHandle(TWeakPtr<FMovieSceneChannelProxy> InWeakChannelProxy, FName InName, int32 InChannelIndex)
        : FMovieSceneChannelHandle(InWeakChannelProxy, InName, InChannelIndex)
    {}
};
 
template<typename ChannelType>
struct TMovieSceneChannelHandle : TMovieSceneChannelHandle<typename ChannelType::Super>
{
    TMovieSceneChannelHandle()
    {}
 
    TMovieSceneChannelHandle(TWeakPtr<FMovieSceneChannelProxy> InWeakChannelProxy, int32 InChannelIndex)
        : TMovieSceneChannelHandle<typename ChannelType::Super>(InWeakChannelProxy, ChannelType::StaticStruct()->GetFName(), InChannelIndex)
    {}
 
    ChannelType* Get() const
    {
        return static_cast<ChannelType*>(FMovieSceneChannelHandle::Get());
    }
 
#if WITH_EDITOR
 
    const typename TMovieSceneChannelTraits<ChannelType>::ExtendedEditorDataType* GetExtendedEditorData() const
    {
        return static_cast<const typename TMovieSceneChannelTraits<ChannelType>::ExtendedEditorDataType*>(FMovieSceneChannelHandle::GetExtendedEditorData());
    }
 
#endif // WITH_EDITOR
 
protected:
 
    TMovieSceneChannelHandle(TWeakPtr<FMovieSceneChannelProxy> InWeakChannelProxy, FName InChannelTypeName, int32 InChannelIndex)
        : TMovieSceneChannelHandle<typename ChannelType::Super>(InWeakChannelProxy, InChannelTypeName, InChannelIndex)
    {}
 
    friend FMovieSceneChannelHandle;
};
 
 
template<typename OtherChannelType>
TMovieSceneChannelHandle<OtherChannelType> FMovieSceneChannelHandle::Cast() const
{
#if DO_CHECK
    checkf(IsCastValid<OtherChannelType>(), TEXT("Invalid cast between unrelated channel types"));
#endif
 
    return TMovieSceneChannelHandle<OtherChannelType>(WeakChannelProxy, ChannelTypeName, ChannelIndex);
}