1. Epic GamesDeveloper
  3. UInterchangeUserDefinedAttributesAPI

UInterchangeUserDefinedAttributesAPI

[UInterchangeUserDefinedAttributesAPI](API\Runtime\InterchangeCore\Nodes\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 > API/Runtime/InterchangeCore/Nodes

Inheritance Hierarchy

References

   
Module InterchangeCore
Header /Engine/Source/Runtime/Interchange/Core/Public/Nodes/InterchangeUserDefinedAttribute.h
Include #include "Nodes/InterchangeUserDefinedAttribute.h"

Syntax

UCLASS (BlueprintType, MinimalAPI)  
class UInterchangeUserDefinedAttributesAPI : public UObject

Remarks

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.

Functions

  Type Name Description
Public function Static void

AddApplyAndFillDelegatesToFactory ( UInterchangeFactoryBaseNode* InterchangeFactoryNode,
UClass* ParentClass
)

  
Public function 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.
Public function Static UFunction BlueprintCallable, Category bool

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

  
Public function Static UFunction BlueprintCallable, Category bool

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

  
Public function Static UFunction BlueprintCallable, Category bool

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

  
Public function Static UFunction BlueprintCallable, Category bool

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

  
Public function Static UFunction BlueprintCallable, Category bool

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

  
Public function Static UFunction BlueprintCallable, Category void

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

  
Public function 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.
Public function Static UFunction BlueprintCallable, Category bool

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

  
Public function Static UFunction BlueprintCallable, Category bool

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

  
Public function Static UFunction BlueprintCallable, Category bool

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

  
Public function Static UFunction BlueprintCallable, Category bool

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

  
Public function Static UFunction BlueprintCallable, Category bool

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

  
Public function Static TArray< FInterchangeUserDefinedAttributeInfo >  
Public function Static UFunction BlueprintCallable, Category void

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

  
Public function Static UE::Interchange::FAttributeKey

MakeUserDefinedPropertyPayloadKey ( const FStringView UserDefinedAttributeName,
bool RequiresDelegate
)

  
Public function Static UE::Interchange::FAttributeKey

MakeUserDefinedPropertyPayloadKey ( const FString& UserDefinedAttributeName,
bool RequiresDelegate
)

  
Public function Static UE::Interchange::FAttributeKey

MakeUserDefinedPropertyValueKey ( const FStringView UserDefinedAttributeName,
bool RequiresDelegate
)

  
Public function Static UE::Interchange::FAttributeKey

MakeUserDefinedPropertyValueKey ( const FString& UserDefinedAttributeName,
bool RequiresDelegate
)

  
Public function Static UFunction BlueprintCallable, Category bool

RemoveUserDefinedAttribute ( UInterchangeBaseNode* InterchangeNode,
const FString& UserDefinedAttributeName
)

 Remove the specified user-defined attribute.

Constants

Name Description
UserDefinedAttributeBaseKey  
UserDefinedAttributeDelegateKey  
UserDefinedAttributePayLoadPostKey  
UserDefinedAttributeValuePostKey  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page