1. Epic GamesDeveloper
  3. UInterchangeUserDefinedAttributesAPI

UInterchangeUserDefinedAttributesAPI

[UInterchangeUserDefinedAttributesAPI](API\Runtime\InterchangeCore\Nodes\UInterchangeUserDefinedAttribute-) is used to store and retrieve user defined attributes (i.e. DCC node attributes, pipelines will have access to those attributes) Any user defined attribute have: name, value and a optional AnimationPayloadKey ([FRichCurve](API\Runtime\Engine\Curves\FRichCurve) which is a float curve).

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

class UInterchangeUserDefinedAttributesAPI : public UObject

Remarks

UInterchangeUserDefinedAttributesAPI is used to store and retrieve user defined attributes (i.e. DCC node attributes, pipelines will have access to those attributes) Any user defined attribute have: name, value and a optional AnimationPayloadKey (FRichCurve which is a float curve). Value type must be supported by the UE::Interchange::EAttributeTypes enumeration.

Functions

  Type Name Description
Public function Static bool

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

 Create user defined attribute with a value and a optional payload key param UserDefinedAttributeName - The name of the user defined attribute param Value - The value of the user defined attribute param PayloadKey - The translator payload key to retrieve the FRichCurve animation for this user defined attribute note - User defined attributes are the DCC translated node user custom attributes (i.e. Maya extra attributes) Payload key will point on a FRichCurve payload.
Public function Static bool

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

  
Public function Static bool

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

  
Public function Static bool

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

  
Public function Static bool

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

  
Public function Static bool

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

  
Public function Static 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 user defined attribute value and optional payload key param UserDefinedAttributeName - The name of the user defined attribute param OutValue - The value of the user defined attribute param OutPayloadKey - The translator payload key to retrieve the FRichCurve animation for this user defined attribute note - User defined attributes are the DCC translated node user custom attributes (i.e. Maya extra attributes) Payload key will point on a FRichCurve payload.
Public function Static bool

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

  
Public function Static bool

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

  
Public function Static bool

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

  
Public function Static bool

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

  
Public function Static bool

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

  
Public function Static TArray< FInterchangeUserDefinedAttributeInfo >  
Public function Static void

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

  
Public function Static bool

RemoveUserDefinedAttribute ( UInterchangeBaseNode* InterchangeNode,
const FString& UserDefinedAttributeName
)

 Remove the specified user defined attribute param UserDefinedAttributeName - The name of the user defined attribute to remove return - True if the attribute exist and was remove or if the attribute doesn't exist.

Constants

Name Description
UserDefinedAttributeBaseKey  
UserDefinedAttributePayLoadPostKey  
UserDefinedAttributeValuePostKey  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page