InterchangeSourceNode.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "Containers/UnrealString.h"
#include "HAL/Platform.h"
#include "Nodes/InterchangeBaseNode.h"
#include "Nodes/InterchangeBaseNodeUtilities.h"
#include "UObject/ObjectMacros.h"
 
#include "InterchangeSourceNode.generated.h"
 
class UInterchangeBaseNodeContainer;
class UObject;
struct FFrame;
 
namespace UE::Interchange
{
 
    struct FSourceNodeExtraInfoStaticData
    {
        static INTERCHANGECORE_API const FString& GetApplicationVendorExtraInfoKey();
        static INTERCHANGECORE_API const FString& GetApplicationNameExtraInfoKey();
        static INTERCHANGECORE_API const FString& GetApplicationVersionExtraInfoKey();
    };
}
 
UCLASS(BlueprintType, MinimalAPI)
class UInterchangeSourceNode : public UInterchangeBaseNode
{
    GENERATED_BODY()
 
    UInterchangeSourceNode();
 
public:
    UFUNCTION(BlueprintCallable, Category = "Interchange | Node | source")
    INTERCHANGECORE_API void InitializeSourceNode(const FString& UniqueID, const FString& DisplayLabel, UInterchangeBaseNodeContainer* NodeContainer);
 
    INTERCHANGECORE_API virtual FString GetTypeName() const override;
 
    /* Translators that want to modify the common data should ensure they create the unique common pipeline node. */
    static INTERCHANGECORE_API UInterchangeSourceNode* FindOrCreateUniqueInstance(UInterchangeBaseNodeContainer* NodeContainer);
 
    /* This function should be use by pipelines to avoid creating a node. If the unique instance doesn't exist, returns nullptr. */
    UFUNCTION(BlueprintCallable, Category = "Interchange | Node | source")
    static INTERCHANGECORE_API const UInterchangeSourceNode* GetUniqueInstance(const UInterchangeBaseNodeContainer* NodeContainer);
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Node | Source")
    INTERCHANGECORE_API bool GetCustomSourceFrameRateNumerator(int32& AttributeValue) const;
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Node | Source")
    INTERCHANGECORE_API bool SetCustomSourceFrameRateNumerator(const int32& AttributeValue);
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Node | Source")
    INTERCHANGECORE_API bool GetCustomSourceFrameRateDenominator(int32& AttributeValue) const;
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Node | Source")
    INTERCHANGECORE_API bool SetCustomSourceFrameRateDenominator(const int32& AttributeValue);
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Node | Source")
    UE_DEPRECATED(5.6, "Please, use UInterchangeSkeletalAnimationTrackNode::GetCustomSourceTimelineAnimationStartTime")
    INTERCHANGECORE_API bool GetCustomSourceTimelineStart(double& AttributeValue) const;
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Node | Source")
    UE_DEPRECATED(5.6, "Please, use UInterchangeSkeletalAnimationTrackNode::SetCustomSourceTimelineAnimationStartTime")
    INTERCHANGECORE_API bool SetCustomSourceTimelineStart(const double& AttributeValue);
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Node | Source")
    UE_DEPRECATED(5.6, "Please, use UInterchangeSkeletalAnimationTrackNode::GetCustomSourceTimelineAnimationStopTime")
    INTERCHANGECORE_API bool GetCustomSourceTimelineEnd(double& AttributeValue) const;
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Node | Source")
    UE_DEPRECATED(5.6, "Please, use UInterchangeSkeletalAnimationTrackNode::SetCustomSourceTimelineAnimationStopTime")
    INTERCHANGECORE_API bool SetCustomSourceTimelineEnd(const double& AttributeValue);
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Node | Source")
    UE_DEPRECATED(5.6, "Please, use UInterchangeSkeletalAnimationTrackNode::GetCustomAnimationStartTime")
    INTERCHANGECORE_API bool GetCustomAnimatedTimeStart(double& AttributeValue) const;
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Node | Source")
    UE_DEPRECATED(5.6, "Please, use UInterchangeSkeletalAnimationTrackNode::SetCustomAnimationStartTime")
    INTERCHANGECORE_API bool SetCustomAnimatedTimeStart(const double& AttributeValue);
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Node | Source")
    UE_DEPRECATED(5.6, "Please, use UInterchangeSkeletalAnimationTrackNode::GetCustomAnimationStopTime")
    INTERCHANGECORE_API bool GetCustomAnimatedTimeEnd(double& AttributeValue) const;
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Node | Source")
    UE_DEPRECATED(5.6, "Please, use UInterchangeSkeletalAnimationTrackNode::SetCustomAnimationStopTime")
    INTERCHANGECORE_API bool SetCustomAnimatedTimeEnd(const double& AttributeValue);
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Node | Source")
    INTERCHANGECORE_API bool GetCustomImportUnusedMaterial(bool& AttributeValue) const;
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Node | Source")
    INTERCHANGECORE_API bool SetCustomImportUnusedMaterial(const bool& AttributeValue);
 
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Node | Source")
    INTERCHANGECORE_API bool SetExtraInformation(const FString& Name, const FString& Value);
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Node | Source")
    INTERCHANGECORE_API bool RemoveExtraInformation(const FString& Name);
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Node | Source")
    INTERCHANGECORE_API void GetExtraInformation(TMap<FString, FString>& OutExtraInformation) const;
 
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Node | Source")
    INTERCHANGECORE_API bool GetCustomAxisConversionInverseTransform(FTransform& AxisConversionInverseTransform) const;
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Node | Source")
    INTERCHANGECORE_API bool SetCustomAxisConversionInverseTransform(const FTransform& AxisConversionInverseTransform);
 
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Node | Source")
    INTERCHANGECORE_API bool GetCustomUseLegacySkeletalMeshBakeTransform(bool& AttributeValue) const;
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Node | Source")
    INTERCHANGECORE_API bool SetCustomUseLegacySkeletalMeshBakeTransform(const bool& AttributeValue);
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Node | Source")
    INTERCHANGECORE_API bool GetCustomSubPathPrefix(FString& Prefix) const;
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Node | Source")
    INTERCHANGECORE_API bool SetCustomSubPathPrefix(const FString& Prefix);
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Node | Source")
    INTERCHANGECORE_API bool GetCustomUseAssetTypeSubPathSuffix(bool& Suffix) const;
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Node | Source")
    INTERCHANGECORE_API bool SetCustomUseAssetTypeSubPathSuffix(const bool& Suffix);
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Node | Source")
    INTERCHANGECORE_API bool GetCustomReimportStrategyFlags(uint8& StrategyFlag) const;
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Node | Source")
    INTERCHANGECORE_API bool SetCustomReimportStrategyFlags(uint8 StrategyFlag);
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Node | Source")
    INTERCHANGECORE_API bool GetCustomSkeletalMeshFrontAxis(uint8& AttributeValue) const;
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Node | Source")
    INTERCHANGECORE_API bool SetCustomSkeletalMeshFrontAxis(uint8 AttributeValue);
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Node | Source")
    INTERCHANGECORE_API bool GetCustomNaniteTriangleThreshold(int64& MinNumTriangles) const;
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Node | Source")
    INTERCHANGECORE_API bool SetCustomNaniteTriangleThreshold(const int64& MinNumTriangles);
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Node | Source")
    INTERCHANGECORE_API bool GetCustomAllowSceneRootAsJoint(bool& bAllowSceneRootAsJoint) const;
 
