1. Epic GamesDeveloper
  3. UInterchangeUserDefinedAttributesAPI

UInterchangeUserDefinedAttributesAPI

[UInterchangeUserDefinedAttributesAPI](API\Runtime\InterchangeCore\UInterchangeUserDefinedAttribute-) is used to store and retrieve user-defined attributes such as DCC node attributes, so that pipelines have access to those attributes.

API > API/Runtime > API/Runtime/InterchangeCore

UInterchangeUserDefinedAttributesAPI is used to store and retrieve user-defined attributes such as DCC node attributes, so that pipelines have access to those attributes. Every user-defined attribute has a name, a value, and an optional AnimationPayloadKey: an FRichCurve that is a float curve. The value type must be supported by the UE::Interchange::EAttributeTypes enumeration.

   
Name UInterchangeUserDefinedAttributesAPI
Type class
Header File /Engine/Source/Runtime/Interchange/Core/Public/Nodes/InterchangeUserDefinedAttribute.h
Include Path #include "Nodes/InterchangeUserDefinedAttribute.h"

Syntax

UCLASS (BlueprintType, MinimalAPI)  
class UInterchangeUserDefinedAttributesAPI : public UObject

Inheritance Hierarchy

Constants

Name Type Remarks Include Path
UserDefinedAttributeBaseKey const FString   Nodes/InterchangeUserDefinedAttribute.h
UserDefinedAttributeDelegateKey const FString   Nodes/InterchangeUserDefinedAttribute.h
UserDefinedAttributePayLoadPostKey const FString   Nodes/InterchangeUserDefinedAttribute.h
UserDefinedAttributeValuePostKey const FString   Nodes/InterchangeUserDefinedAttribute.h

Functions

Static

Name Remarks Include Path Unreal Specifiers

static void AddApplyAndFillDelegatesToFactory ( UInterchangeFactoryBaseNode* InterchangeFactoryNode,
UClass* ParentClass
)

   Nodes/InterchangeUserDefinedAttribute.h  

static bool CreateUserDefinedAttribute ( UInterchangeBaseNode* InterchangeNode,
const FString& UserDefinedAttributeName,
const ValueType& Value,
const TOptional< FString >& PayloadKey,
bool RequiresDelegate
)

 Create a user-defined attribute with a value and a optional payload key. Nodes/InterchangeUserDefinedAttribute.h  

static bool CreateUserDefinedAttribute_Boolean ( UInterchangeBaseNode* InterchangeNode,
const FString& UserDefinedAttributeName,
const bool& Value,
const FString& PayloadKey,
bool RequiresDelegate
)

   Nodes/InterchangeUserDefinedAttribute.h
  • BlueprintCallable
  • Category="Interchange | Node | UserDefinedAttribute"

static bool CreateUserDefinedAttribute_Double ( UInterchangeBaseNode* InterchangeNode,
const FString& UserDefinedAttributeName,
const double& Value,
const FString& PayloadKey,
bool RequiresDelegate
)

   Nodes/InterchangeUserDefinedAttribute.h
  • BlueprintCallable
  • Category="Interchange | Node | UserDefinedAttribute"

static bool CreateUserDefinedAttribute_Float ( UInterchangeBaseNode* InterchangeNode,
const FString& UserDefinedAttributeName,
const float& Value,
const FString& PayloadKey,
bool RequiresDelegate
)

   Nodes/InterchangeUserDefinedAttribute.h
  • BlueprintCallable
  • Category="Interchange | Node | UserDefinedAttribute"

static bool CreateUserDefinedAttribute_FString ( UInterchangeBaseNode* InterchangeNode,
const FString& UserDefinedAttributeName,
const FString& Value,
const FString& PayloadKey,
bool RequiresDelegate
)

   Nodes/InterchangeUserDefinedAttribute.h
  • BlueprintCallable
  • Category="Interchange | Node | UserDefinedAttribute"

static bool CreateUserDefinedAttribute_Int32 ( UInterchangeBaseNode* InterchangeNode,
const FString& UserDefinedAttributeName,
const int32& Value,
const FString& PayloadKey,
bool RequiresDelegate
)

   Nodes/InterchangeUserDefinedAttribute.h
  • BlueprintCallable
  • Category="Interchange | Node | UserDefinedAttribute"

static void DuplicateAllUserDefinedAttribute ( const UInterchangeBaseNode* InterchangeSourceNode,
UInterchangeBaseNode* InterchangeDestinationNode,
bool bAddSourceNodeName
)

   Nodes/InterchangeUserDefinedAttribute.h
  • BlueprintCallable
  • Category="Interchange | Node | UserDefinedAttribute"

