MovieSceneChannelEditorData.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "HAL/Platform.h"
#include "Internationalization/Text.h"
#include "Math/Color.h"
#include "Misc/Optional.h"
#include "MovieSceneCommonHelpers.h"
#include "Templates/Function.h"
#include "UObject/NameTypes.h"
#include "Misc/FrameNumber.h"
#include "Misc/Attribute.h"
 
class FTrackInstancePropertyBindings;
class UMovieSceneSection;
class IMovieScenePlayer;
class UObject;
struct FMovieSceneSequenceID;
struct FFrameNumber;
struct FFrameRate;
struct FGuid;
struct FMovieSceneRootEvaluationTemplateInstance;
 
#if WITH_EDITOR
 
DECLARE_DELEGATE_RetVal_ThreeParams(FText, FGetMovieSceneTooltipText, IMovieScenePlayer*, FGuid, FMovieSceneSequenceID);
struct FMovieSceneChannelMetaData
{
    /*
     * Default Constructor
     */
    MOVIESCENE_API FMovieSceneChannelMetaData();
 
    /*
     * Construction from a name and display text. Necessary when there is more than one channel.
     *
     * @param InName           The unique name of this channel within the section
     * @param InDisplayText    Text to display on the sequencer node tree
     * @param InGroup          (Optional) When not empty, specifies a name to group channels by
     * @param bInEnabled        (Optional) When true the channel is enabled, if false it is not.
     */
    MOVIESCENE_API FMovieSceneChannelMetaData(FName InName, FText InDisplayText, FText InGroup = FText(), bool bInEnabled = true);
 
    /*
     * Set the identifiers for this editor data
     *
     * @param InName           The unique name of this channel within the section
     * @param InDisplayText    Text to display on the sequencer node tree
     * @param InGroup          (Optional) When not empty, specifies a name to group channels by
     */
    MOVIESCENE_API void SetIdentifiers(FName InName, FText InDisplayText, FText InGroup = FText());
 
    /*
     * Get property metadata that corresponds to the given key.
     * 
     * @param InKey The requested key to get metadata for
     */
    MOVIESCENE_API FString GetPropertyMetaData(const FName& InKey) const;
 
    /*
     * Get the amount that all of this channel's keys are offset by
     */
    MOVIESCENE_API FFrameNumber GetOffsetTime(const UMovieSceneSection* InSection) const;
 
    uint8 bEnabled : 1;
    uint8 bCanCollapseToTrack : 1;
    uint8 bRelativeToSection : 1;
    uint32 SortOrder;
    bool bSortEmptyGroupsLast;
    bool bInvertValue;
    bool bCanPreserveRatio;
    mutable bool bPreserveRatio;
 
    FName Name;
    FName SubPropertyPath;
    TMap<FName, FName> SubPropertyPathMap;
    FText DisplayText;
    FGetMovieSceneTooltipText GetTooltipTextDelegate;
    FText Group;
    FGetMovieSceneTooltipText GetGroupTooltipTextDelegate;
    FText IntentName;
    /* Optional. If unspecified IKeyArea::CreateCurveEditorModel will create a fallback. */
    FText LongIntentNameFormat;
    TOptional<FLinearColor> Color;
    TMap<FName, FString> PropertyMetaData;
    TWeakObjectPtr<> WeakOwningObject;
    TAttribute<FFrameNumber> KeyOffset;
};
 
 
template<typename T>
struct TMovieSceneExternalValue
{
    TMovieSceneExternalValue()
    {}
 
    static TMovieSceneExternalValue<T> Make()
    {
        TMovieSceneExternalValue<T> Result;
        Result.OnGetExternalValue = GetValue;
        return Result;
    }
 
    static TOptional<T> GetValue(UObject& InObject, FTrackInstancePropertyBindings* Bindings)
    {
        return Bindings ? Bindings->GetCurrentValue<T>(InObject) : TOptional<T>();
    }
 
    TFunction<TOptional<T>(UObject&, FTrackInstancePropertyBindings*)> OnGetExternalValue;
 
    TFunction<void (UObject*, UMovieSceneSection*,  FFrameNumber, FFrameRate, FMovieSceneRootEvaluationTemplateInstance&, T&, float&) > OnGetCurrentValueAndWeight;
};
 
 
struct FCommonChannelData
{
    static MOVIESCENE_API const FText ChannelX;
    static MOVIESCENE_API const FText ChannelY;
    static MOVIESCENE_API const FText ChannelZ;
    static MOVIESCENE_API const FText ChannelW;
 
    static MOVIESCENE_API const FText ChannelR;
    static MOVIESCENE_API const FText ChannelG;
    static MOVIESCENE_API const FText ChannelB;
    static MOVIESCENE_API const FText ChannelA;
 
    static MOVIESCENE_API const FLinearColor RedChannelColor;
    static MOVIESCENE_API const FLinearColor GreenChannelColor;
    static MOVIESCENE_API const FLinearColor BlueChannelColor;
 
    static MOVIESCENE_API const FName TooltipText;
    static MOVIESCENE_API const FName GroupDisplayName;
};
 
 
#endif // WITH_EDITOR