    UFUNCTION(BlueprintCallable, Category = "Interchange | Node | Source")
    INTERCHANGECORE_API bool SetCustomAllowSceneRootAsJoint(const bool& bAllowSceneRootAsJoint);
 
private:
    IMPLEMENT_NODE_ATTRIBUTE_KEY(SourceFrameRateNumerator);
    IMPLEMENT_NODE_ATTRIBUTE_KEY(SourceFrameRateDenominator);
    IMPLEMENT_NODE_ATTRIBUTE_KEY(SourceTimelineStart);
    IMPLEMENT_NODE_ATTRIBUTE_KEY(SourceTimelineEnd);
    IMPLEMENT_NODE_ATTRIBUTE_KEY(AnimatedTimeStart);
    IMPLEMENT_NODE_ATTRIBUTE_KEY(AnimatedTimeEnd);
    IMPLEMENT_NODE_ATTRIBUTE_KEY(ImportUnusedMaterial);
    IMPLEMENT_NODE_ATTRIBUTE_KEY(AxisConversionInverseTransform);
    IMPLEMENT_NODE_ATTRIBUTE_KEY(UseLegacySkeletalMeshBakeTransform);
    IMPLEMENT_NODE_ATTRIBUTE_KEY(SubPathPrefix);
    IMPLEMENT_NODE_ATTRIBUTE_KEY(UseAssetTypeSubPathSuffix);
    IMPLEMENT_NODE_ATTRIBUTE_KEY(ReimportStrategyFlags);
    IMPLEMENT_NODE_ATTRIBUTE_KEY(SkeletalMeshFrontAxis);
    IMPLEMENT_NODE_ATTRIBUTE_KEY(NaniteTriangleThreshold);
    IMPLEMENT_NODE_ATTRIBUTE_KEY(AllowSceneRootAsJoint);
 
    // Extra InformationTo show in the Config Panel.
    UE::Interchange::TMapAttributeHelper<FString, FString> ExtraInformation;
};