static bool GetUserDefinedAttribute ( const UInterchangeBaseNode* InterchangeNode,
const FString& UserDefinedAttributeName,
ValueType& OutValue,
TOptional< FString >& OutPayloadKey
)

 Get the value of a user-defined attribute and an optional payload key. Nodes/InterchangeUserDefinedAttribute.h  

static bool GetUserDefinedAttribute_Boolean ( const UInterchangeBaseNode* InterchangeNode,
const FString& UserDefinedAttributeName,
bool& OutValue,
FString& OutPayloadKey
)

   Nodes/InterchangeUserDefinedAttribute.h
  • BlueprintCallable
  • Category="Interchange | Node | UserDefinedAttribute"

static bool GetUserDefinedAttribute_Double ( const UInterchangeBaseNode* InterchangeNode,
const FString& UserDefinedAttributeName,
double& OutValue,
FString& OutPayloadKey
)

   Nodes/InterchangeUserDefinedAttribute.h
  • BlueprintCallable
  • Category="Interchange | Node | UserDefinedAttribute"

static bool GetUserDefinedAttribute_Float ( const UInterchangeBaseNode* InterchangeNode,
const FString& UserDefinedAttributeName,
float& OutValue,
FString& OutPayloadKey
)

   Nodes/InterchangeUserDefinedAttribute.h
  • BlueprintCallable
  • Category="Interchange | Node | UserDefinedAttribute"

static bool GetUserDefinedAttribute_FString ( const UInterchangeBaseNode* InterchangeNode,
const FString& UserDefinedAttributeName,
FString& OutValue,
FString& OutPayloadKey
)

   Nodes/InterchangeUserDefinedAttribute.h
  • BlueprintCallable
  • Category="Interchange | Node | UserDefinedAttribute"

static bool GetUserDefinedAttribute_Int32 ( const UInterchangeBaseNode* InterchangeNode,
const FString& UserDefinedAttributeName,
int32& OutValue,
FString& OutPayloadKey
)

   Nodes/InterchangeUserDefinedAttribute.h
  • BlueprintCallable
  • Category="Interchange | Node | UserDefinedAttribute"
  Nodes/InterchangeUserDefinedAttribute.h  

static void GetUserDefinedAttributeInfos ( const UInterchangeBaseNode* InterchangeNode,
TArray< FInterchangeUserDefinedAttributeInfo >& UserDefinedAttributeInfos
)

   Nodes/InterchangeUserDefinedAttribute.h
  • BlueprintCallable
  • Category="Interchange | Node | UserDefinedAttribute"

static bool HasAttribute ( const UInterchangeBaseNode* InterchangeSourceNode,
const FString& InUserDefinedAttributeName,
bool GeneratePayloadKey,
bool& OutRequiresDelegate
)

   Nodes/InterchangeUserDefinedAttribute.h  

static UE::Interchange::FAttributeKey MakeUserDefinedPropertyKey ( const FStringView UserDefinedAttributeName,
bool RequiresDelegate,
bool GeneratePayloadKey
)

   Nodes/InterchangeUserDefinedAttribute.h  

static UE::Interchange::FAttributeKey MakeUserDefinedPropertyKey ( const FString& UserDefinedAttributeName,
bool RequiresDelegate,
bool GeneratePayloadKey
)

   Nodes/InterchangeUserDefinedAttribute.h  

static UE::Interchange::FAttributeKey MakeUserDefinedPropertyPayloadKey ( const FStringView UserDefinedAttributeName,
bool RequiresDelegate
)

   Nodes/InterchangeUserDefinedAttribute.h  

static UE::Interchange::FAttributeKey MakeUserDefinedPropertyPayloadKey ( const FString& UserDefinedAttributeName,
bool RequiresDelegate
)

   Nodes/InterchangeUserDefinedAttribute.h  

static UE::Interchange::FAttributeKey MakeUserDefinedPropertyValueKey ( const FStringView UserDefinedAttributeName,
bool RequiresDelegate
)

   Nodes/InterchangeUserDefinedAttribute.h  

static UE::Interchange::FAttributeKey MakeUserDefinedPropertyValueKey ( const FString& UserDefinedAttributeName,
bool RequiresDelegate
)

   Nodes/InterchangeUserDefinedAttribute.h  

static bool RemoveUserDefinedAttribute ( UInterchangeBaseNode* InterchangeNode,
const FString& UserDefinedAttributeName
)

 Remove the specified user-defined attribute. Nodes/InterchangeUserDefinedAttribute.h
  • BlueprintCallable
  • Category="Interchange | Node | UserDefinedAttribute"

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page